Overview
This API allows developers to get details of a neighborhood from a given point inside the neighborhood.
Base URL
The base URL for the API is https://api.realtyfeed.com.
Endpoint
Find Neighborhood by a point
Endpoint
POST /geo/neighbourhood/point
Request Body
geo point(object).Example:
{ "lat": 30.070282506357326, "lon": -94.08655385441871 }
Response
200 OK: Returns a JSON response containing information about the Neighbourhood.
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], ... ] ] } }, ... ]404 Not Found: If no Neighbourhoods are found.
Example
Request:
POST /geo/neighbourhood/point
{
"lat": 30.070282506357326,
"lon": -94.08655385441871
}
Response:
[
{
"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],
...
]
]
}
},
...
]
Error Handling
404 Not Found: If no Neighbourhoods are found..