{ "openapi": "3.0.1", "info": { "title": "Utah Contractor Directory & Leads Scraper (DOPL)", "description": "Utah contractors, electricians and plumbers listed in DOPL's Construction Business Registry, by trade and county or city: phone, email, licence number, address and qualifier.", "version": "0.0", "x-build-id": "XrztKZPlY2luTknKb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapebench~utah-contractor-directory-leads-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapebench-utah-contractor-directory-leads-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/scrapebench~utah-contractor-directory-leads-scraper/runs": { "post": { "operationId": "runs-sync-scrapebench-utah-contractor-directory-leads-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/scrapebench~utah-contractor-directory-leads-scraper/run-sync": { "post": { "operationId": "run-sync-scrapebench-utah-contractor-directory-leads-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": { "listOptionsOnly": { "title": "Discovery Mode: list counties and classifications only", "type": "boolean", "description": "If true, skip the scrape and return Utah's 29 counties plus every category and classification the Construction Business Registry (CBR) searches by, with its code. Free, not charged.", "default": false }, "trade": { "title": "Trade / classification", "type": "string", "description": "A DOPL classification by name or code, e.g. 'Roofing', 'S280', 'HVAC', 'General Building', 'B100'. A word from the name works too: 'roof' finds S280 Roofing. For electricians and plumbers use the licence level: 'Master', 'Journeyman', 'Apprentice'. Leave empty for every classification." }, "trades": { "title": "Trades (batch)", "type": "array", "description": "Several classifications in ONE run, e.g. Roofing and HVAC. Combined with 'Trade' if you fill both. A business listed under two of them is returned (and billed) once.", "default": [], "items": { "type": "string" } }, "category": { "title": "Category", "type": "string", "description": "Which part of the registry: 'contractor' (default), 'handyman', 'electrician', 'plumber', 'burglar alarm' or 'elevator mechanic'. Electricians and plumbers are mostly individual licensees." }, "categories": { "title": "Categories (batch)", "type": "array", "description": "Several categories in ONE run. Combined with 'Category' if you fill both.", "default": [], "items": { "type": "string" } }, "county": { "title": "County", "type": "string", "description": "Utah county, e.g. 'Salt Lake', 'Utah County', 'washington'. The registry has no county field, so county is worked out from each listing's city (see county_method). Leave empty for all of Utah. If it is not a Utah county, the run returns the free county and classification lists instead of failing." }, "counties": { "title": "Counties (batch)", "type": "array", "description": "Several counties in ONE run, e.g. Salt Lake and Utah and Davis. Combined with 'County' if you fill both.", "default": [], "items": { "type": "string" } }, "city": { "title": "City", "type": "string", "description": "A Utah city or town, e.g. 'Provo', 'St. George'. Exact city match ('Salt Lake City' does not include North Salt Lake). Use instead of, or as well as, a county." }, "cities": { "title": "Cities (batch)", "type": "array", "description": "Several cities in ONE run. Combined with 'City' if you fill both.", "default": [], "items": { "type": "string" } }, "includeDetails": { "title": "Include licence details", "type": "boolean", "description": "Fetch each listing's detail record: licence number, licence type, expiry, street address, ZIP and qualifier names. One extra request per listing; turn off for a faster run with name, phone, email and city only.", "default": true }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Cap on the listings returned PER search (each classification x each county or city), not per run, so adding places can never silently truncate the later ones. Leave empty to return every match." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. The registry answers direct requests; enable a proxy only if runs come back with a 'blocked' notice.", "default": { "useApifyProxy": 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 }, "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 } } } } } } } } } }