{ "openapi": "3.0.1", "info": { "title": "Angi Home Services Scraper", "description": "Scrape Angi (Angie's List) home-service pros by city, ZIP, category URL, or profile — name, phone, rating, reviews, address, website. Cookieless; residential proxy required. MCP-ready.", "version": "0.1", "x-build-id": "ffE4NQEZNYBEKOZRO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/khadinakbar~angi-home-services-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-khadinakbar-angi-home-services-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/khadinakbar~angi-home-services-scraper/runs": { "post": { "operationId": "runs-sync-khadinakbar-angi-home-services-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/khadinakbar~angi-home-services-scraper/run-sync": { "post": { "operationId": "run-sync-khadinakbar-angi-home-services-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": { "category": { "title": "Service category slug", "type": "string", "description": "Angi trade slug used in companylist URLs, for example plumbing, electrical, hvac, or roofing. Pair with city and state, or with zipCodes. Ignored when startUrls alone drive the run. NOT a free-text Google query." }, "city": { "title": "City slug or name", "type": "string", "description": "US city for the Angi directory page, for example austin or New York. Requires state. Prefer this over ZIP for accurate companylist URLs. Ignored when only profile startUrls are supplied." }, "state": { "title": "US state code", "type": "string", "description": "Two-letter US state code, for example tx, ca, or ny. Required with city. Case-insensitive." }, "zipCodes": { "title": "ZIP codes", "type": "array", "description": "Optional US 5-digit ZIPs. Each ZIP is resolved to a city/state listing URL when category is set. Angi ZIP query params are often non-filtering — city slug remains authoritative.", "items": { "type": "string" } }, "startUrls": { "title": "Angi listing or profile URLs", "type": "array", "description": "Direct angi.com companylist pages and/or business profile URLs (/business/..., companyreviews.htm?spid=, or *-reviews-{id}.htm). Overrides structured search when present. Non-angi URLs are ignored.", "items": { "type": "string" } }, "maxResults": { "title": "Max providers", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Cap on unique billed provider rows for the run. Default 100. Prefill 3 keeps quality checks fast and cheap. You are billed per persisted provider.", "default": 100 }, "enrichDetails": { "title": "Enrich profile details", "type": "boolean", "description": "When true (default), open each listing profile for phone, address, website, services, and badges. When false, return lighter listing cards only (cheaper provider-found event). Direct profile startUrls are always enriched.", "default": true }, "includeReviews": { "title": "Include review previews", "type": "boolean", "description": "Attach up to maxReviewsPerProvider public review excerpts when Angi exposes them. Not a full review archive. Default false.", "default": false }, "maxReviewsPerProvider": { "title": "Max reviews per provider", "minimum": 0, "maximum": 25, "type": "integer", "description": "Maximum review excerpts to attach when includeReviews is true. Default 5.", "default": 5 }, "minRating": { "title": "Minimum star rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Skip providers below this average star rating (0–5). Default 0 (no filter). Providers with no published rating are excluded when a minimum is set.", "default": 0 }, "requirePhone": { "title": "Require public phone", "type": "boolean", "description": "Skip profiles with no public phone number. Does not unlock Angi-gated numbers. Default false.", "default": false }, "maxPagesPerListing": { "title": "Max listing pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum companylist pages to paginate per seed URL. Default 5.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify RESIDENTIAL US is required. Datacenter proxies are Cloudflare-blocked on angi.com. Override only if you know what you are doing.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } }, "storeRawSample": { "title": "Store raw page sample (debug)", "type": "boolean", "description": "Developer/debug option. Saves the first listing and profile HTML plus __NEXT_DATA__ to the key-value store. Leave off for normal runs.", "default": 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 } } } } } } } } } }