{ "openapi": "3.0.1", "info": { "title": "Nextdoor Business Scraper | Neighborhood Leads", "description": "Scrape Nextdoor neighborhood businesses in the US, UK, and Canada. Export names, phones, emails, websites, license IDs, and street addresses from public /pages/ and /topics/ directories. Guest pages only — no login, cookies, or Message/Call. CSV, Excel, or JSON.", "version": "0.1", "x-build-id": "UDz9Mzcp3LBmEQieR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~nextdoor-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-nextdoor-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/lentic_clockss~nextdoor-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-nextdoor-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/lentic_clockss~nextdoor-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-nextdoor-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "searchType": { "title": "Search type", "enum": [ "city", "neighborhood", "pages", "find-neighborhood", "about", "topics", "business-search", "search", "feed", "login", "map", "contact" ], "type": "string", "description": "Opened: city, neighborhood, pages, find-neighborhood, about, topics. business-search aliases topics. search/feed/login/map/contact are out of scope.", "default": "city" }, "city": { "title": "City slug", "type": "string", "description": "Live SEO slug such as oakland--ca or york--england. Do not use berkeley--ca as a smoke canary.", "default": "oakland--ca" }, "state": { "title": "State / region", "type": "string", "description": "For find-neighborhood: us two-letter (or, wa) or GB england. Not used for LDP.", "default": "or" }, "neighborhood": { "title": "Neighborhood slug", "type": "string", "description": "If omitted on searchType=neighborhood, the worker uses the first city neighborhood link.", "default": "" }, "pageSlug": { "title": "Business page slug", "type": "string", "description": "Live /pages/{slug}. /page/{slug} canonicalizes to /pages/. Do not smoke Sweet Adeline / Fahey DDS.", "default": "" }, "query": { "title": "Business search query", "type": "string", "description": "For searchType=topics or business-search: category like plumber, bakery, electrician. Empty lists the city's /topics/ index (无线索).", "default": "" }, "market": { "title": "Market", "enum": [ "us", "gb", "ca", "au", "fr" ], "type": "string", "description": "us nextdoor.com (opened). gb nextdoor.co.uk and ca ca.nextdoor.com opened for SEO tree. au/fr have no SEO tree.", "default": "us" }, "enrichDetails": { "title": "Enrich details", "type": "boolean", "description": "Fetch /pages/ LDPs so phones, emails, and addresses populate. Default on. City cards have no merchant contact.", "default": true }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 200, "type": "integer", "description": "Cap emitted rows. Worker hard cap 200. Public SEO has no page/offset pager.", "default": 1 }, "maxPages": { "title": "Max pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "Directory pages for searchType=topics. Page 1 is SSR (empty GB/CA SSR may hydrate via businessDirectorySearch). Values >1 follow pageInfo.endCursor. Hard cap 50.", "default": 1 }, "detailUrls": { "title": "Detail URLs", "type": "array", "description": "Optional live nextdoor.com /pages/ or /city/ URLs. Do not send /search or /news_feed.", "items": { "type": "string" } }, "workerBaseUrl": { "title": "Worker base URL override", "type": "string", "description": "HTTPS only. Production source of truth is Actor env WORKER_BASE_URL." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }