Neighbourhoods inside a BoundingBox

Overview

The Neighbourhoods Inside Bounding Box API retrieves information about Neighbourhoods that fall within a specified geographical bounding box. This API allows developers to obtain details about multiple Neighbourhoods within a given region.

Base URL

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

Endpoint

Neighbourhoods Inside the Bounding Box

Endpoint

POST /geo/neighbourhood/boundingbox

Request Body

bounding_box (object): The bounding box that defines the geographical area. It should include the top_left and bottom_right coordinates.
Example:
{ "top_left": { "lat": 31.352773, "lon": -94.708821 }, "bottom_right": { "lat": 30, "lon": -93 } }

Response

200 OK: Returns a JSON response containing information about Neighbourhoods within the specified bounding box.
Example:
[ { "type": "Feature", "properties" : { "State" : "AK", "County" : "Anchorage", "City" : "Anchorage", "Name" : "Northeast", "RegionID" : "267847", "Shape_Length" : 0.22560480535327349, "Shape_Area" : 0.0021261330917689125 }, "geometry": { "type": "Polygon", "coordinates": [ [ [-98.99156, 39.73729], [-98.991524, 39.741921], ... ] ] } }, ... ]
400 Bad Request: If an invalid bounding box is provided.
404 Not Found: If no Neighbourhoods are found within the specified bounding box.

Example

Request:

POST /geo/neighbourhood/boundingbox
{
  "top_left": {
    "lat": 40,
    "lon": -100
  },
  "bottom_right": {
    "lat": 37,
    "lon": -98
  }
}

Response:

Usage

To use the Neighbourhoods Inside Bounding Box API, perform a POST request to the specified endpoint with the bounding box coordinates provided in the request body. The API will respond with information about Neighbourhoods within the specified bounding box.

Error Handling

400 Bad Request: If an invalid bounding box is provided, the API will respond with a 400 status code and an error message in the response body.
404 Not Found: If no Neighbourhoods are found within the specified bounding box, the API will respond with a 404 status code and an error message in the response body.