GET/v1/neighborhood/rankings
Top zips by a single metric, optionally scoped to a state, county, or region.
[ OPTIONS ]
| Name | Type | Required | Description |
|---|---|---|---|
metric | string | No | The rating to rank by (default overall). |
state / county_fips / region | string | No | Optional geographic scope. |
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/rankings?metric=walkability&state=NC"[ 200 OK ]
{
"status": "success",
"data": {
"metric": "walkability",
"order": "desc",
"scope": {
"state": "NC"
},
"results": [
{
"zip": "28203",
"city": "Charlotte",
"ratings": {
"overall": 7.4,
"walkability": 8.3
}
}
],
"pagination": {
"page": 1,
"per_page": 25,
"total": 3,
"total_pages": 1
}
}
}[ TRY IT ]Open playground →
GET/v1/neighborhood/rankings?metric=walkability
[ QUERY ]
[ CURL ]
curl "https://atlasblock.dev/api/v1/neighborhood/rankings?metric=walkability" \ -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.