{ "openapi": "3.0.1", "info": { "title": "HomeGuide Scraper", "description": "Scrape public HomeGuide.com home-services professional directory and provider profile pages. Extract business name, address, geo, ratings, reviews, services, payment methods, and operating hours from US local home-service pros (cleaning, plumbing, HVAC, contractors, electricians, landscaping, etc.).", "version": "1.0", "x-build-id": "cct74yHJ5fgYjG44p" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~homeguide-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-homeguide-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/crawlerbros~homeguide-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-homeguide-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/crawlerbros~homeguide-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-homeguide-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": { "mode": { "title": "Scrape mode", "enum": [ "byUrls", "byCategory", "byLocation" ], "type": "string", "description": "Which discovery axis to use. byUrls: direct URLs. byCategory: a category page (national or state/city scoped). byLocation: a US state or state+city, optionally narrowed by category.", "default": "byCategory" }, "urls": { "title": "URLs (byUrls mode)", "type": "array", "description": "Direct HomeGuide URLs (category, location, or provider profile).", "default": [], "items": { "type": "string" } }, "category": { "title": "Category (byCategory / byLocation modes)", "enum": [ "", "appliance-repair", "architects", "artificial-turf-installation", "asphalt-pavers", "basement-remodeling", "bathroom-remodeling", "cabinet-makers", "carpenters", "carpet-cleaning", "central-air-conditioning-installation", "central-air-conditioning-repair", "chimney-cleaning", "cleaning-services", "computer-repair", "concrete-contractors", "construction-companies", "countertop-installation", "deck-and-porch-build", "dog-boarding", "dog-grooming", "dog-training", "door-installation", "dryer-repair", "dryer-vent-cleaning", "drywall-repair", "duct-cleaning", "electrical-repair", "electricians", "excavating-contractors", "exterior-painting", "fence-installation", "fence-repair", "flooring-installation", "furnace-repair", "furniture-repair", "garage-door-repair", "general-contractors", "gutter-cleaning", "gutter-installation", "handyman", "hardwood-floor-installation", "hardwood-floor-refinishing", "home-improvement", "home-inspectors", "home-remodeling", "home-repair", "house-cleaning", "house-foundation-repair-contractors", "hvac-companies", "hvac-installation", "hvac-repair", "insulation-contractors", "interior-designers", "interior-painting", "kitchen-remodeling", "land-surveyors", "landscaping", "lawn-care", "lawn-mowing", "locksmiths", "masonry-contractors", "moving-companies", "new-home-building", "painting-contractors", "patios", "pest-control", "plumbers", "plumbing-repair", "pressure-washing", "roof-repair", "roofing", "septic-tank-cleaning", "siding-contractors", "solar-panel-installation", "sprinkler-systems-repair", "swimming-pool-cleaning", "swimming-pool-repair", "tile-installation", "tree-removal", "tree-trimming", "waste-and-junk-removal", "window-cleaning", "window-installation", "window-repair" ], "type": "string", "description": "Home-service category slug. Required for byCategory; optional for byLocation.", "default": "house-cleaning" }, "stateCode": { "title": "US state (byLocation mode)", "enum": [ "", "ak", "al", "ar", "az", "ca", "co", "ct", "dc", "de", "fl", "ga", "hi", "ia", "id", "il", "in", "ks", "ky", "la", "ma", "md", "me", "mi", "mn", "mo", "ms", "mt", "nc", "nd", "ne", "nh", "nj", "nm", "nv", "ny", "oh", "ok", "or", "pa", "ri", "sc", "sd", "tn", "tx", "ut", "va", "vt", "wa", "wi", "wv", "wy" ], "type": "string", "description": "Two-letter US state code; required when mode=byLocation.", "default": "ny" }, "city": { "title": "City slug (byLocation mode)", "type": "string", "description": "Lowercase, hyphenated city slug (e.g. 'new-york', 'los-angeles', 'brooklyn'). Optional; if blank, scrapes the state-level page.", "default": "brooklyn" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on emitted records.", "default": 25 }, "maxPagesPerListing": { "title": "Max listing pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum paginated listing pages (?page=N) to crawl per category/location URL. HomeGuide returns ~10 pros per page.", "default": 3 }, "fetchProfileDetails": { "title": "Fetch profile details", "type": "boolean", "description": "Fetch each provider's profile page for richer data (address, hours, services, full reviews). Adds 1 HTTP request per provider.", "default": true }, "maxReviewsPerProfile": { "title": "Max reviews per profile", "minimum": 0, "maximum": 200, "type": "integer", "description": "Max reviews to keep on each provider record (when fetchProfileDetails=true).", "default": 20 }, "useProxy": { "title": "Use Apify proxy", "type": "boolean", "description": "Route HTTP requests through Apify proxy. HomeGuide is generally accessible without a proxy from datacenter IPs; enable only if you see 503s.", "default": false }, "autoEscalateOnBlock": { "title": "Auto-escalate on block", "type": "boolean", "description": "If a 503/Cloudflare challenge appears, automatically retry with a fresh proxy session and a delay.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy configuration. Used only when useProxy is enabled.", "default": { "useApifyProxy": true, "apifyProxyGroups": [] } } } }, "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 } } } } } } } } } }