{ "openapi": "3.0.1", "info": { "title": "Building Permits Scraper - Multi-City Construction Leads", "description": "Building permits from dozens of city open-data portals in one run. Cities are discovered from the Socrata catalog, not a hand-kept list. Personal contact fields are dropped at the server.", "version": "0.1", "x-build-id": "OJUjjXi0ULgyFM39o" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/abdulwhab95~building-permits-multi-city/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-abdulwhab95-building-permits-multi-city", "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/abdulwhab95~building-permits-multi-city/runs": { "post": { "operationId": "runs-sync-abdulwhab95-building-permits-multi-city", "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/abdulwhab95~building-permits-multi-city/run-sync": { "post": { "operationId": "run-sync-abdulwhab95-building-permits-multi-city", "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": { "query": { "title": "What to look for", "type": "string", "description": "Searched against the Socrata open-data catalog to find which cities publish it. 'building permits' is the default; 'demolition permits' or 'electrical permits' also work.", "default": "building permits" }, "maxCities": { "title": "Max cities", "minimum": 1, "maximum": 40, "type": "integer", "description": "How many city portals to pull from in one run.", "default": 8 }, "maxPermitsPerCity": { "title": "Max permits per city", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Stop after this many permits from each city.", "default": 500 }, "issuedSince": { "title": "Issued since (YYYY-MM-DD)", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Only permits issued on or after this date, written YYYY-MM-DD (e.g. 2026-01-01). Leave empty for the most recent available. Applied only where the city publishes an issue-date column.", "default": "" }, "sources": { "title": "Only these cities (dataset domains)", "type": "array", "description": "Optional. Dataset domains to read, one per line, e.g. data.cityofchicago.org or data.calgary.ca - the domain is each city's stable ID in the run report's coverage. Only cities the catalog returns for 'What to look for' can be matched; any that are not are listed under sourcesNotFound. Empty: every city the catalog offers, as before.", "default": [], "items": { "type": "string" } }, "permitTypes": { "title": "Permit types", "type": "array", "description": "Optional. Return only permits whose permitType contains one of these words (case-insensitive), e.g. 'new', 'demolition'. A permit with no type never matches. Checked before a permit is delivered or charged, within the permits read (Max permits per city still bounds the rows read).", "default": [], "items": { "type": "string" } }, "minDeclaredValue": { "title": "Minimum declared value", "minimum": 0, "type": "number", "description": "Optional. Return only permits whose declaredValue is at least this amount, in the city's own currency. A permit with no declared value never passes. Empty or 0: no minimum. Checked before a permit is delivered or charged." }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Politeness toward city servers. These are public portals - do not hammer them.", "default": 300 }, "onlyNew": { "title": "Only permits not delivered before", "type": "boolean", "description": "On: remember which permits each city has already delivered (up to the last 50,000 per city) and return only ones not seen in earlier runs. Max permits per city then counts permits checked, not permits returned. The first run returns everything.", "default": false }, "stateStoreName": { "title": "Seen-permits store name", "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$", "type": "string", "description": "Named key-value store that remembers delivered permits for 'Only permits not delivered before'. Use a different name to track separately.", "default": "permits-state" } } }, "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 } } } } } } } } } }