{ "openapi": "3.0.1", "info": { "title": "City Data Scraper – Population, Crime & Demographics", "description": "city-data.com can be used to track important data for real estate investments, or general market/demographic data.", "version": "0.3", "x-build-id": "WlS1hvi9IvOfBVox7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/staticxviper~city-data-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-staticxviper-city-data-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/staticxviper~city-data-scraper/runs": { "post": { "operationId": "runs-sync-staticxviper-city-data-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/staticxviper~city-data-scraper/run-sync": { "post": { "operationId": "run-sync-staticxviper-city-data-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": { "cities": { "title": "Cities", "type": "array", "description": "Objects with city, state, and optional slug. Overrides city + state when set." }, "city": { "title": "City", "type": "string", "description": "Single city name, used when cities is empty." }, "state": { "title": "State", "type": "string", "description": "Two-letter state code for the single-city form." }, "slug": { "title": "Slug override", "type": "string", "description": "Optional city-data path token for the single-city form." }, "fields": { "title": "Field groups", "type": "array", "description": "Groups to parse. Crime also fetches the crime page.", "items": { "type": "string", "enum": [ "population", "income", "housing", "cost_of_living", "education", "crime" ], "enumTitles": [ "Population", "Income", "Housing", "Cost of living", "Education", "Crime" ] }, "default": [ "population", "income", "housing", "cost_of_living", "education", "crime" ] }, "delaySeconds": { "title": "Delay between requests (seconds)", "minimum": 0, "type": "number", "description": "Pause between page loads. Default 1.5, same as the local CLI.", "default": 1.5 }, "timeoutMs": { "title": "Navigation timeout (ms)", "minimum": 1000, "type": "integer", "description": "Playwright navigation timeout.", "default": 30000 }, "maxCities": { "title": "Max cities", "minimum": 1, "type": "integer", "description": "Optional cap on how many cities from the list are scraped." }, "headless": { "title": "Headless browser", "type": "boolean", "description": "Run Chromium headless. Default true.", "default": true }, "maxSpendUsd": { "title": "Max spend (USD)", "minimum": 0, "maximum": 100, "type": "number", "description": "Stop when the next result, proxy, or CAPTCHA event would pass this amount. Default 5, maximum 100. Later rows are saved and are not billed.", "default": 5 }, "maxProxyCostUsd": { "title": "Max proxy spend (USD)", "minimum": 0, "maximum": 20, "type": "number", "description": "Cap on proxy events alone. Default 0.50, clamped to maxSpendUsd. The first city page stays direct. A proxy retry happens only after a block, and only when this cap and maxSpendUsd both still have room. 0 skips the proxy retry.", "default": 0.5 }, "allowCaptcha": { "title": "Allow CAPTCHA solving", "type": "boolean", "description": "Default false. When false, a challenge after the proxy retry pushes a blocked row and exits without a solve charge. When true, a solve is attempted only if that proxy retry is still a challenge and maxSpendUsd covers the captcha event. This Actor does not ship a solver, so an unconfigured solve pushes blocked and is not billed.", "default": false }, "proxyConfiguration": { "title": "Proxy group", "type": "object", "description": "Apify Proxy group used only after a direct page is blocked. Leave Apify Proxy off so the first attempt stays direct. Empty groups use datacenter.", "default": { "useApifyProxy": false } }, "proxyGroups": { "title": "Proxy groups", "type": "array", "description": "Optional group names, such as DATACENTER or RESIDENTIAL. Used after a block when proxyConfiguration has no apifyProxyGroups.", "items": { "type": "string" } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }