/nextdoor/businesses

POST /api/nextdoor/businesses

Price: 1 credit

Get Nextdoor business

How to use it

Get a Nextdoor business or agency page by country and slug. Returns name, categories, phone, email, website, address, business hours, opening status, photo gallery, neighborhood favorites won, recommendation summary, and favorite count.

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")
• slug string required — Business page slug or /pages/ URL (examples: "trabocco-alameda-ca"; minLength: 1)

Response

• @type string (default: "NextdoorBusiness")
• id string nullable
• alias string nullable
• name string nullable
• description string nullable
• phone string nullable
• email string nullable
• website_url string nullable
• url string nullable
• license_id string nullable
• location_status string nullable
• fave_count integer nullable
• recommendation_summary string nullable
• is_takeout_offered boolean nullable
• is_delivery_offered boolean nullable
• image string nullable
• cover string nullable
• categories array (default: [])
• centroid object nullable
  • @type string (default: "NextdoorGeoPoint")
  • lat number nullable
  • lon number nullable
• address object nullable
  • @type string (default: "NextdoorAddress")
  • street_number string nullable
  • route string nullable
  • unit_number string nullable
  • city string nullable
  • state string nullable
  • state_name string nullable
  • postal_code string nullable
  • country string nullable
  • formatted string nullable
• open_status string nullable
• hours array (default: [])
  • @type string (default: "NextdoorBusinessHours")
  • day string nullable
  • intervals array (default: [])
• gallery array (default: [])
• gallery_count integer nullable
• years_won array (default: [])
• neighborhoods_won array (default: [])
  • @type string (default: "NextdoorNeighborhoodWon")
  • name string nullable
  • city string nullable
  • url string nullable
• delivery_services array (default: [])

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 — Business not found. Verify country and 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.