{ "openapi": "3.0.1", "info": { "title": "US Contractor Leads — Electricians, Plumbers & HVAC", "description": "License-verified electrician, plumber and HVAC contractor leads from official US state licensing boards. Florida, Louisiana, North Carolina and California — four states in one run. Business name, license number, status, address, phone and opt-in email. Active licensees only.", "version": "0.0", "x-build-id": "ROhNxFMtHAf90MJS2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/memo23~us-home-services-contractor-leads/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-memo23-us-home-services-contractor-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/memo23~us-home-services-contractor-leads/runs": { "post": { "operationId": "runs-sync-memo23-us-home-services-contractor-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/memo23~us-home-services-contractor-leads/run-sync": { "post": { "operationId": "run-sync-memo23-us-home-services-contractor-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": { "states": { "title": "States", "type": "array", "description": "US state codes to search. Currently LIVE: FL, LA, NC, CA. Requesting a not-yet-supported state logs why and is skipped (see the README coverage matrix).", "items": { "type": "string", "enum": [ "FL", "LA", "NC", "CA", "OH", "NY", "PA" ], "enumTitles": [ "Florida (live)", "Louisiana (live)", "North Carolina (live)", "California (live)", "Ohio (coming soon)", "New York (municipal)", "Pennsylvania (municipal)" ] }, "default": [ "FL", "LA", "NC", "CA" ] }, "trades": { "title": "Trades", "type": "array", "description": "Which contractor trades to include. Leave empty for all three.", "items": { "type": "string", "enum": [ "electrician", "plumber", "hvac" ], "enumTitles": [ "Electricians", "Plumbers", "HVAC / Air Conditioning" ] }, "default": [ "electrician", "plumber", "hvac" ] }, "counties": { "title": "Counties (optional, FL & CA)", "type": "array", "description": "County names to filter by, e.g. \"Miami-Dade\", \"Los Angeles\". Empty = statewide. Florida (DBPR) and California (CSLB) support a county filter; LA and NC boards search by city instead (see Cities).", "items": { "type": "string" } }, "cities": { "title": "Cities (optional)", "type": "array", "description": "City names to filter by. For LA and NC this is the board's exact-match city search; for FL and CA it filters the licensee's address/export by city (FL needs \"Fetch full details\"). Empty = statewide sweep.", "items": { "type": "string" } }, "maxItems": { "title": "Max leads", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Hard cap on the number of contractor rows for the whole run.", "default": 500 }, "fetchDetails": { "title": "Fetch full details", "type": "boolean", "description": "Open each licensee's detail page for full address, ZIP and phone. Slower but richer; also required for city filtering.", "default": true }, "enrichEmails": { "title": "Enrich emails (opt-in)", "type": "boolean", "description": "Find a business email for each contractor by discovering and scraping their own website. Off by default.", "default": false }, "hunterApiKey": { "title": "Hunter.io API key (optional)", "type": "string", "description": "Paid Hunter.io fallback used only when a site scrape finds no email. Leave empty to use the free site-scrape path only." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "State licensing boards are US-only sites; a US residential proxy is recommended for reliability at scale.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }