{ "openapi": "3.0.1", "info": { "title": "HomeAdvisor Scraper — Contractor Leads & Data", "description": "Collect home-service pros from HomeAdvisor & Angi by trade and city. Every business enriched with verified websites, emails, phones, and socials — streamed to your dataset in real time as clean JSON. Perfect for contractor lead gen, market mapping, and CRM enrichment.", "version": "0.0", "x-build-id": "MWE7qoRwHb4O3Jd87" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/b2b_leads~Homeadvisor-Real-Time-Data-Scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-b2b_leads-Homeadvisor-Real-Time-Data-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/b2b_leads~Homeadvisor-Real-Time-Data-Scraper/runs": { "post": { "operationId": "runs-sync-b2b_leads-Homeadvisor-Real-Time-Data-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/b2b_leads~Homeadvisor-Real-Time-Data-Scraper/run-sync": { "post": { "operationId": "run-sync-b2b_leads-Homeadvisor-Real-Time-Data-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": { "enableSearch": { "title": "Search", "type": "boolean", "description": "Search the HomeAdvisor / Angi directory by trade and location. Enabled by default.", "default": true }, "searchTasks": { "title": "Search tasks", "type": "array", "description": "Primary input. Add one row per search: pair a trade with a US city + state. Use the Simple search section below only if you prefer one trade across several cities.", "items": { "type": "object", "properties": { "category": { "title": "Trade / category", "type": "string", "description": "Home-service trade (e.g. \"roofing\", \"plumbing\", \"hvac\", \"electricians\", \"general contractors\").", "editor": "textfield" }, "location": { "title": "Location", "type": "string", "description": "US city with state (e.g. \"Austin, TX\", \"New York, NY\"). The state is required.", "editor": "textfield" }, "zip": { "title": "ZIP (optional)", "type": "string", "description": "Optional ZIP code to narrow the area.", "editor": "textfield" }, "maxResults": { "title": "Max businesses", "type": "integer", "description": "Maximum businesses for this task. Uses the global default below if omitted.", "minimum": 1, "editor": "number" } }, "required": [ "location" ] } }, "maxPagesPerTask": { "title": "Max pages per task", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum depth to paginate each search (safety cap for very large runs).", "default": 5 }, "enableSimpleSearch": { "title": "Enable simple search", "type": "boolean", "description": "Turn on to search with one trade and a list of cities instead of the task table. Ignored while off.", "default": false }, "simpleCategory": { "title": "Trade", "type": "string", "description": "One trade for this simple search (e.g. \"roofing\", \"plumbing\", \"hvac\"). Common aliases work: roofer → roofing, plumber → plumbing, contractor → general contractors. Only used when Simple search is enabled.", "default": "" }, "simpleLocations": { "title": "Cities", "type": "string", "description": "One or more US cities with state, separated by semicolons (e.g. \"Austin, TX; Dallas, TX; Houston, TX\"). The state is required — e.g. \"Austin, TX\". Only used when Simple search is enabled.", "default": "" }, "maxResultsPerTask": { "title": "Default max businesses per task", "minimum": 1, "type": "integer", "description": "Default maximum businesses per search task. Override per task in the list above.", "default": 10 }, "enableScrapeByUrl": { "title": "Scrape By URL", "type": "boolean", "description": "Scrape specific profile URLs instead of searching.", "default": false }, "scrapeUrls": { "title": "Profile URLs", "type": "array", "description": "Directory profile URLs to scrape (one per line).", "default": [], "items": { "type": "string" } }, "enableLeadDetails": { "title": "Enable lead details", "type": "boolean", "description": "Enrich every business with lead details (verified website, emails, phones, socials, badges) when publicly available. Every business is still exported even when no details are found — adds a little extra time per business.", "default": true }, "maxItems": { "title": "Max total items", "minimum": 1, "type": "integer", "description": "Global cap on total dataset rows across all features. Set high for large runs (e.g. 10000+). Note: the run also respects your max total charge for this run.", "default": 10000 }, "concurrency": { "title": "Parallel detail lookups", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many detail lookups to run in parallel (1–8). Higher is faster; 4 is a good default.", "default": 4 }, "delayBetweenRequestsMs": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Polite pacing between directory fetches (0–5000 ms). Higher values are slower but gentler.", "default": 1200 }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Optional. Every record is always saved to the run's dataset — this webhook is an ADDITIONAL real-time push. When set, each new record is also POSTed to this URL (CRM, Slack incoming webhook, Zapier, Make, Google Sheets).", "default": "" }, "webhookFormat": { "title": "Webhook format", "enum": [ "json", "slack" ], "type": "string", "description": "json = full record object; slack = Slack-friendly message payload.", "default": "json" }, "proxyConfiguration": { "title": "Proxy settings", "type": "object", "description": "Apify residential proxy (US) is enabled by default for reliable collection.", "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 }, "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 } } } } } } } } } }