{ "openapi": "3.0.1", "info": { "title": "Building Permits Scraper — Construction & Contractor Leads", "description": "Building permits from ten US and Canadian city portals in one schema: number, type, status, description, address, coordinates, applied and issued dates, declared value, units, contractor and applicant. NYC, Chicago, LA, SF, Seattle, Austin, Cincinnati, Calgary, Edmonton, Winnipeg.", "version": "0.1", "x-build-id": "8K2z0dm5IOLLckq9F" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/chorelet~building-permits-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-chorelet-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/chorelet~building-permits-scraper/runs": { "post": { "operationId": "runs-sync-chorelet-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/chorelet~building-permits-scraper/run-sync": { "post": { "operationId": "run-sync-chorelet-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", "required": [ "cities" ], "properties": { "cities": { "title": "Cities", "type": "array", "description": "Supported: new-york, chicago, san-francisco, seattle, los-angeles, austin, cincinnati, calgary, edmonton, winnipeg. Names and nicknames work too — `New York`, `NYC`, `San Francisco`.", "items": { "type": "string" } }, "issuedSince": { "title": "Issued since", "type": "string", "description": "`30 days`, `last 6 months` or a date such as `2026-01-01`. This is what keeps a run small and current." }, "issuedUntil": { "title": "Issued until", "type": "string", "description": "Same formats; leave empty for today." }, "onlyNew": { "title": "Only new since the last run", "type": "boolean", "description": "Saves only permits that earlier runs did not return. The state is kept in a key-value store on your own account and the run re-reads a three-day overlap, because cities enter permits a day or two late. A run that finds nothing new costs only the run start.", "default": false }, "watchKey": { "title": "Watch key (advanced)", "type": "string", "description": "Which saved state to continue. Empty = one state per task, so two schedules of this Actor never overwrite each other. Set it by hand to share one state between tasks, or change it to start over.", "default": "" }, "keyword": { "title": "Keyword", "type": "string", "description": "Full-text search over the permit record — `solar`, `pool`, `roof`, `kitchen`." }, "permitTypes": { "title": "Permit types", "type": "array", "description": "Partial matches against the permit type, class or work class: `electrical`, `new construction`, `demolition`.", "items": { "type": "string" } }, "statuses": { "title": "Statuses", "type": "array", "description": "Partial matches against the status: `issued`, `final`, `expired`.", "items": { "type": "string" } }, "contractor": { "title": "Contractor or applicant", "type": "string", "description": "Keeps only permits whose contractor or applicant contains this text — the way to watch a competitor." }, "minValue": { "title": "Minimum declared value", "minimum": 0, "type": "integer", "description": "In the city's own currency. 0 keeps everything, including the permits that declare nothing.", "default": 0 }, "maxResultsPerCity": { "title": "Max permits per city", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Newest first, so a small cap still gives you this week's permits.", "default": 1000 } } }, "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 } } } } } } } } } }