{ "openapi": "3.0.1", "info": { "title": "US Building Permits Feed - NYC, Chicago, LA & Austin", "description": "Daily feed of NEWLY issued building permits from official city open-data APIs. Filter by trade (solar, electrical, plumbing, HVAC, demolition), valuation and zip code. Emits only permits it has never seen - schedule it and feed your contractor lead pipeline.", "version": "0.1", "x-build-id": "Sfiktzpzfnal4iWfd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datadeltas~us-building-permits-feed/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datadeltas-us-building-permits-feed", "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/datadeltas~us-building-permits-feed/runs": { "post": { "operationId": "runs-sync-datadeltas-us-building-permits-feed", "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/datadeltas~us-building-permits-feed/run-sync": { "post": { "operationId": "run-sync-datadeltas-us-building-permits-feed", "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": "Which city portals to check. Default: all of them.", "items": { "type": "string", "enum": [ "nyc", "chicago", "la", "austin" ], "enumTitles": [ "New York City (DOB NOW)", "Chicago", "Los Angeles", "Austin" ] }, "default": [ "nyc", "chicago", "la", "austin" ] }, "workTypes": { "title": "Work types", "type": "array", "description": "Only emit permits in these normalised work classes (the raw portal string is always kept in workClassRaw). Leave empty for all work.", "items": { "type": "string", "enum": [ "residential", "commercial", "solar", "demolition", "electrical", "plumbing", "mechanical" ], "enumTitles": [ "Residential", "Commercial", "Solar / PV", "Demolition", "Electrical", "Plumbing", "Mechanical / HVAC" ] } }, "minValuation": { "title": "Minimum valuation (USD)", "minimum": 0, "type": "integer", "description": "Only emit permits with a stated job value of at least this many USD. Permits without a published valuation are excluded when this is set (Chicago and Austin trade permits often publish none).", "default": 0 }, "zipCodes": { "title": "Zip codes", "type": "array", "description": "Only emit permits whose site zip code is in this list (5-digit match). Note: Chicago's portal does not publish site zip codes, so this filter excludes all Chicago permits.", "items": { "type": "string" } }, "sinceDays": { "title": "Backfill window (days)", "minimum": 1, "maximum": 90, "type": "integer", "description": "How many days of issued permits to scan. On the first run this is your backfill; on later runs only permits not seen before are emitted.", "default": 7 }, "maxItems": { "title": "Max new permits per run", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Cap on new permits emitted in a single run (cost control). Permits over the cap are picked up on the next run.", "default": 1000 }, "stateStoreName": { "title": "State store name", "type": "string", "description": "Named key-value store holding per-city watermarks and seen permit numbers. Change it to reset the monitor and re-emit the backfill.", "default": "us-building-permits-feed-state" } } }, "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 } } } } } } } } } }