{ "openapi": "3.0.1", "info": { "title": "Houzz Scraper", "description": "Scrape public Houzz professional directory and profile pages. Extract business details, ratings, reviews, hires, services, location data, and profile URLs from Houzz contractors and design professionals.", "version": "1.0", "x-build-id": "OnbdtKIxWh86K5VaD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~houzz-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-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/crawlerbros~houzz-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-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/crawlerbros~houzz-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-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": { "directoryUrls": { "title": "Directory URLs", "type": "array", "description": "Houzz directory or category URLs, such as a contractor directory filtered by city. Used directly without modification.", "default": [ "https://www.houzz.com/professionals/general-contractors/c/Los-Angeles--CA" ], "items": { "type": "string" } }, "profileUrls": { "title": "Profile URLs", "type": "array", "description": "Direct Houzz professional profile URLs.", "default": [], "items": { "type": "string" } }, "city": { "title": "City (optional, used with category to build a directory URL)", "type": "string", "description": "City + state slug for the byCategory mode, e.g. 'Los-Angeles--CA', 'New-York--NY', 'Chicago--IL'. When set together with `category`, the actor builds a directory URL automatically.", "default": "" }, "category": { "title": "Professional category (optional, used with city)", "enum": [ "", "general-contractors", "architects-and-building-designers", "interior-designers-and-decorators", "kitchen-and-bath-designers", "kitchen-and-bath-remodelers", "design-build-firms", "home-builders", "landscape-contractors", "landscape-architects-and-designers", "tile-and-stone-contractors", "carpenters", "cabinets-and-cabinetry", "hardwood-flooring-dealers", "custom-closet-designers", "basement-remodelers", "decks-and-patios", "fencing-and-gates", "driveways-and-paving", "pools-and-spas", "painters", "roofing-and-gutters", "professional-organizers", "home-stagers", "windows", "furniture-and-accessories" ], "type": "string", "description": "Houzz professional category slug. When set together with `city`, the actor builds a directory URL automatically.", "default": "" }, "country": { "title": "Country (Houzz domain)", "enum": [ "us", "uk", "ca", "au", "de", "fr", "ie", "it", "es", "nz", "in", "sg", "jp", "ru", "dk", "se" ], "type": "string", "description": "Houzz market/country domain to use when building directory URLs from `city` + `category`. Defaults to the US site (www.houzz.com).", "default": "us" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 250, "type": "integer", "description": "Hard cap on emitted Houzz professional records.", "default": 25 }, "useProxy": { "title": "Use Apify proxy", "type": "boolean", "description": "Route requests through Apify rotating proxy. Recommended for cloud runs — Houzz blocks known datacenter IP ranges without proxy rotation.", "default": false }, "autoEscalateOnBlock": { "title": "Auto-escalate on block", "type": "boolean", "description": "If a profile fetch is blocked, automatically retry with residential Apify proxy. The directory-card data is still emitted as a fallback.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration (advanced)", "type": "object", "description": "Optional Apify proxy configuration. Only used when `useProxy` is enabled. Leave empty to let `useProxy` + `autoEscalateOnBlock` pick sane defaults.", "default": {} } } }, "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 } } } } } } } } } }