GET/v1/zips/nearby
Zips within a radius of a point, sorted by distance.
[ OPTIONS ]
| Name | Type | Required | Description |
|---|---|---|---|
lat | number | Yes | Latitude of the center point. |
lng | number | Yes | Longitude of the center point. |
radius | number | No | Miles (default 10, max 100). |
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/zips/nearby?lat=35.21&lng=-80.85&radius=10"[ 200 OK ]
{
"status": "success",
"data": {
"center": {
"latitude": 35.21,
"longitude": -80.85,
"radius_miles": 10
},
"zips": [
{
"zip": "28203",
"city": "Charlotte",
"distance_miles": 0
}
],
"pagination": {
"page": 1,
"per_page": 25,
"total": 34,
"total_pages": 2
}
}
}[ TRY IT ]Open playground →
GET/v1/zips/nearby?lat=35.21&lng=-80.85&radius=10
[ QUERY ]
[ CURL ]
curl "https://atlasblock.dev/api/v1/zips/nearby?lat=35.21&lng=-80.85&radius=10" \ -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.