{ "openapi": "3.0.1", "info": { "title": "US Building Permits Scraper - Construction Leads", "description": "Construction permits from 12 US cities (Chicago, NYC, LA, San Francisco, Seattle, Austin and more) in one unified format. Find new projects and contractor leads: filter by date, keyword, valuation and permit type. Official open data, no login, no personal data.", "version": "1.1", "x-build-id": "DyD7uAsQ8Cn2gUmMk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/batreek~us-building-permits/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-batreek-us-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/batreek~us-building-permits/runs": { "post": { "operationId": "runs-sync-batreek-us-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/batreek~us-building-permits/run-sync": { "post": { "operationId": "run-sync-batreek-us-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": "Which cities to pull permits from. Leave empty for all supported cities.", "items": { "type": "string", "enum": [ "chicago", "new-york", "los-angeles", "san-francisco", "seattle", "austin", "new-orleans", "cambridge-ma", "montgomery-county-md", "mesa-az", "cincinnati", "baton-rouge" ], "enumTitles": [ "Chicago, IL", "New York City, NY (DOB NOW)", "Los Angeles, CA", "San Francisco, CA", "Seattle, WA", "Austin, TX", "New Orleans, LA", "Cambridge, MA (new construction)", "Montgomery County, MD (residential)", "Mesa, AZ", "Cincinnati, OH", "Baton Rouge, LA (East Baton Rouge)" ] }, "default": [ "chicago", "austin", "seattle" ] }, "issuedAfter": { "title": "Issued on or after", "type": "string", "description": "Only permits issued on or after this date (YYYY-MM-DD). Leave empty to use 'Days back'." }, "daysBack": { "title": "Days back", "minimum": 1, "maximum": 3650, "type": "integer", "description": "If 'Issued on or after' is empty, fetch permits issued in the last N days.", "default": 30 }, "keywords": { "title": "Keywords (any)", "type": "array", "description": "Keep only permits whose type or description contains at least one of these words, e.g. solar, roof, pool, ADU, demolition, HVAC. Case-insensitive.", "items": { "type": "string" } }, "minValuation": { "title": "Minimum project valuation (USD)", "minimum": 0, "type": "integer", "description": "Keep only permits with a reported project value at or above this amount. Permits with no reported value are dropped when this is set." }, "maxResultsPerCity": { "title": "Max results per city", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Upper limit of permits to return per city (newest first). You pay per permit saved, so this is your main cost control: 3 cities × 50 = 150 permits ≈ $0.23.", "default": 500 }, "includeRaw": { "title": "Include raw source record", "type": "boolean", "description": "Attach the original open-data record (with personal-name and contact fields removed) under `raw`.", "default": 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 }, "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 } } } } } } } } } }