{ "openapi": "3.0.1", "info": { "title": "Building Permits Search: NYC, LA, Chicago, Seattle", "description": "Search recently issued building permits in New York City, Los Angeles, Chicago and Seattle, all in one format. Filter by permit type, ZIP code, project cost and keyword, or get only permits you have not seen before. Official city open data, no API key.", "version": "0.1", "x-build-id": "S94EFiCs9YCQOzBHb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datapenguin~city-building-permits/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datapenguin-city-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/datapenguin~city-building-permits/runs": { "post": { "operationId": "runs-sync-datapenguin-city-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/datapenguin~city-building-permits/run-sync": { "post": { "operationId": "run-sync-datapenguin-city-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 cities to search. Results are mixed evenly between the cities you pick. Leave empty for all four.", "items": { "type": "string", "enum": [ "nyc", "los-angeles", "chicago", "seattle" ], "enumTitles": [ "New York City", "Los Angeles", "Chicago", "Seattle" ] }, "default": [ "nyc", "los-angeles", "chicago", "seattle" ] }, "daysBack": { "title": "Issued within the last (days)", "minimum": 1, "maximum": 365, "type": "integer", "description": "Only permits issued in this many days. City files run a few days behind, so very short windows can come back empty.", "default": 14 }, "categories": { "title": "Permit category", "type": "array", "description": "Leave empty for every category. New York does not say whether work is new or an alteration, so its general construction permits are listed as General building work (NYC). Chicago and Los Angeles list electrical and plumbing permits in different ways, so check the permit type column too.", "items": { "type": "string", "enum": [ "new-building", "alteration-addition", "building-work", "demolition", "roofing", "electrical", "plumbing-mechanical", "signs", "site-work", "other" ], "enumTitles": [ "New building", "Alteration or addition", "General building work (NYC)", "Demolition", "Roofing", "Electrical", "Plumbing, mechanical and sprinklers", "Signs", "Fences, scaffolds, sheds and excavation", "Other" ] } }, "keywords": { "title": "Keywords", "type": "array", "description": "Match any of these words in the work description, permit type, contractor name or address, for example roof, solar or restaurant. Not case sensitive. Leave empty for no keyword filter.", "items": { "type": "string" } }, "zipCodes": { "title": "ZIP code prefixes", "type": "array", "description": "Start of a ZIP code, for example 981 for part of Seattle or 100 for Manhattan. Chicago does not publish ZIP codes, so it is left out when you use this.", "items": { "type": "string" } }, "minCostUsd": { "title": "Minimum project cost", "minimum": 0, "type": "integer", "description": "Only permits with an estimated cost at or above this amount, for example 100000. Permits with no cost listed are left out." }, "onlyWithContractor": { "title": "Only permits with a contractor", "type": "boolean", "description": "Keep only permits that name a contractor. Los Angeles does not publish contractors, and Seattle names one on only some permits.", "default": false }, "onlyNew": { "title": "Only permits not seen before", "type": "boolean", "description": "Skip permits that an earlier run with the same filters already delivered. Use this on a scheduled run to get just the new permits each time. Changing any filter starts a fresh list.", "default": false }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "The most results to return. You are charged per result, so this also caps what a run can cost.", "default": 100 } } }, "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 } } } } } } } } } }