Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

Version 1 Current »

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.

  • No labels