{ "openapi": "3.0.1", "info": { "title": "Building Permit Signal — new US permits, contractors, values", "description": "New building permits from official open data of NYC, Chicago, SF, LA, Seattle, Austin, Cincinnati and Montgomery County MD. Filter by keyword, value and ZIP; contractor names where published; only new permits since your last run.", "version": "0.1", "x-build-id": "zCXjAXGzMUpINHJMP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/handa-labs~us-building-permit-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-handa-labs-us-building-permit-monitor", "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/handa-labs~us-building-permit-monitor/runs": { "post": { "operationId": "runs-sync-handa-labs-us-building-permit-monitor", "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/handa-labs~us-building-permit-monitor/run-sync": { "post": { "operationId": "run-sync-handa-labs-us-building-permit-monitor", "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 official permit registries to read.", "items": { "type": "string", "enum": [ "nyc", "chicago", "sf", "la", "seattle", "austin", "cincinnati", "montgomery-md" ], "enumTitles": [ "New York City (DOB NOW)", "Chicago", "San Francisco", "Los Angeles", "Seattle", "Austin", "Cincinnati", "Montgomery County, MD" ] }, "default": [ "nyc", "chicago", "seattle", "austin" ] }, "keywords": { "title": "Keywords (any)", "type": "array", "description": "Case-insensitive; matched against the work description, work type, permit type and contractor trade. Leave empty for all permits.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Exclude keywords", "type": "array", "description": "Drop permits whose description or type contains any of these.", "items": { "type": "string" } }, "minValue": { "title": "Minimum declared value (USD)", "minimum": 0, "type": "integer", "description": "Keep only permits whose declared/estimated job value is at least this. Permits without a value are dropped when set." }, "zipPrefixes": { "title": "ZIP prefixes", "type": "array", "description": "Keep only permits whose ZIP starts with one of these (e.g. \"981\", \"787\"). Chicago does not publish ZIPs.", "items": { "type": "string" } }, "contractorOnly": { "title": "Only permits with a named contractor", "type": "boolean", "description": "Contractor names are published by NYC, Chicago, Seattle, Austin and Cincinnati.", "default": false }, "daysBack": { "title": "Days back", "minimum": 1, "maximum": 90, "type": "integer", "description": "Look at permits issued within the last N days (1–90).", "default": 7 }, "mode": { "title": "Mode", "enum": [ "monitor", "snapshot" ], "type": "string", "description": "monitor = remember what was returned and only emit permits not seen before (first run is a free baseline). snapshot = return everything matching every time.", "default": "monitor" }, "watchlistId": { "title": "Watchlist ID", "type": "string", "description": "Name for this watch (e.g. \"seattle-roofing\"). Separate IDs keep separate memories; the filters are part of the key too.", "default": "default" }, "emitBaseline": { "title": "Emit the baseline too", "type": "boolean", "description": "On the very first run of a watchlist, also output the current permits (charged). Default: only a free summary.", "default": false }, "maxPermits": { "title": "Max permits", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Cap on permits kept per run (most recent first).", "default": 2000 }, "socrataAppToken": { "title": "Socrata app token (optional)", "type": "string", "description": "Raises the open-data rate limit. Not needed for normal use." } } }, "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 } } } } } } } } } }