{ "openapi": "3.0.1", "info": { "title": "Building Permits Scraper — Construction Leads", "description": "Fresh building permit data from 11 verified city & county open-data APIs: Chicago, NYC, LA, Austin, SF, Seattle, Miami, Miami-Dade, Maricopa, New Orleans, Philadelphia. Roofing, solar, HVAC & remodeling leads with contractor and valuation data. Reliable government sources, no proxies, no breakage.", "version": "0.1", "x-build-id": "k3AoNVDDcb1yccEvI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/4l3c~building-permits-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-4l3c-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/4l3c~building-permits-scraper/runs": { "post": { "operationId": "runs-sync-4l3c-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/4l3c~building-permits-scraper/run-sync": { "post": { "operationId": "run-sync-4l3c-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", "properties": { "cities": { "title": "Cities", "type": "array", "description": "Cities/counties to pull permits from. Each is a verified government open-data API.", "items": { "type": "string", "enum": [ "chicago", "new-york", "austin", "san-francisco", "seattle", "los-angeles", "new-orleans", "maricopa-county", "miami-dade", "miami", "philadelphia", "mesa", "nashville", "fort-worth", "san-antonio" ], "enumTitles": [ "Chicago, IL", "New York City, NY", "Austin, TX (has contractor phone)", "San Francisco, CA", "Seattle, WA", "Los Angeles, CA (has solar flag)", "New Orleans, LA", "Maricopa County, AZ", "Miami-Dade County, FL (has contractor phone + license)", "Miami (city), FL", "Philadelphia, PA", "Mesa, AZ", "Nashville, TN", "Fort Worth, TX", "San Antonio, TX" ] }, "default": [ "chicago", "austin", "miami-dade" ] }, "dateFrom": { "title": "Issued from (YYYY-MM-DD)", "type": "string", "description": "Earliest permit issue date to include. Leave empty for 7 days ago.", "default": "" }, "dateTo": { "title": "Issued to (YYYY-MM-DD)", "type": "string", "description": "Latest permit issue date to include. Leave empty for today.", "default": "" }, "tradeFilter": { "title": "Trade filter", "enum": [ "any", "roofing", "solar", "hvac", "electrical", "plumbing", "remodel" ], "type": "string", "description": "Only keep permits matching a trade (matched against permit type + work description; Los Angeles also uses its native solar flag).", "default": "any" }, "permitTypes": { "title": "Permit type keywords", "type": "array", "description": "Optional extra keywords — keep a permit if ANY keyword appears in its type or description (case-insensitive). Example: \"demolition\", \"pool\".", "default": [], "items": { "type": "string" } }, "minValuation": { "title": "Minimum valuation (USD)", "minimum": 0, "type": "integer", "description": "Only keep permits with reported valuation at or above this amount. 0 = no filter. Note: some cities don't publish valuations (see README coverage table) — this filter drops their records.", "default": 0 }, "onlyNewResults": { "title": "Only new results (for scheduled runs)", "type": "boolean", "description": "Remember the newest permit seen per city and only return newer ones on the next run. Turn this on + schedule the Actor daily for a fresh-leads feed.", "default": false }, "maxItems": { "title": "Max results", "minimum": 0, "type": "integer", "description": "Stop after this many permits (controls your cost). 0 = unlimited.", "default": 0 }, "socrataAppToken": { "title": "Socrata app token (optional)", "type": "string", "description": "Free token from any Socrata site (e.g. data.cityofchicago.org) raises rate limits for the 7 Socrata-backed cities. Works fine without one for normal volumes." } } }, "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 } } } } } } } } } }