{ "openapi": "3.0.1", "info": { "title": "Building Permits Scraper - Construction & Contractor Leads", "description": "Scrape building and construction permits from 11 US cities' official open-data APIs: Austin, San Antonio, NYC DOB, LA, Chicago, Philadelphia, Boston, Seattle, San Francisco, Cincinnati, Baton Rouge. One schema with address, ZIP, work description, valuation, owner, contractor name and phone.", "version": "0.1", "x-build-id": "IKsNGbUuXyqdH8xAd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/make_no_mistakes~us-building-permits-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-make_no_mistakes-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/make_no_mistakes~us-building-permits-scraper/runs": { "post": { "operationId": "runs-sync-make_no_mistakes-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/make_no_mistakes~us-building-permits-scraper/run-sync": { "post": { "operationId": "run-sync-make_no_mistakes-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", "required": [ "cities" ], "properties": { "cities": { "title": "Cities", "type": "array", "description": "Which cities to scrape. Every city listed here is backed by a live, officially published open-data feed that is refreshed daily.", "items": { "type": "string", "enum": [ "austin", "san-antonio", "new-york", "los-angeles", "chicago", "philadelphia", "boston", "seattle", "san-francisco", "cincinnati", "baton-rouge" ], "enumTitles": [ "Austin, TX", "San Antonio, TX", "New York, NY", "Los Angeles, CA", "Chicago, IL", "Philadelphia, PA", "Boston, MA", "Seattle, WA", "San Francisco, CA", "Cincinnati, OH", "Baton Rouge, LA" ] }, "default": [ "austin" ] }, "daysBack": { "title": "Days back", "minimum": 0, "maximum": 365, "type": "integer", "description": "How many days of issued permits to pull, counting back from today (UTC). Ignored when both Start date and End date are set.", "default": 7 }, "startDate": { "title": "Start date (optional)", "type": "string", "description": "Earliest issued date to include, as YYYY-MM-DD. Overrides Days back." }, "endDate": { "title": "End date (optional)", "type": "string", "description": "Latest issued date to include, as YYYY-MM-DD. Defaults to today (UTC)." }, "maxItems": { "title": "Max items", "minimum": 0, "type": "integer", "description": "Hard cap on dataset items across all selected cities combined. Set to 0 for unlimited (a wide date range across several cities can return hundreds of thousands of permits).", "default": 1000 }, "permitTypes": { "title": "Permit type filter (optional)", "type": "string", "description": "Comma-separated keywords. A permit is kept when any keyword appears in its permit type, permit class or work description (case-insensitive). Example: roof, solar, hvac. Leave empty for every permit type." }, "includeAdministrative": { "title": "Include administrative permits", "type": "boolean", "description": "Off by default. A few city registers mix non-construction, administrative records into the same feed as building permits - San Antonio alone publishes garage sales (~3,800/year) and tree affidavits (~2,300/year), and also carries temporary advertising banners and signs; Philadelphia adds tent, canopy and fireworks \"Operations\" permits; Baton Rouge adds short-term-rental and business licences, code complaints and political campaign signs. These rows have no job site scope, no valuation and no contractor to sell to, so they are excluded at the source. Turn this on to get the full register instead.", "default": false } } }, "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 } } } } } } } } } }