{ "openapi": "3.0.1", "info": { "title": "Houzz Pros Scraper", "description": "Scrape Houzz professionals and products with contact, rating, and price data.", "version": "0.1", "x-build-id": "RdLyU8QTotFGg7Tcp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/khadinakbar~houzz-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-khadinakbar-houzz-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~houzz-scraper/runs": { "post": { "operationId": "runs-sync-khadinakbar-houzz-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~houzz-scraper/run-sync": { "post": { "operationId": "run-sync-khadinakbar-houzz-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": "Professional category", "type": "string", "description": "The Houzz professional type to search, e.g. 'general contractor', 'interior designer', 'kitchen and bathroom remodeler', 'architect', 'landscape architect'. Free text — slugified automatically to the Houzz directory. Leave blank only if you pass startUrls instead." }, "location": { "title": "Location", "type": "string", "description": "City and state/region to filter professionals, e.g. 'New York, NY' or 'Austin, TX'. Encoded to Houzz's 'City--ST' URL form automatically. Leave blank for a nationwide search. Ignored when startUrls are supplied." }, "startUrls": { "title": "Start URLs (advanced)", "type": "array", "description": "Optional list of exact Houzz URLs to scrape directly: professional directory listings (/professionals/...) or individual pro profiles (/professionals/...-pfvwus-pf~ID). When provided, these override category/location. Accepts plain strings or {\"url\": \"...\"} objects.", "items": { "type": "string" } }, "enrichDetails": { "title": "Enrich from profile pages", "type": "boolean", "description": "Listing pages already include phone, address, rating, reviews and a description. Set this true to additionally open each pro's profile page for the official business website, services provided, areas served, awards, license number, a featured review, and a review-aspect breakdown (billed at the higher enriched-result rate). Default false — listing data alone is complete for basic lead-gen.", "default": false }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Hard cap on the number of professionals pushed (and charged) in one run. Range 1-2000, default 50. The run stops and never charges beyond this number. Use a small value first to preview output and cost.", "default": 50 }, "proxyCountry": { "title": "Proxy country", "type": "string", "description": "Two-letter country code for the residential proxy exit, e.g. 'US', 'GB', 'CA', 'AU'. Defaults to 'US'. Match this to the Houzz market you want. Residential proxies are required — Houzz (PerimeterX) blocks datacenter IPs.", "default": "US" }, "maxRequestRetries": { "title": "Max request retries", "minimum": 1, "maximum": 15, "type": "integer", "description": "How many times a blocked or failed page is retried with a fresh session before giving up. Default 8 (Houzz uses PerimeterX, so retries matter). Range 1-15. Higher values raise reliability but also compute cost on hard blocks.", "default": 8 } } }, "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 } } } } } } } } } }