{ "openapi": "3.0.1", "info": { "title": "US Building Permits Scraper - 8 City Open-Data Portals", "description": "For contractor lead gen, construction suppliers and property analysts: newly issued building permits from 8 official city open-data portals in one schema. New York alone issued 1,829 permits in a 7-day window. One row per permit, and value filters compare numbers, not text. No API key.", "version": "0.1", "x-build-id": "FToN9mOF2t05xncFu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/neverempty~us-building-permits-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-neverempty-us-building-permits-scraper", "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/neverempty~us-building-permits-scraper/runs": { "post": { "operationId": "runs-sync-neverempty-us-building-permits-scraper", "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/neverempty~us-building-permits-scraper/run-sync": { "post": { "operationId": "run-sync-neverempty-us-building-permits-scraper", "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 portals to search. Each city publishes different columns: New York City, Austin, Cincinnati, New Orleans and Chicago publish a contractor name; Los Angeles and San Francisco do not. All eight publish a job value.", "items": { "type": "string", "enum": [ "nyc", "la", "chicago", "austin", "sf", "seattle", "nola", "cincinnati" ], "enumTitles": [ "New York City, NY", "Los Angeles, CA", "Chicago, IL", "Austin, TX", "San Francisco, CA", "Seattle, WA", "New Orleans, LA", "Cincinnati, OH" ] } }, "daysBack": { "title": "Issued in the last N days", "minimum": 1, "maximum": 365, "type": "integer", "description": "Permits issued in the last N days, counting today. Cities publish permits one to five days after issue, so the most recent days fill in over the following week. Ignored when an issued-from date is given.", "default": 30 }, "issuedFrom": { "title": "Issued from (YYYY-MM-DD)", "type": "string", "description": "Earliest issue date, instead of the last N days.", "default": "" }, "issuedTo": { "title": "Issued to (YYYY-MM-DD)", "type": "string", "description": "Latest issue date. Empty means today.", "default": "" }, "keyword": { "title": "Keyword", "type": "string", "description": "Keep permits whose description or permit type contains this text, such as roof, solar, pool or HVAC. Case does not matter. Cincinnati publishes only a permit category (HVAC, Alteration, Plumbing Permits...) rather than a written description, so there a keyword can only match category names." }, "minValueUsd": { "title": "Minimum job value (USD)", "minimum": 0, "type": "integer", "description": "Keep permits whose declared job value is at least this many dollars. Four of the eight portals store the value as text; it is compared as a number here (compared as text, 'over $1,000,000' matched 9,997 New York permits in 30 days instead of 699). Permits with no declared value are left out when this is set - in Austin that is most permits." }, "maxPermitsPerCity": { "title": "Maximum permits per city", "minimum": 1, "maximum": 10000, "type": "integer", "description": "The most permits returned for each city, newest first. A permit that the portal splits over several records (for example one record per trade in New York) counts once.", "default": 200 } } }, "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 } } }, "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 } } } } } } } } } }