Nearby Zip codes API

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

Overview

The Nearby Zipcodes API provides a simple way to retrieve a list of nearby zip codes for a given target zip code. This is useful for scenarios where you must find locations near a specified area.

Base URL

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

Endpoint

Get Nearby Zipcodes

Endpoint

GET /geo/zipcode/nearby/{zipcode}

Path Parameters

zipcode (string): The target zip code for which nearby zip codes will be retrieved.

Response

200 OK: Returns a JSON response containing a list of nearby zip codes.

Example:

["12346", "12347", "12348", ...]

404 Not Found: If no nearby zipcodes are found for the given input.

Example

Request:

GET /geo/zipcode/nearby/12345

Response:

["12346", "12347", "12348", ...]

Usage

To use the Nearby Zipcodes API, perform a GET request to the specified endpoint with the target zip code as a path parameter. The API will respond with a list of nearby zip codes if available.

Error Handling

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