Quickstart: your first Neighbourly call.
Authentication, base URL, your first request and the rules of the road. The complete API reference — every endpoint, parameter and field — lives in your Neighbourly dashboard.
Get an API key
Choose a plan and you'll receive an Api-Key. Keep it server-side — treat it like a password.
Set the base URL
All endpoints live under https://api.neighbourly.io/api/v1/locations. Requests and responses are JSON.
Authenticate every request
Send your key in the Api-Key header on every call. Requests without it return 401 Unauthorized.
Make your first call
Resolve a postal code to live demographics, or a coordinate to its place in the hierarchy.
The complete API reference lives in your dashboard.
Every endpoint, parameter, response field and data-dictionary entry — plus your keys and usage — in the Neighbourly dashboard.
Postal code to live demographics.
Every request carries your key in the Api-Key header. This call returns census-derived demographics for the postal code's Forward Sortation Area.
- One Api-Key header authenticates every endpoint
- Query by coordinate, address or bounding box
- Consistent JSON — no runtime spatial joins
curl -H "Api-Key: $NEIGHBOURLY_KEY" \ "https://api.neighbourly.io/api/v1/locations/demographics/find?pc=M5V"
{
"population": 59912,
"median_age": 32,
"ownership_rate": 41.8,
"median_dwelling_value": 700000,
"median_rent": 2000
}Rate limits
The API is rate limited per IP. Default limits suit interactive use; higher throughput and burst allowances come with paid and enterprise plans. Exceeding the limit returns 429 — back off and retry.
Batch enrichment and higher rate limits are available on Professional and Enterprise. See pricing.
Status codes
200OKSuccess — a JSON body is returned.400Bad RequestA required parameter is missing (e.g. viewport).401UnauthorizedMissing or invalid Api-Key header.404Not FoundNo record matches the request.429Too Many RequestsRate limit exceeded — back off and retry.Explore the endpoints by layer
Ready to build?
Get an API key and make your first call today, or talk to our team about your use case.