{ "openapi": "3.0.1", "info": { "title": "US Building Permits Scraper (Multi-City Construction Leads)", "version": "0.1", "x-build-id": "98RiDYh9S4zQmafSg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rejoiceful_xaphoon~us-building-permits/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rejoiceful_xaphoon-us-building-permits", "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/rejoiceful_xaphoon~us-building-permits/runs": { "post": { "operationId": "runs-sync-rejoiceful_xaphoon-us-building-permits", "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/rejoiceful_xaphoon~us-building-permits/run-sync": { "post": { "operationId": "run-sync-rejoiceful_xaphoon-us-building-permits", "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 cities to search. Leave empty to search all supported cities.", "items": { "type": "string", "enum": [ "chicago", "new_york", "los_angeles", "san_francisco", "seattle", "austin", "new_orleans", "baton_rouge", "cincinnati", "mesa", "montgomery_county_md" ], "enumTitles": [ "Chicago, IL", "New York City, NY (DOB NOW)", "Los Angeles, CA", "San Francisco, CA", "Seattle, WA", "Austin, TX", "New Orleans, LA", "Baton Rouge, LA (East Baton Rouge Parish)", "Cincinnati, OH", "Mesa, AZ", "Montgomery County, MD (commercial)" ] } }, "issuedWithinDays": { "title": "Issued within last N days", "minimum": 1, "type": "integer", "description": "Only permits issued in the last N days (default 30 when no dates are set). Set 1-7 and schedule daily or weekly for fresh leads." }, "dateFrom": { "title": "Issued from (YYYY-MM-DD)", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Start of the issue-date window. Overrides 'Issued within last N days'." }, "dateTo": { "title": "Issued to (YYYY-MM-DD)", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "End of the issue-date window (inclusive)." }, "keywords": { "title": "Keywords", "type": "array", "description": "Match ANY of these words in the work description or permit type (case-insensitive), e.g. roof, solar, pool, HVAC, demolition, ADU.", "items": { "type": "string" } }, "permitTypes": { "title": "Permit type contains", "type": "array", "description": "Match ANY of these in the permit type / work class fields only, e.g. 'new construction', 'electrical', 'plumbing', 'sign'.", "items": { "type": "string" } }, "minValue": { "title": "Minimum project value ($)", "minimum": 0, "type": "integer", "description": "Only permits whose declared job value / valuation is at least this amount." }, "requireContractor": { "title": "Only permits with a contractor company", "type": "boolean", "description": "Skip permits that have no contractor business name (useful for B2B lead lists).", "default": false }, "maxItemsPerCity": { "title": "Max results per city", "minimum": 1, "type": "integer", "description": "Cap per city so one large city does not crowd out the others. Defaults to the overall max." }, "maxItems": { "title": "Max results (total)", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum permits to return across all cities.", "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 } } } } } } } } } }