{ "openapi": "3.0.1", "info": { "title": "Nextdoor Scraper", "description": "Extracts structured place-level data from public Nextdoor city pages such as city metadata, FAQs, neighborhood links, business directory links, local group summaries, resource links, city descriptions, resident counts, directory-style public resources, and city statistics.", "version": "0.0", "x-build-id": "gBWZ354niL6GXbFud" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/eunit~nextdoor-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-eunit-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/eunit~nextdoor-scraper/runs": { "post": { "operationId": "runs-sync-eunit-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/eunit~nextdoor-scraper/run-sync": { "post": { "operationId": "run-sync-eunit-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", "required": [ "startUrls" ], "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Public Nextdoor pages to crawl. City pages are the primary supported entry points.", "default": [ { "url": "https://nextdoor.com/city/north-miami--fl/" } ], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "useStartUrlsFromJSONFile": { "title": "Use start URLs from JSON file", "type": "boolean", "description": "If true, the Actor reads start URLs from data\\startURLs.json instead of using startUrls from this input.", "default": false }, "downloadStartUrlsToHtmlSources": { "title": "Download start URLs to local HTML sources", "type": "boolean", "description": "When enabled, the Actor first saves start URLs as local HTML files, then parses those saved files immediately.", "default": false }, "downloadedHtmlDirectory": { "title": "Downloaded HTML directory", "type": "string", "description": "Local directory used to store downloaded HTML source files and sidecar metadata.", "default": "storage/html_sources/default" }, "maxRequestsPerCrawl": { "title": "Max requests per crawl", "minimum": 1, "type": "integer", "description": "Maximum number of live pages to crawl.", "default": 10 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 5, "type": "integer", "description": "Maximum number of parallel browser pages.", "default": 2 }, "maxItemsPerSection": { "title": "Max items per section", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of neighborhoods, directories, FAQs, groups, and related links stored per page.", "default": 25 }, "followNeighborhoodPages": { "title": "Follow neighborhood pages", "type": "boolean", "description": "Queue public neighborhood pages discovered from city pages.", "default": false }, "followBusinessDirectoryPages": { "title": "Follow business directory pages", "type": "boolean", "description": "Queue public business or topic directory pages discovered from city pages.", "default": false }, "followAdditionalResourcePages": { "title": "Follow additional resource pages", "type": "boolean", "description": "Queue public resource pages discovered from city pages.", "default": false }, "saveHtmlSnapshots": { "title": "Save HTML snapshots", "type": "boolean", "description": "Save fetched or fixture HTML to the default key-value store for debugging.", "default": false }, "htmlSnapshotKeyPrefix": { "title": "HTML snapshot key prefix", "type": "string", "description": "Prefix used when saving HTML snapshots.", "default": "HTML" } } }, "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 } } } } } } } } } }