GET/v1/neighborhood/compare
Two to four locations side by side, with the winner of each category.
[ OPTIONS ]
| Name | Type | Required | Description |
|---|---|---|---|
locations[] | string[] | Yes | 2–4 zips or addresses to compare. |
[ EXAMPLE REQUEST ]
curl "https://atlasblock.dev/api/v1/neighborhood/compare?locations[]=28203&locations[]=10001"[ 200 OK ]
{
"status": "success",
"data": {
"locations": [
{
"zip": "28203",
"city": "Charlotte",
"ratings": {
"overall": 7.4,
"walkability": 8.3
}
},
{
"zip": "10001",
"city": "New York",
"ratings": {
"overall": 8.1,
"walkability": 9.8
}
}
],
"winner_by_category": {
"walkability": "10001",
"affordability": "28203"
},
"ai_comparison": "Chelsea edges out Dilworth on walkability ...",
"metadata": {
"processing_time_ms": 61
}
}
}[ TRY IT ]Open playground →
GET/v1/neighborhood/compare?locations%5B%5D=10001
[ QUERY ]
[ CURL ]
curl "https://atlasblock.dev/api/v1/neighborhood/compare?locations%5B%5D=10001" \ -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.