{ "openapi": "3.0.1", "info": { "title": "US Building Permits: 13 Metros (NYC, Chicago, Miami & more)", "description": "Fresh building permits from 13 US city and regional open-data feeds (New York, Chicago, Miami, Orlando, Columbus, Cleveland, Cincinnati, Detroit, Seattle, Tempe, Cambridge, Rockville, Baltimore region), normalized into one table with contractor names where the city publishes them and trade presets.", "version": "0.1", "x-build-id": "7eD3G53qSt5W4PmqD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/groundtip~us-building-permits/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-groundtip-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/groundtip~us-building-permits/runs": { "post": { "operationId": "runs-sync-groundtip-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/groundtip~us-building-permits/run-sync": { "post": { "operationId": "run-sync-groundtip-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 city feeds to pull. Leave empty for all 13.", "items": { "type": "string", "enum": [ "new_york", "chicago", "rockville_md", "miami", "tempe", "cambridge_ma", "detroit", "seattle", "orlando", "baltimore_region", "cincinnati", "columbus", "cleveland" ], "enumTitles": [ "New York City, NY", "Chicago, IL", "Rockville, MD", "Miami, FL", "Tempe, AZ", "Cambridge, MA", "Detroit, MI", "Seattle, WA", "Orlando, FL", "Baltimore region, MD (7 jurisdictions, monthly)", "Cincinnati, OH", "Columbus, OH", "Cleveland, OH" ] }, "default": [ "new_york", "chicago", "rockville_md", "miami", "tempe", "cambridge_ma", "detroit", "seattle", "orlando", "baltimore_region", "cincinnati", "columbus", "cleveland" ] }, "daysBack": { "title": "Days back", "minimum": 1, "maximum": 365, "type": "integer", "description": "Used when 'Date from' is empty: pull the last N days, ending on 'Date to' (or today).", "default": 7 }, "dateFrom": { "title": "Date from (YYYY-MM-DD)", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Optional start date. Overrides 'Days back'." }, "dateTo": { "title": "Date to (YYYY-MM-DD)", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Optional end date. Defaults to today." }, "tradePresets": { "title": "Trade presets", "type": "array", "description": "Keep only permits relevant to these trades (matched on permit type, work class and description). Leave empty for all permits.", "items": { "type": "string", "enum": [ "dumpster_demolition", "concrete", "fencing", "roofing", "pools", "solar", "hvac_mechanical", "electrical", "plumbing", "insulation", "new_construction" ], "enumTitles": [ "Dumpster / demolition / remodel", "Concrete / flatwork / masonry", "Fencing", "Roofing", "Pools & spas", "Solar", "HVAC / mechanical", "Electrical", "Plumbing", "Insulation / weatherization", "New construction" ] }, "default": [] }, "permitTypes": { "title": "Permit type contains", "type": "array", "description": "Optional. Keep permits whose type contains any of these words, e.g. 'Building Permit', 'Demolition'.", "default": [], "items": { "type": "string" } }, "workClasses": { "title": "Work class contains", "type": "array", "description": "Optional. Keep permits whose work class contains any of these words, e.g. 'New', 'Remodel'.", "default": [], "items": { "type": "string" } }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many permits (newest first).", "default": 5000 } } }, "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 } } } } } } } } } }