Get list of Neighbourhoods

Owned by nolan.a
Last updated: Aug 26, 2024
1 min read

Overview

The Neighbourhoods Details List API allows you to retrieve detailed information for a list of Neighbourhoods. You can also specify a resolution to downsample the data for improved performance.

Base URL

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

Endpoint

Get Neighbourhoods Details by List

Endpoint

POST /neighbourhood/list

Request Body

  • neighbourhoods (array): An array of Neighbourhoods for which details will be retrieved. Example:

    { "names": [ { "name": "Northeast" } ] }

Response

  • 200 OK: Returns a JSON response containing detailed information for the specified list of Neighbourhoods.

  • 400 Bad Request: If there is an issue with the request, such as providing too many Neighbourhoods.

  • 404 Not Found: If no details are found for the given zip codes.

Usage

To use the Neighbourhoods Details List API, perform a POST request to the specified endpoint with the list of Neighbourhoods provided in the request body. Optionally, include the resolution parameter to downsample the data. The API will respond with detailed information for the specified list of Neighbourhoods.