{ "openapi": "3.0.1", "info": { "title": "US Building Permits: 10 cities, one schema (open data)", "description": "Returns recently issued building permits from the open-data portals of New York City, Chicago, San Francisco, Los Angeles, Austin, Seattle, New Orleans, Montgomery County MD, Cincinnati and Baton Rouge in one normalized schema: permit number, type, description, status, address, coordinates...", "version": "0.1", "x-build-id": "TznSL7aWGfasAfubA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cheering_unicorn~us-building-permits/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cheering_unicorn-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/cheering_unicorn~us-building-permits/runs": { "post": { "operationId": "runs-sync-cheering_unicorn-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/cheering_unicorn~us-building-permits/run-sync": { "post": { "operationId": "run-sync-cheering_unicorn-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": "Which open-data sources to query. Leave empty for all.", "items": { "type": "string", "enum": [ "nyc", "chicago", "san-francisco", "los-angeles", "austin", "seattle", "new-orleans", "montgomery-county-md", "cincinnati", "baton-rouge" ], "enumTitles": [ "New York City (DOB NOW)", "Chicago", "San Francisco", "Los Angeles", "Austin", "Seattle", "New Orleans", "Montgomery County, MD", "Cincinnati", "Baton Rouge (East Baton Rouge Parish)" ] } }, "issuedAfter": { "title": "Issued on or after", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Date in YYYY-MM-DD. Default: 7 days ago." }, "issuedBefore": { "title": "Issued before", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Date in YYYY-MM-DD (exclusive). Leave empty for no upper bound." }, "keywords": { "title": "Description keywords", "type": "array", "description": "Keep permits whose work description contains any of these words (case-insensitive), for example `solar`, `roof`, `demolition`, `pool`.", "items": { "type": "string" } }, "minEstimatedCost": { "title": "Minimum estimated cost (USD)", "minimum": 0, "type": "integer", "description": "Skip permits with a declared project value below this amount. Sources without a cost column ignore this filter.", "default": 0 }, "includeRawRecord": { "title": "Include raw source record", "type": "boolean", "description": "Add the original open-data row under `raw` (city-specific columns). Names of individuals are never included in the normalized fields; the raw row may contain whatever the city publishes.", "default": false }, "maxPermitsPerCity": { "title": "Max permits per city", "minimum": 0, "type": "integer", "description": "0 = no limit.", "default": 2000 }, "maxPermits": { "title": "Max permits in total", "minimum": 0, "type": "integer", "description": "Stop the run after this many permits. 0 = no limit. You pay only for permits saved.", "default": 0 }, "socrataAppToken": { "title": "Socrata app token (optional)", "type": "string", "description": "Optional Socrata application token to lift the anonymous rate limit on very large pulls. 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 }, "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 } } } } } } } } } }