{ "openapi": "3.0.1", "info": { "title": "US Building-Permits Bulk Extractor (Socrata)", "description": "Extract millions of US building-permit records from city open-data portals (Socrata) — construction-activity intelligence. One permit per row. Public data, no login.", "version": "0.1", "x-build-id": "SDK7qxLIfp89j38P0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/xtracto~building-permits/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-xtracto-building-permits", "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/xtracto~building-permits/runs": { "post": { "operationId": "runs-sync-xtracto-building-permits", "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/xtracto~building-permits/run-sync": { "post": { "operationId": "run-sync-xtracto-building-permits", "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": "Pick one or more built-in city permit datasets. (Need another city? Use Custom datasets below.)", "items": { "type": "string", "enum": [ "chicago", "sf", "austin", "nyc", "la", "calgary", "seattle", "cincinnati", "winnipeg", "mesa", "batonrouge", "dallas", "sandiego_co", "gainesville", "marin", "roseville" ], "enumTitles": [ "Chicago, IL", "San Francisco, CA", "Austin, TX", "New York City (DOB)", "Los Angeles, CA", "Calgary, AB", "Seattle, WA", "Cincinnati, OH", "Winnipeg, MB", "Mesa, AZ", "Baton Rouge, LA", "Dallas, TX", "San Diego County, CA", "Gainesville, FL", "Marin County, CA", "Roseville, CA" ] }, "default": [ "chicago" ] }, "customDatasets": { "title": "Custom Socrata datasets", "type": "array", "description": "Any Socrata dataset: [{\"domain\":\"data.seattle.gov\",\"datasetId\":\"76t5-zqzr\",\"cityKey\":\"seattle\"}]" }, "where": { "title": "SoQL $where filter", "type": "string", "description": "Optional. e.g. issue_date > '2026-01-01T00:00:00' — narrows the pull (and your result count).", "default": "" }, "appToken": { "title": "Socrata App Token", "type": "string", "description": "Optional free token (data.gov / Socrata). Lifts the anonymous rate limit — recommended for large pulls." }, "pageSize": { "title": "Page size", "minimum": 100, "maximum": 50000, "type": "integer", "description": "How many permits to fetch per request (default 1000).", "default": 1000 }, "maxItemsPerDataset": { "title": "Max items per dataset (0 = all)", "minimum": 0, "type": "integer", "description": "Cap the number of permits pulled per city. 0 means all.", "default": 0 }, "maxConcurrency": { "title": "Max concurrent datasets", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many cities to process in parallel.", "default": 3 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not required (public open-data API). Leave off unless you hit rate limits.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }