{ "openapi": "3.0.1", "info": { "title": "US Building Permits & Construction Leads", "description": "New building permits from official city open-data portals: Chicago, NYC, Los Angeles, San Francisco, Seattle, Austin, Mesa, New Orleans, Baton Rouge, Cincinnati, Montgomery County MD. Contractor, owner, valuation, address, geo. Keyword, value and daily new-only alerts.", "version": "1.0", "x-build-id": "tTGjmCQ1MmpASiwAj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/clever_firebox~us-building-permits/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-clever_firebox-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/clever_firebox~us-building-permits/runs": { "post": { "operationId": "runs-sync-clever_firebox-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/clever_firebox~us-building-permits/run-sync": { "post": { "operationId": "run-sync-clever_firebox-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 / counties", "type": "array", "description": "Official open-data permit feeds to query. Empty = Chicago, Austin, Seattle.", "items": { "type": "string", "enum": [ "chicago", "nyc", "los_angeles", "seattle", "austin", "san_francisco", "cincinnati", "baton_rouge", "new_orleans", "mesa", "montgomery_md_residential", "montgomery_md_commercial" ], "enumTitles": [ "Chicago, IL", "New York City, NY", "Los Angeles, CA", "Seattle, WA", "Austin, TX", "San Francisco, CA", "Cincinnati, OH", "Baton Rouge, LA", "New Orleans, LA", "Mesa, AZ", "Montgomery County, MD (residential)", "Montgomery County, MD (commercial)" ] }, "default": [ "chicago", "austin", "seattle" ] }, "lastNDays": { "title": "Issued in the last N days", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Used when 'Issued after' is empty. Portals usually lag 1-3 days.", "default": 7 }, "issuedAfter": { "title": "Issued after (YYYY-MM-DD)", "type": "string", "description": "Optional explicit start date." }, "issuedBefore": { "title": "Issued before (YYYY-MM-DD)", "type": "string", "description": "Optional end date." }, "keywords": { "title": "Keywords (any)", "type": "array", "description": "Whole-word match in description / permit type / work type, e.g. solar, roof, pool, ADU, demolition, HVAC.", "items": { "type": "string" } }, "minValuation": { "title": "Minimum project value ($)", "minimum": 0, "type": "integer", "description": "Declared job value. Permits without a value are dropped when this is above 0.", "default": 0 }, "zipCodes": { "title": "ZIP codes (prefix)", "type": "array", "description": "E.g. 60614 or 787.", "items": { "type": "string" } }, "contractorContains": { "title": "Contractor name contains", "type": "string", "description": "Only cities that publish contractor names are queried." }, "requireContractor": { "title": "Only permits with a contractor name", "type": "boolean", "description": "Useful for contractor lead lists.", "default": false }, "onlyNewSinceLastRun": { "title": "Only new since last run (alerts)", "type": "boolean", "description": "Remembers permits already delivered (per alert name). Ideal with a daily schedule.", "default": false }, "alertStateName": { "title": "Alert name", "type": "string", "description": "Separate memory per saved search.", "default": "default" }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 200000, "type": "integer", "description": "You are charged per permit delivered.", "default": 100 }, "splitEvenly": { "title": "Split results evenly across cities", "type": "boolean", "description": "Share Max results across the selected cities (unused share passes to the next city).", "default": true }, "socrataAppToken": { "title": "Socrata app token (optional)", "type": "string", "description": "Optional free token for higher rate limits on 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 } } } } } } } } } }