{ "openapi": "3.0.1", "info": { "title": "US Building Permits – NYC, Chicago, SF, LA, Austin, Seattle", "description": "Reliable permit feed: never a silent empty result. A city portal that is down gives a clear free error row; no match gives a free no_results row with the city's newest date. Permits from NYC, Chicago, SF, LA, Austin, Seattle in one schema: type, cost, address, contractor.", "version": "0.1", "x-build-id": "cltv1DHWYwm0tUHs4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/liora-tools~us-building-permits/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-liora-tools-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/liora-tools~us-building-permits/runs": { "post": { "operationId": "runs-sync-liora-tools-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/liora-tools~us-building-permits/run-sync": { "post": { "operationId": "run-sync-liora-tools-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", "type": "array", "description": "City open-data portals to query.", "items": { "type": "string", "enum": [ "nyc", "chicago", "san_francisco", "los_angeles", "austin", "seattle" ], "enumTitles": [ "New York City (DOB NOW)", "Chicago", "San Francisco", "Los Angeles", "Austin", "Seattle" ] }, "default": [ "nyc", "chicago", "san_francisco", "los_angeles", "austin", "seattle" ] }, "daysBack": { "title": "Issued in the last N days", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Ignored when 'Issued from' is set.", "default": 30 }, "issuedFrom": { "title": "Issued from (YYYY-MM-DD)", "type": "string", "description": "Optional start date." }, "issuedTo": { "title": "Issued to (YYYY-MM-DD)", "type": "string", "description": "Optional end date." }, "keywords": { "title": "Description keywords", "type": "array", "description": "Match ANY of these in the work description, e.g. 'new building', 'HVAC', 'pool', 'demolition', 'ADU'.", "items": { "type": "string" } }, "permitTypeContains": { "title": "Permit type contains", "type": "array", "description": "Optional, e.g. 'electrical', 'new construction', 'alteration'.", "items": { "type": "string" } }, "minEstimatedCost": { "title": "Min estimated cost (USD)", "minimum": 0, "type": "integer", "description": "Drop permits with a lower declared job value." }, "zipCodes": { "title": "ZIP codes", "type": "array", "description": "Optional ZIP filter.", "items": { "type": "string" } }, "onlyWithContractor": { "title": "Only permits with a contractor company", "type": "boolean", "description": "Available for NYC, Chicago, Austin, Seattle.", "default": false }, "maxItemsPerCity": { "title": "Max permits per city", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Newest first.", "default": 200 }, "maxItems": { "title": "Max results (total)", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Optional total cap on billable permits for the whole run (same option name as in our other open-data Actors). Leave empty for no total cap; `maxItemsPerCity` still applies. For a hard dollar cap use 'Max charge per run' in Run options." }, "socrataAppToken": { "title": "Socrata app token (optional)", "type": "string", "description": "Optional free app token for higher rate limits on very large pulls. Not needed for normal use." }, "onlyNewSinceLastRun": { "title": "Only permits not returned by a previous run", "type": "boolean", "description": "For scheduled feeds: remembers permits already returned for the same cities and filters (in a named key-value store on your account) and skips them, so overlapping date windows are not charged twice.", "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 }, "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 } } } } } } } } } }