{ "openapi": "3.0.1", "info": { "title": "Building Permits Scraper: 12 Cities, Contractor Leads", "description": "Building permits from 12 US and Canadian city open data portals in ONE schema: contractor name, phone, licence, owner, valuation and a derived project class (solar, roofing, HVAC, new build). Plus a contractor rollup. No API key, no proxy.", "version": "0.1", "x-build-id": "mc0wh2icGSxasprRu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/themineworks~building-permits-construction-leads/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-themineworks-building-permits-construction-leads", "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/themineworks~building-permits-construction-leads/runs": { "post": { "operationId": "runs-sync-themineworks-building-permits-construction-leads", "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/themineworks~building-permits-construction-leads/run-sync": { "post": { "operationId": "run-sync-themineworks-building-permits-construction-leads", "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": "City keys to pull permits from, for example \"austin_tx\" or \"seattle_wa\". Valid keys: new_york_ny, chicago_il, austin_tx, seattle_wa, san_francisco_ca, philadelphia_pa, boston_ma, cincinnati_oh, montgomery_county_md, baton_rouge_la, new_orleans_la, edmonton_ab. Every key was verified live against its municipal open data portal.", "items": { "type": "string" } }, "daysBack": { "title": "Days back", "minimum": 1, "maximum": 3650, "type": "integer", "description": "How far back to look, counted from the permit issue date. 30 gives you this month's activity, 365 gives a year of history for market sizing.", "default": 90 }, "projectClasses": { "title": "Project classes", "type": "array", "description": "Keep only these derived project classes, for example \"solar\" or \"roofing\". One of solar, ev_charger, battery_storage, roofing, pool_spa, hvac, new_construction, adu, demolition, fence_deck, sign, electrical, plumbing, fire_safety, elevator, addition, remodel, other. Leave empty for every class.", "items": { "type": "string" } }, "keywords": { "title": "Description keywords", "type": "array", "description": "Keep only permits whose type, work class, description or contractor name contains one of these words, for example \"reroof\" or \"kitchen remodel\". Case insensitive. Applied on top of the project class filter.", "items": { "type": "string" } }, "minValuation": { "title": "Minimum job value", "minimum": 0, "type": "integer", "description": "Drop permits below this declared job value. Useful for filtering out $500 water heater swaps when you want real projects. Note that not every city publishes a valuation, and permits with no value are dropped when this is set.", "default": 0 }, "contractorLeadsOnly": { "title": "Only permits with a named contractor", "type": "boolean", "description": "Keep only permits that carry a contractor company name. Turn this on when you are building a contractor prospect list rather than studying construction activity.", "default": false }, "contractorRollup": { "title": "Add contractor rollup rows", "type": "boolean", "description": "Append one aggregated row per contractor at the end of the run with permit count, total and average job value, cities, trades and licence. These rows are free: they are derived from permits you already paid for.", "default": true }, "maxPermitsPerCity": { "title": "Max permits per city", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Hard cap per city. This is your main cost and runtime control.", "default": 500 } } }, "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 } } } } } } } } } }