POST/v1/neighborhood/recommend
Rank the best-fit zips for a set of per-dimension weights (your priorities).
[ OPTIONS ]
| Name | Type | Required | Description |
|---|---|---|---|
weights | object (body) | Yes | Metric => weight, e.g. {"safety":2,"affordability":1}. |
state / county_fips / region | string (body) | No | Optional geographic scope. |
limit | integer (body) | No | How many to return (default 25, max 100). |
[ EXAMPLE REQUEST ]
curl -X POST "https://atlasblock.dev/api/v1/neighborhood/recommend" \ -H "Content-Type: application/json" \ -d '{"weights":{"safety":2,"affordability":1},"state":"NC"}'
[ 200 OK ]
{
"status": "success",
"data": {
"weights": {
"safety": 2,
"affordability": 1
},
"scope": {
"state": "NC"
},
"candidate_pool": 108,
"count": 3,
"results": [
{
"zip": "28203",
"city": "Charlotte",
"ratings": {
"safety": 7.1,
"affordability": 5.9
},
"match_score": 6.7
}
]
}
}[ TRY IT ]Open playground →
POST/v1/neighborhood/recommend
[ BODY · JSON ]
weights· object (body) · required — Metric => weight, e.g. {"safety":2,"affordability":1}.state / county_fips / region· string (body) — Optional geographic scope.limit· integer (body) — How many to return (default 25, max 100).
[ CURL ]
curl -X POST "https://atlasblock.dev/api/v1/neighborhood/recommend" \ -H "Authorization: Bearer $ATLASBLOCK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"weights":{"safety":2,"affordability":1},"state":"NC"}'
[ 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.