{ "openapi": "3.0.1", "info": { "title": "Building Permit Leads - Solar, Roofing, HVAC & Windows", "description": "Trade-filtered building permit leads for contractors and sales teams. Pulls newly-issued permits from Chicago, LA, San Francisco, Austin & Seattle, classifies each by trade (solar, roofing, HVAC, windows), and returns one clean schema per metro.", "version": "0.1", "x-build-id": "R4d6KaumhH4Q5bCPv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dabomb1177~permit-leads-solar-roofing-hvac/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dabomb1177-permit-leads-solar-roofing-hvac", "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/dabomb1177~permit-leads-solar-roofing-hvac/runs": { "post": { "operationId": "runs-sync-dabomb1177-permit-leads-solar-roofing-hvac", "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/dabomb1177~permit-leads-solar-roofing-hvac/run-sync": { "post": { "operationId": "run-sync-dabomb1177-permit-leads-solar-roofing-hvac", "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": { "metros": { "title": "Metros (cities)", "type": "array", "description": "Which city open-data portals to pull permits from. All are public Socrata datasets.", "items": { "type": "string", "enum": [ "chicago", "los_angeles", "san_francisco", "austin", "seattle" ], "enumTitles": [ "Chicago, IL", "Los Angeles, CA", "San Francisco, CA", "Austin, TX", "Seattle, WA" ] }, "default": [ "chicago", "los_angeles", "san_francisco", "austin", "seattle" ] }, "trades": { "title": "Trades to include", "type": "array", "description": "Only return permits classified into these trades. Clear the list to return every permit (each still tagged with its detected trade, or 'other').", "items": { "type": "string", "enum": [ "solar", "roofing", "hvac", "windows", "siding", "ev_charger" ], "enumTitles": [ "Solar / Photovoltaic", "Roofing / Re-roof", "HVAC / Mechanical", "Windows / Doors", "Siding / Exterior", "EV Charger" ] }, "default": [ "solar", "roofing", "hvac", "windows" ] }, "dateBasis": { "title": "Date basis", "enum": [ "issued", "applied" ], "type": "string", "description": "Filter and sort by the date the permit was ISSUED (work about to start) or APPLIED (earlier signal).", "default": "issued" }, "lookbackDays": { "title": "Lookback days", "minimum": 1, "maximum": 3650, "type": "integer", "description": "If no 'Since date' is set, return permits from this many days back. 30 gives you the last month of fresh leads.", "default": 30 }, "sinceDate": { "title": "Since date (overrides lookback)", "type": "string", "description": "Only permits on or after this date (YYYY-MM-DD). Set this to your last run date to get just the new permits." }, "untilDate": { "title": "Until date", "type": "string", "description": "Only permits on or before this date (YYYY-MM-DD). Leave empty for 'up to today'." }, "minValuationUsd": { "title": "Minimum job valuation (USD)", "minimum": 0, "type": "integer", "description": "Skip permits whose declared job value is below this amount. 0 disables the filter. Permits with no stated value are always kept.", "default": 0 }, "maxItems": { "title": "Max results (total)", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Maximum number of leads to return across all metros, newest first.", "default": 500 }, "maxItemsPerMetro": { "title": "Max results per metro", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Cap per city so one large city doesn't crowd out the others.", "default": 200 }, "maxScanPerMetro": { "title": "Max permits scanned per metro", "minimum": 100, "maximum": 100000, "type": "integer", "description": "Safety cap on how many recent permits are scanned per city before trade filtering. Raise for rare trades over long windows.", "default": 5000 }, "socrataAppToken": { "title": "Socrata app token (optional)", "type": "string", "description": "Optional free Socrata app token for higher rate limits (https://data.cityofchicago.org/profile/edit/developer_settings). Not required for typical runs." }, "includeRawRecord": { "title": "Include raw permit record", "type": "boolean", "description": "Attach each city's original unmodified permit row under a 'raw' field.", "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 } } }, "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 } } } } } } } } } }