{ "openapi": "3.0.1", "info": { "title": "Building Permits Scraper — Construction Leads, US & Canada", "description": "Building permits from city open data in Chicago, New York, Los Angeles, San Diego County, Seattle, Austin, Calgary and more: work, address, value, contractor company, dates. Keyword, value and new-since-last-run filters. No login.", "version": "0.1", "x-build-id": "FmdK6cWtnlPRi4L6j" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/northbell~building-permits-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-northbell-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/northbell~building-permits-scraper/runs": { "post": { "operationId": "runs-sync-northbell-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/northbell~building-permits-scraper/run-sync": { "post": { "operationId": "run-sync-northbell-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 (optional)", "type": "array", "description": "Which permit lists to read, one per line: chicago, new-york, seattle, los-angeles, austin, cincinnati, baton-rouge, montgomery-county-md, montgomery-county-md-commercial, new-orleans, cambridge, cambridge-new-construction, mesa, san-diego-county, pierce-county-wa, calgary, edmonton. Montgomery County, MD and Cambridge, MA publish two lists each. Leave empty for all of them.", "items": { "type": "string" } }, "issuedWithinDays": { "title": "Issued within (days)", "minimum": 1, "maximum": 365, "type": "integer", "description": "Only permits issued in the last N days. Most cities add yesterday's permits each morning; Los Angeles updates about once a week and Seattle publishes a few days behind. Run it daily with 3 and \"Only new\" below for a cheap feed of fresh permits.", "default": 7 }, "keywords": { "title": "Keywords (optional)", "type": "array", "description": "Words to find in the work description or permit type, one per line: \"solar\", \"roof\", \"new construction\", \"pool\". A permit that matches any line is returned; words on one line must all appear. Case does not matter. Leave empty to skip.", "items": { "type": "string" } }, "categories": { "title": "Residential or commercial (optional)", "type": "array", "description": "Only permits marked residential or commercial, one per line. Lists that do not say which (Chicago, New York City, Cincinnati, Mesa and some others) give no permits when you set this. Leave empty for all.", "items": { "type": "string" } }, "minValuation": { "title": "Minimum project value (optional)", "minimum": 0, "type": "number", "description": "Only permits whose stated project value (job value, valuation or construction cost, in US or Canadian dollars) is at least this. Permits that state no value are left out when you set this." }, "maxItemsPerCity": { "title": "Maximum permits per city", "minimum": 1, "maximum": 5000, "type": "integer", "description": "How many permits to return from each list, newest first. You pay per permit returned.", "default": 200 }, "output": { "title": "What to return", "enum": [ "all", "new" ], "type": "string", "description": "With \"Only new\", permits you already got in an earlier run of the same search are skipped and not charged. A permit counts as new when it was issued on a later day than the newest permit your previous run returned for that city. The first run returns everything, because there is nothing to compare with yet.", "default": "all" } } }, "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 } } } } } } } } } }