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 Page History

Version 1 Current »

Overview

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

Base URL

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

Endpoint

Get Neighbourhoods by State

Endpoint

GET /geo/neighbourhood/state/{state}

Path Parameters

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

    • "TX", "CA", "NY", "PA", "IL", "OH", "MO", "FL", "IA", "MI", "MN", "VA", "NC", "IN", "WI", "KY", "GA", "KS", "WV", "TN", "AL", "OK", "NE", "WA", "AR", "NJ", "CO", "MA", "LA", "MD", "OR", "ME", "MS", "SC", "AZ", "ND", "SD", "MT", "NM", "UT", "CT", "ID", "VT", "NH", "AK", "NV", "WY", "PR", "HI", "RI", "DE", "DC", "VI", "GU", "MP", "AS"

Response

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

    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 state.

Usage

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

  • No labels