GET/v1/neighborhood/batch
Up to 25 zips in one request, ratings only. Built for scoring many listings.
[ OPTIONS ]
| Name | Type | Required | Description |
|---|---|---|---|
zips[] | string[] | Yes | Up to 25 zip codes. |
fields[] | string[] | No | Restrict the ratings returned (e.g. walkability, safety). |
[ EXAMPLE REQUEST ]
curl "https://atlasblock.dev/api/v1/neighborhood/batch?zips[]=28203&zips[]=10001&fields[]=walkability&fields[]=safety"[ 200 OK ]
{
"status": "success",
"data": {
"results": [
{
"zip": "28203",
"city": "Charlotte",
"ratings": {
"walkability": 8.3,
"safety": 6.1
}
},
{
"zip": "10001",
"city": "New York",
"ratings": {
"walkability": 9.8,
"safety": 5.4
}
}
],
"count": 2,
"metadata": {
"cache_hits": 1,
"processing_time_ms": 143
}
}
}[ TRY IT ]Open playground →
GET/v1/neighborhood/batch?zips%5B%5D=10001&fields%5B%5D=safety
[ QUERY ]
[ CURL ]
curl "https://atlasblock.dev/api/v1/neighborhood/batch?zips%5B%5D=10001&fields%5B%5D=safety" \ -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.