{ "openapi": "3.0.1", "info": { "title": "US Building Permit Leads: 6 cities, tagged by trade", "description": "Newly issued building permits from 6 major US cities' open-data portals in one schema: address, date, description, valuation, contractor (+ phone in Austin), lat/lon. Tagged by trade (roofing, solar, HVAC, pool, ADU...) so you pull only yours. onlyNew mode for daily runs. $2 per 1,000 permits.", "version": "0.1", "x-build-id": "NjuVHnf6C5dSFEvmE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/johnveds15~us-building-permit-leads/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-johnveds15-us-building-permit-leads", "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/johnveds15~us-building-permit-leads/runs": { "post": { "operationId": "runs-sync-johnveds15-us-building-permit-leads", "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/johnveds15~us-building-permit-leads/run-sync": { "post": { "operationId": "run-sync-johnveds15-us-building-permit-leads", "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 read.", "items": { "type": "string", "enum": [ "nyc", "los-angeles", "chicago", "san-francisco", "austin", "seattle" ], "enumTitles": [ "New York City (DOB NOW)", "Los Angeles (LADBS)", "Chicago", "San Francisco (DBI)", "Austin", "Seattle (SDCI)" ] }, "default": [ "nyc", "los-angeles", "chicago", "san-francisco", "austin", "seattle" ] }, "lookbackDays": { "title": "Issued in the last N days", "minimum": 1, "maximum": 90, "type": "integer", "description": "How many days back from the end date to collect issued permits (1 to 90).", "default": 7 }, "endDate": { "title": "End date (YYYY-MM-DD)", "type": "string", "description": "Defaults to today. Most portals publish with a 1-2 day lag." }, "trades": { "title": "Trades", "type": "array", "description": "Keep permits tagged with any of these. Empty = all permits.", "items": { "type": "string", "enum": [ "roofing", "solar", "hvac", "pool", "adu", "electrical", "plumbing", "windows", "fence", "demolition", "new-construction", "remodel", "ev-charger", "kitchen-bath", "masonry", "foundation" ] }, "default": [] }, "minValuation": { "title": "Minimum job valuation (USD)", "minimum": 0, "type": "integer", "description": "Permits without a published valuation are dropped when this is above 0. Austin publishes no valuation.", "default": 0 }, "zipCodes": { "title": "ZIP codes", "type": "array", "description": "Only these 5-digit ZIPs. Chicago's dataset has no ZIP. Empty = all.", "default": [], "items": { "type": "string" } }, "keywords": { "title": "Description contains", "type": "array", "description": "Case-insensitive words that must appear in the description (any of them).", "default": [], "items": { "type": "string" } }, "onlyNew": { "title": "Only permits not delivered in a previous run", "type": "boolean", "description": "Remembers delivered permit numbers for 120 days in a named key-value store in YOUR account.", "default": false }, "maxResults": { "title": "Maximum permits", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Hard cap on permits pushed (and charged) this run.", "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 } } } } } } } } } }