{ "openapi": "3.0.1", "info": { "title": "US Building Permits Scraper: New Permit & Contractor Leads", "description": "Search and monitor new building permits in NYC, Chicago, LA, San Francisco, Seattle, Austin and more from official city open-data portals, no API key. Filter by keyword, work type (roofing, solar...), ZIP and cost. Flat JSON with address, cost, contractor, owner. 'Only new' mode for alerts.", "version": "0.1", "x-build-id": "riUqX6ny3u4XHLiFN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/radiant_opuntia~us-building-permits-alerts/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-radiant_opuntia-us-building-permits-alerts", "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/radiant_opuntia~us-building-permits-alerts/runs": { "post": { "operationId": "runs-sync-radiant_opuntia-us-building-permits-alerts", "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/radiant_opuntia~us-building-permits-alerts/run-sync": { "post": { "operationId": "run-sync-radiant_opuntia-us-building-permits-alerts", "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 building-permit datasets to search. Each one is the city's official open-data feed.", "items": { "type": "string", "enum": [ "nyc", "chicago", "la", "sf", "seattle", "austin", "cincinnati", "batonrouge", "mesa" ], "enumTitles": [ "New York City (DOB NOW)", "Chicago", "Los Angeles", "San Francisco", "Seattle", "Austin", "Cincinnati", "Baton Rouge", "Mesa, AZ" ] }, "default": [ "nyc", "chicago", "la", "sf", "seattle", "austin" ] }, "keyword": { "title": "Keyword", "type": "string", "description": "Full-text match on the permit record (description, type, address, contractor, owner). Examples: 'solar', 'roof', 'swimming pool', 'tesla', 'restaurant'." }, "categories": { "title": "Work categories", "type": "array", "description": "Only keep permits in these automatically detected categories. Leave empty for all. Great for roofers, solar installers, electricians and HVAC companies.", "items": { "type": "string", "enum": [ "new_construction", "addition", "renovation_alteration", "demolition", "roofing", "solar", "electrical", "plumbing", "hvac_mechanical", "pool_spa", "fence_wall", "signs", "other" ], "enumTitles": [ "New construction", "Addition", "Renovation / alteration / tenant improvement", "Demolition", "Roofing", "Solar", "Electrical", "Plumbing / gas / sprinklers", "HVAC / mechanical", "Pool / spa", "Fence / wall", "Signs", "Other" ] }, "default": [] }, "zipCodes": { "title": "ZIP codes", "type": "array", "description": "Only permits at these 5-digit ZIP codes. Chicago and Mesa don't publish a permit ZIP, so they return nothing when this is set. Leave empty for all.", "default": [], "items": { "type": "string" } }, "minProjectCost": { "title": "Minimum project cost (USD)", "minimum": 0, "type": "integer", "description": "Skip permits with an unknown or lower estimated cost. 0 = no minimum.", "default": 0 }, "issuedWithinDays": { "title": "Issued within last N days", "minimum": 1, "maximum": 365, "type": "integer", "description": "Permits issued in the last N days. Ignored if a start date is set.", "default": 7 }, "startDate": { "title": "Start date (optional)", "type": "string", "description": "Earliest issue date, YYYY-MM-DD. Overrides 'Issued within last N days'." }, "endDate": { "title": "End date (optional)", "type": "string", "description": "Latest issue date, YYYY-MM-DD. Defaults to today." }, "onlyNew": { "title": "Only new since last run (alerts mode)", "type": "boolean", "description": "Remember which permits were already returned and output only newly issued ones. Ideal with a daily Schedule + email/Slack/webhook integration.", "default": false }, "stateKey": { "title": "Alert name (optional)", "type": "string", "description": "Separate memory for 'only new' mode. Defaults to a key derived from your filters." }, "socrataAppToken": { "title": "Socrata app token (optional)", "type": "string", "description": "Not needed. Anonymous access is enough for alerts. A free app token from the city's data portal raises rate limits for very large pulls." }, "maxResultsPerCity": { "title": "Max results per city", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Stop after this many permits per city.", "default": 200 }, "maxResults": { "title": "Max results (total)", "minimum": 1, "maximum": 200000, "type": "integer", "description": "Stop after this many permits in total.", "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 } } } } } } } } } }