{ "openapi": "3.0.1", "info": { "title": "Building Permits Scraper: Construction Leads from 11 US Cities", "description": "Newly issued building permits from 11 US city and county open-data portals: address, type, description, valuation, dates and contractor. Filter by city, keyword (solar, roof, pool, ADU) and value.", "version": "1.0", "x-build-id": "QRDhgXuG6NFuCDujg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/great_stuff~building-permits-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-great_stuff-building-permits-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/great_stuff~building-permits-scraper/runs": { "post": { "operationId": "runs-sync-great_stuff-building-permits-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/great_stuff~building-permits-scraper/run-sync": { "post": { "operationId": "run-sync-great_stuff-building-permits-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", "required": [ "cities" ], "properties": { "cities": { "title": "Cities", "type": "array", "description": "Which city open-data portals to search.", "items": { "type": "string", "enum": [ "austin", "chicago", "new-york", "los-angeles", "san-francisco", "seattle", "dallas", "baton-rouge", "cincinnati", "mesa", "marin-county" ], "enumTitles": [ "Austin, TX", "Chicago, IL", "New York City, NY (DOB NOW)", "Los Angeles, CA", "San Francisco, CA", "Seattle, WA", "Dallas, TX", "Baton Rouge, LA", "Cincinnati, OH", "Mesa, AZ", "Marin County, CA" ] }, "default": [ "austin" ] }, "daysBack": { "title": "Issued in the last N days", "minimum": 0, "maximum": 3650, "type": "integer", "description": "Look back this many days from today (or from 'Issued to'). Ignored when 'Issued from' is set. Most portals update daily, with a lag of 1 to 7 days.", "default": 7 }, "dateFrom": { "title": "Issued from (YYYY-MM-DD)", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Optional start date. Dallas is limited to the latest 92 days." }, "dateTo": { "title": "Issued to (YYYY-MM-DD)", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Optional end date. Defaults to today." }, "keywords": { "title": "Description contains (any)", "type": "array", "description": "Keep permits whose work description contains any of these words, e.g. \"solar\", \"pool\", \"roof\", \"new construction\", \"ADU\". Case-insensitive.", "default": [], "items": { "type": "string" } }, "excludeKeywords": { "title": "Description excludes", "type": "array", "description": "Drop permits whose description contains any of these words.", "default": [], "items": { "type": "string" } }, "permitClass": { "title": "Residential or commercial", "enum": [ "any", "residential", "commercial" ], "type": "string", "description": "Best-effort filter based on each city's permit class and type fields.", "default": "any" }, "minValuation": { "title": "Minimum project value (USD)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Keep permits with a declared value at least this high. Permits with no value are dropped when this is set.", "default": 0 }, "requireContractor": { "title": "Only permits with a contractor name", "type": "boolean", "description": "Drop permits with no contractor listed (useful for B2B supplier outreach).", "default": false }, "maxPermitsPerCity": { "title": "Max permits per city", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many permits per city (newest first). You pay only for saved permits.", "default": 100 }, "socrataAppToken": { "title": "Socrata app token (optional)", "type": "string", "description": "Optional free Socrata app token for higher rate limits on very large pulls." } } }, "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 } } } } } } } } } }