Zip code Auto Suggestion API

Owned by nolan.a (Unlicensed)
Feb 22, 2024
1 min read

Overview

The Zipcode Auto Suggestion API offers auto-suggestions for completed zip codes based on the first digits of a given partial zip code. This is useful for providing users with quick and accurate suggestions while entering zip code information.

Base URL

The base URL for the API is https://api.realtyfeed.com.

Endpoint

Zipcode Auto Suggestion

Endpoint

GET /geo/zipcode/autosuggestion

Query Parameters

  • zipcode (string, optional): The partial or complete zipcode for which auto-suggestions will be provided. Defaults to "00001" if not provided.

Response

200 OK: Returns a JSON response containing a list of auto-suggested completed zip codes.

Example:

["12345", "12346", "12347", ...]

404 Not Found: If no auto-suggestions are found for the given input.

Example

Request:

GET /geo/zipcode/autosuggestion?zipcode=123

Response:

["12345", "12346", "12347", ...]

Usage

To use the Zipcode Auto Suggestion API, perform a GET request to the specified endpoint with the optional zip code query parameter. The API will respond with a list of auto-suggested completed zip codes based on the provided input.

Error Handling

404 Not Found: If no auto-suggestions are found for the given input, the API will respond with a 404 status code and an error message in the response body.