{ "openapi": "3.0.1", "info": { "title": "US Building Permits (City Open Data)", "description": "Building permits from official city open-data portals (Chicago, New York City, San Francisco, Seattle, Austin, Los Angeles) in one schema, with optional new-since-last-run monitoring.", "version": "1.0", "x-build-id": "Y5gQJ9FqTYfMxWgxQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jetlaunch~us-building-permits-open-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jetlaunch-us-building-permits-open-data", "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/jetlaunch~us-building-permits-open-data/runs": { "post": { "operationId": "runs-sync-jetlaunch-us-building-permits-open-data", "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/jetlaunch~us-building-permits-open-data/run-sync": { "post": { "operationId": "run-sync-jetlaunch-us-building-permits-open-data", "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": "Cities to query. Each city is read from its own official open-data portal.", "items": { "type": "string", "enum": [ "new-york-city", "san-francisco", "seattle", "austin" ], "enumTitles": [ "New York City", "San Francisco", "Seattle", "Austin" ] }, "default": [ "seattle" ] }, "daysBack": { "title": "Issued in the last N days", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Used when 'Issued from' is empty. Counts back from today (UTC) or from 'Issued to' when that is set.", "default": 30 }, "dateFrom": { "title": "Issued from (YYYY-MM-DD)", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "First permit issue date to include. Overrides 'Issued in the last N days' when set." }, "dateTo": { "title": "Issued to (YYYY-MM-DD)", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Last permit issue date to include. Leave empty for today." }, "permitTypes": { "title": "Permit types (contains)", "type": "array", "description": "Optional. Keep a permit when its permit type text contains any of these words, ignoring case. Examples: new construction, renovation, electrical, demolition, roof. Type names differ by city.", "default": [], "items": { "type": "string" } }, "minCost": { "title": "Minimum declared cost (USD)", "minimum": 0, "type": "integer", "description": "Optional. Only permits whose declared cost is at least this amount. Permits with no declared cost are left out when this is set." }, "keyword": { "title": "Keyword in work description", "type": "string", "description": "Optional. Only permits whose work description contains this text, ignoring case. Example: solar, roof, kitchen, warehouse." }, "maxResults": { "title": "Max results per city", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Upper bound on permits returned for each selected city. You are charged per permit returned, so this also caps your spend.", "default": 25 }, "mode": { "title": "Mode", "enum": [ "search", "new-since-last-run" ], "type": "string", "description": "'Search' returns every permit that matches. 'New since last run' returns only permits not returned by an earlier run with the same monitor name, oldest first, and remembers them for the next run.", "default": "search" }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Only used in 'New since last run' mode. Runs that share a name share their memory of permits already returned. Use a different name for each saved search.", "default": "default" }, "appToken": { "title": "Socrata app token (optional)", "type": "string", "description": "Optional. A free Socrata app token raises the portals' request limits. The Actor works without one." } } }, "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 } } } } } } } } } }