City Neighbourhoods

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

Overview

The State Neighbourhoods API allows you to retrieve a list of Neighbourhoods within a specified city. This is useful for obtaining Neighbourhoods information for a particular city.

Base URL

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

Endpoint

Get Neighbourhoods by State

Endpoint

GET /geo/neighbourhood/city/{city}

Path Parameters

  • city (string): The city code for which Neighbourhoods will be retrieved. Supported cities include:

    • 'Nashville', 'San Antonio', 'Fort Wayne', 'Columbus', 'New York', 'Baltimore', … (look at the API response)

Response

  • 200 OK: Returns a JSON response containing a list of Neighbourhoods within the specified city.

    Example:

  • [ "Sharpstown", "Blackshear", "Shadow Hills", "Pelican Bay", "Alief", "Acorn", "Park Terrace", "Westside", "Arlington Heights", "South Hills" ]

404 Not Found: If no Neighbourhoods are found for the given city.

Usage

To use the city Neighbourhoods API, perform a GET request to the specified endpoint with the city code as a path parameter. The API will respond with a list of Neighbourhoods within the specified city.