{ "openapi": "3.0.1", "info": { "title": "US Building Permit Scraper — Construction Lead Gen", "description": "Pull building permits from 13 US cities: Chicago, NYC, LA, SF, Seattle, Austin, Cincinnati, Orlando, Baton Rouge, New Orleans, Minneapolis, Baltimore, Tempe. Supports Socrata + ArcGIS portals.", "version": "0.1", "x-build-id": "pxYvhm3dzSCZiPMhs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/handstands.io~us-building-permit-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-handstands.io-us-building-permit-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/handstands.io~us-building-permit-scraper/runs": { "post": { "operationId": "runs-sync-handstands.io-us-building-permit-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/handstands.io~us-building-permit-scraper/run-sync": { "post": { "operationId": "run-sync-handstands.io-us-building-permit-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": "US cities to pull building permits from (36 supported). Examples: Chicago, New York City, San Francisco, Los Angeles, Seattle, Tacoma, Austin, Cincinnati, Orlando, Baton Rouge, New Orleans, Dallas, San Diego County, Norfolk, Buffalo, Minneapolis, Baltimore, Tempe, Denver, Fort Worth, Nashville, Raleigh, Louisville, Gainesville, Sacramento, Philadelphia, Miami, Greensboro, Anaheim, Columbus, Washington DC, Reno, Sparks, Washoe County, Douglas County, Maricopa County. Case-insensitive. Leave blank if using Custom Endpoints only.", "items": { "type": "string" } }, "issuedAfter": { "title": "Issued after (date)", "type": "string", "description": "Only return permits issued on or after this date. Format: YYYY-MM-DD. Leave blank for no start date filter." }, "issuedBefore": { "title": "Issued before (date)", "type": "string", "description": "Only return permits issued on or before this date. Format: YYYY-MM-DD. Leave blank for no end date filter." }, "permitTypes": { "title": "Permit type filter", "type": "array", "description": "Filter to permits whose type contains one of these strings (case-insensitive). Leave blank for all types. Examples: 'new construction', 'renovation', 'electrical', 'roofing', 'solar'.", "items": { "type": "string" } }, "minProjectValue": { "title": "Minimum project value ($)", "minimum": 0, "type": "integer", "description": "Only return permits with a reported project value at or above this amount. Set to 0 for no minimum. Not all cities report project value — applies where available.", "default": 0 }, "maxResultsPerSource": { "title": "Max results per city", "minimum": 0, "type": "integer", "description": "Maximum number of permits to return per city. Set to 0 for no limit.", "default": 0 }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Milliseconds to wait between paginated API requests. Increase if you encounter rate limits.", "default": 300 }, "customEndpoints": { "title": "Custom Socrata endpoints", "type": "array", "description": "Add any Socrata open data portal not in the built-in city list. Each entry needs cityName, stateCode, domain (e.g. data.kcmo.org), datasetId, and optional fields mapping." } } }, "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 } } } } } } } } } }