Atlasblock API

GET/v1/neighborhood/{zip}/similar

Neighborhoods with the most similar rating profile to a given zip.

[ OPTIONS ]
NameTypeRequiredDescription
zipstring (path)YesThe zip to find look-alikes for.
nationalbooleanNoSearch nationwide instead of within the same state.
limitintegerNoHow many matches (default 10, max 50).
[ EXAMPLE REQUEST ]
curl "https://atlasblock.dev/api/v1/neighborhood/28203/similar"
[ 200 OK ]
{
  "status": "success",
  "data": {
    "zip": "28203",
    "national": false,
    "target": {
      "zip": "28203",
      "ratings": {
        "overall": 7.4
      }
    },
    "count": 5,
    "results": [
      {
        "zip": "28205",
        "city": "Charlotte",
        "ratings": {
          "overall": 7.1
        },
        "similarity_distance": 0.42
      }
    ]
  }
}
GET/v1/neighborhood/28203/similar
[ PATH ]
[ QUERY ]
[ CURL ]
curl "https://atlasblock.dev/api/v1/neighborhood/28203/similar" \
  -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.