Skip to main content
POST
/nextdoor/neighborhoods/rankings

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
state
string
required
Minimum string length: 1
city
string
required
Minimum string length: 1
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
country
enum<string>
default:US
Available options:
US,
GB,
DE,
FR,
IT,
ES,
AU,
DK,
SE,
CA,
NL
category
enum<string>
default:best_places_to_live
Available options:
best_places_to_live,
cheapest_places_to_live,
friendliest_places_to_live,
safest_places_to_live,
cheapest_and_safest_places_to_live
income_bands
enum<string>[]
Available options:
up_to_20k,
from_20k_to_50k,
from_50k_to_100k,
over_100k

Response

Successful Response

@type
string
default:NextdoorRankedNeighborhood
id
string | null
name
string | null
rank
integer | null
affordability_score
number | null
friendliness_score
number | null
attributes
string[]
image
string | null
url
string | null