/nextdoor/neighborhoods

POST /api/nextdoor/neighborhoods

Price: 5 credits

Get Nextdoor neighborhood

How to use it

Get a Nextdoor neighborhood profile by country, state, city, and neighborhood slug. Returns local stats (residents, walk/transit scores, median home value, friendliness/affordability), attributes, FAQs, nearby neighborhoods, agencies, neighborhood favorites, and preview lists of classifieds, events, groups, and neighbor posts with their total counts.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• country string — Nextdoor country/region (default: "US"; one of: "US", "GB", "DE", "FR", "IT", "ES", "AU", "DK", "SE", "CA", "NL")
• state string required — State or region code (examples: "ca"; minLength: 1)
• city string required — City slug (examples: "berkeley"; minLength: 1)
• neighborhood string required — Neighborhood slug (examples: "neclaremonthills"; minLength: 1)

Response

• @type string (default: "NextdoorNeighborhood")
• id string nullable
• name string nullable
• alias string nullable
• short_name string nullable
• city string nullable
• state string nullable
• country string nullable
• full_state_name string nullable
• display_location string nullable
• document_title string nullable
• subtitle string nullable
• centroid object nullable
  • @type string (default: "NextdoorGeoPoint")
  • lat number nullable
  • lon number nullable
• hero_image string nullable
• map_bounds string nullable
• meta_title string nullable
• attributes array (default: [])
• interests array (default: [])
• stats object nullable
  • @type string (default: "NextdoorLocationStats")
  • residents_count integer nullable
  • median_home_value number nullable
  • average_income number nullable
  • average_age number nullable
  • percentage_homeowners number nullable
  • walk_score number nullable
  • transit_score number nullable
  • friendliness_score number nullable
  • affordability_score number nullable
  • family_score number nullable
  • safety_score number nullable
  • schools_score number nullable
  • diversity_score number nullable
  • ranking_year integer nullable
  • tagline string nullable
  • description string nullable
• faq array (default: [])
  • @type string (default: "NextdoorFAQ")
  • question string nullable
  • answer string nullable
• faves array (default: [])
  • @type string (default: "NextdoorFaveSection")
  • name string nullable
  • businesses array (default: [])
    • @type string (default: "NextdoorFaveBusiness")
    • name string nullable
    • image string nullable
    • fav_count integer nullable
    • recommendation string nullable
    • recommendation_author string nullable
    • url string nullable
• fave_count integer nullable
• agencies array (default: [])
  • @type string (default: "NextdoorAgency")
  • name string nullable
  • image string nullable
  • post_count integer nullable
  • alias string nullable
• nearby_neighborhoods array (default: [])
  • @type string (default: "NextdoorNearbyNeighborhood")
  • id string nullable
  • name string nullable
  • alias string nullable
  • city string nullable
  • state string nullable
  • centroid object nullable
    • @type string (default: "NextdoorGeoPoint")
    • lat number nullable
    • lon number nullable
• classifieds array (default: [])
  • @type string (default: "NextdoorClassified")
  • name string nullable
  • description string nullable
  • price number nullable
  • currency string nullable
  • is_free boolean nullable
  • is_sold boolean nullable
  • image string nullable
  • last_renewed string nullable
  • neighborhood string nullable
  • url string nullable
• classified_count integer nullable
• events array (default: [])
  • @type string (default: "NextdoorEvent")
  • name string nullable
  • description string nullable
  • event_date integer nullable
  • display_date string nullable
  • attendance_count integer nullable
  • image string nullable
  • url string nullable
• event_count integer nullable
• groups array (default: [])
  • @type string (default: "NextdoorGroup")
  • name string nullable
  • description string nullable
  • member_count integer nullable
  • image string nullable
  • url string nullable
• group_count integer nullable
• trending_posts array (default: [])
  • @type string (default: "NextdoorPost")
  • author_name string nullable
  • author_id string nullable
  • author_neighborhood string nullable
  • avatar string nullable
  • text string nullable
  • comment_count integer nullable
  • reaction_count integer nullable
  • post_type string nullable
  • image string nullable
  • video_url string nullable
  • created_at integer nullable
  • url string nullable
• safety_posts array (default: [])
  • @type string (default: "NextdoorPost")
  • author_name string nullable
  • author_id string nullable
  • author_neighborhood string nullable
  • avatar string nullable
  • text string nullable
  • comment_count integer nullable
  • reaction_count integer nullable
  • post_type string nullable
  • image string nullable
  • video_url string nullable
  • created_at integer nullable
  • url string nullable
• photo_video_posts array (default: [])
  • @type string (default: "NextdoorPost")
  • author_name string nullable
  • author_id string nullable
  • author_neighborhood string nullable
  • avatar string nullable
  • text string nullable
  • comment_count integer nullable
  • reaction_count integer nullable
  • post_type string nullable
  • image string nullable
  • video_url string nullable
  • created_at integer nullable
  • url string nullable
• photo_video_post_count integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Neighborhood not found. Verify country, state, city, and neighborhood slug. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.