{ "openapi": "3.0.1", "info": { "title": "US Building Permits Scraper - 30 Cities, One Format", "description": "Get new building permits from 30 US cities and counties (Chicago, NYC, LA, SF, Seattle, Austin, Dallas and more) in one clean format: address, job value, permit type, contractor, owner, dates, lat/long. Filter by date, keyword and job value. Leads for contractors, solar, roofing and suppliers.", "version": "1.0", "x-build-id": "Yzp65xAnAbM4D085F" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/miller_t~us-building-permits/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-miller_t-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/miller_t~us-building-permits/runs": { "post": { "operationId": "runs-sync-miller_t-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/miller_t~us-building-permits/run-sync": { "post": { "operationId": "run-sync-miller_t-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": "Cities to pull permits from.", "items": { "type": "string", "enum": [ "chicago", "new-york", "new-york-legacy", "san-francisco", "los-angeles", "seattle", "austin", "dallas", "fort-worth", "new-orleans", "baton-rouge", "kansas-city", "mesa", "honolulu", "cambridge", "somerville", "providence", "cincinnati", "norfolk", "montgomery-county", "prince-georges-county", "gainesville", "cary", "oakland", "san-mateo-county", "sacramento-county", "roseville", "little-rock", "bloomington", "everett" ], "enumTitles": [ "Chicago, IL", "New York, NY", "New York (DOB BIS), NY", "San Francisco, CA", "Los Angeles, CA", "Seattle, WA", "Austin, TX", "Dallas, TX", "Fort Worth, TX", "New Orleans, LA", "Baton Rouge, LA", "Kansas City, MO", "Mesa, AZ", "Honolulu, HI", "Cambridge, MA", "Somerville, MA", "Providence, RI", "Cincinnati, OH", "Norfolk, VA", "Montgomery County, MD", "Prince George's County, MD", "Gainesville, FL", "Cary, NC", "Oakland, CA", "San Mateo County, CA", "Sacramento County, CA", "Roseville, CA", "Little Rock, AR", "Bloomington, IN", "Everett, WA" ] }, "default": [ "chicago", "new-york", "los-angeles", "austin" ] }, "allCities": { "title": "All cities", "type": "boolean", "description": "Pull from every supported city.", "default": false }, "dateFrom": { "title": "From date", "type": "string", "description": "Permits issued on or after this date. Default: 30 days ago." }, "dateTo": { "title": "To date", "type": "string", "description": "Permits issued on or before this date. Default: today." }, "keyword": { "title": "Keyword", "type": "string", "description": "Full-text filter, e.g. solar, roof, pool, demolition, ADU." }, "minValuation": { "title": "Min job value (USD)", "minimum": 0, "type": "integer", "description": "Only permits with a declared job value at least this. 0 = all.", "default": 0 }, "maxResultsPerCity": { "title": "Max permits per city", "minimum": 0, "type": "integer", "description": "0 = no limit.", "default": 1000 }, "maxResults": { "title": "Max permits total", "minimum": 0, "type": "integer", "description": "0 = no limit.", "default": 0 }, "customDatasets": { "title": "Extra Socrata dataset URLs", "type": "array", "description": "Any other city permit dataset on a Socrata portal, e.g. https://data.example.gov/d/abcd-1234", "items": { "type": "string" } }, "includeRaw": { "title": "Include raw record", "type": "boolean", "description": "Add every original column under raw.", "default": false }, "socrataAppToken": { "title": "Socrata app token (optional)", "type": "string", "description": "Only needed for 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 } } } } } } } } } }