GET/v1/neighborhood/search
Find zips by rating criteria: filter and sort across the precomputed ratings.
[ OPTIONS ]
| Name | Type | Required | Description |
|---|---|---|---|
state | string | No | Scope to a state (USPS code). |
county_fips | string | No | Scope to a county. |
region | string | No | Scope to a Census region (northeast/midwest/south/west). |
{metric}_min / {metric}_max | number | No | Rating bounds 0–10 for any metric (e.g. safety_min=7, affordability_max=5). |
income_min / income_max / rent_min / rent_max | integer | No | Median household income / gross rent bounds. |
sort | string | No | Metric to sort by (default overall). |
order | string | No | asc or desc (default desc). |
page | integer | No | Page number (default 1). |
per_page | integer | No | Results per page (default 25, max 100). |
[ EXAMPLE REQUEST ]
curl "https://atlasblock.dev/api/v1/neighborhood/search?state=NC&safety_min=7&sort=affordability&order=desc"[ 200 OK ]
{
"status": "success",
"data": {
"filters": {
"state": "NC",
"safety_min": 7
},
"sort": {
"metric": "affordability",
"order": "desc"
},
"results": [
{
"zip": "28203",
"city": "Charlotte",
"state": "NC",
"county_fips": "37119",
"ratings": {
"overall": 7.4,
"safety": 7.1,
"affordability": 5.9
},
"median_household_income": 86500,
"median_gross_rent": 1650
}
],
"pagination": {
"page": 1,
"per_page": 25,
"total": 1,
"total_pages": 1
}
}
}[ TRY IT ]Open playground →
GET/v1/neighborhood/search?state=NC&sort=affordability&order=desc
[ QUERY ]
[ CURL ]
curl "https://atlasblock.dev/api/v1/neighborhood/search?state=NC&sort=affordability&order=desc" \ -H "Authorization: Bearer $ATLASBLOCK_API_KEY"
[ EVERY REQUEST ]
Send an Authorization: Bearer key against the base URL https://atlasblock.dev/api. Every call counts toward your plan quota. See the overview for authentication, rate limits, and status codes.