Neighbourhoods Auto Suggestion

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

Overview

The Neighbourhood Auto Suggestion API offers auto-suggestions for completed neighbourhoods based on the first digits of a given partial neighbourhood name. This is useful for providing users with quick and accurate suggestions while entering neighbourhood information.

Base URL

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

Endpoint

Neighbourhood Auto Suggestion

Endpoint

GET /geo/neighbourhood/autosuggestion

Query Parameters

  • neighbourhood (string, optional): The partial or complete neighborhood for which auto-suggestions will be provided. Defaults to "Northeast" if not provided.

Response

200 OK: Returns a JSON response containing a list of auto-suggested completed neighbourhoods.

Example:

["Northeast", ...]

404 Not Found: If no auto-suggestions are found for the given input.

Example

Request:

GET /geo/neighbourhood/autosuggestion?neighbourhood=Northeast

Response:

["Northeast", ...]

Usage

To use the Neighbourhood Auto Suggestion API, perform a GET request to the specified endpoint with the optional neighbourhood query parameter. The API will respond with a list of auto-suggested completed neighbourhoods based on the provided input.

Error Handling

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