{ "openapi": "3.0.1", "info": { "title": "US Building Permits – 8 Cities, One Schema (Official Open Data)", "description": "Issued building permits from 8 US city open-data portals (Chicago, NYC, LA, Austin, Seattle, Cincinnati, Mesa, Baton Rouge) in one clean schema. Adds trade category (solar, roofing, HVAC, ADU…), status, processing days, value band, contractor company. No homeowner names. Only-new mode.", "version": "0.1", "x-build-id": "Ibsih7VhthSA9oyrz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/knobby_woodworker_aig~us-building-permits-multi-city/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-knobby_woodworker_aig-us-building-permits-multi-city", "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/knobby_woodworker_aig~us-building-permits-multi-city/runs": { "post": { "operationId": "runs-sync-knobby_woodworker_aig-us-building-permits-multi-city", "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/knobby_woodworker_aig~us-building-permits-multi-city/run-sync": { "post": { "operationId": "run-sync-knobby_woodworker_aig-us-building-permits-multi-city", "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": "Leave empty for all 8 cities.", "items": { "type": "string", "enum": [ "chicago", "nyc", "los-angeles", "austin", "seattle", "cincinnati", "mesa", "baton-rouge" ], "enumTitles": [ "Chicago, IL", "New York City, NY (DOB NOW)", "Los Angeles, CA (LADBS)", "Austin, TX", "Seattle, WA (SDCI)", "Cincinnati, OH", "Mesa, AZ", "Baton Rouge, LA" ] } }, "daysBack": { "title": "Days back", "minimum": 0, "maximum": 3650, "type": "integer", "description": "Permits issued in the last N days (used when no start date is set). Note: some portals publish with a lag of a few days (LA ~7 days).", "default": 7 }, "startDate": { "title": "Issued from", "type": "string", "description": "YYYY-MM-DD (overrides Days back)." }, "endDate": { "title": "Issued to", "type": "string", "description": "YYYY-MM-DD. Default today." }, "categories": { "title": "Trade categories", "type": "array", "description": "Keep permits tagged with any of these (e.g. solar, roofing, hvac, new_construction, adu). Leave empty for all.", "items": { "type": "string", "enum": [ "new_construction", "demolition", "adu", "solar", "ev_charger", "battery_storage", "roofing", "hvac", "plumbing", "electrical", "fire_protection", "pool_spa", "fence_wall", "sign", "windows_doors", "siding_exterior", "foundation_structural", "elevator", "tenant_improvement", "kitchen_bath_remodel", "addition_alteration", "site_grading", "deck_porch", "scaffold_sidewalk_shed", "occupancy", "telecom", "other" ] } }, "keywords": { "title": "Keywords", "type": "array", "description": "Keep permits whose type or description contains any keyword (case-insensitive), e.g. heat pump, generator, restaurant.", "items": { "type": "string" } }, "zipCodes": { "title": "ZIP codes", "type": "array", "description": "Optional 5-digit ZIPs.", "items": { "type": "string" } }, "minValuationUsd": { "title": "Minimum job value (USD)", "minimum": 0, "type": "integer", "description": "Keep permits with declared project value at least this. Permits without a value are dropped when set." }, "statuses": { "title": "Normalized status", "type": "array", "description": "Leave empty for all.", "items": { "type": "string", "enum": [ "issued", "active", "completed", "expired", "cancelled", "in_review", "other" ] } }, "includeDescription": { "title": "Include work description", "type": "boolean", "description": "Full scope-of-work text.", "default": true }, "onlyNew": { "title": "Only new permits (delta mode)", "type": "boolean", "description": "Remember permit numbers between runs and output only permits not seen before. Ideal for daily lead feeds.", "default": false }, "stateStoreName": { "title": "State store name", "type": "string", "description": "Named key-value store for delta mode; use one per saved search.", "default": "us-building-permits-state" }, "maxItemsPerCity": { "title": "Max permits per city", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Cap per city so one big city doesn't crowd out the others.", "default": 200 }, "maxItems": { "title": "Max permits total", "minimum": 1, "maximum": 500000, "type": "integer", "description": "Stop after this many rows overall.", "default": 2000 } } }, "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 } } } } } } } } } }