{ "openapi": "3.0.1", "info": { "title": "Houzz Scraper", "description": "Scrape Houzz professionals directory. Extract interior designers, architects, contractors, and home improvement pros with reviews, ratings, contact info, social links, badges, and more. Filter by 15 categories, location, style, budget, and rating. Export to CSV, Excel, or JSON.", "version": "1.0", "x-build-id": "gXiOEgX7bnepPFJY2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~houzz-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-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/parseforge~houzz-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-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/parseforge~houzz-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-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": { "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of professionals to scrape", "default": 50 }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Direct URLs to Houzz professional listing pages. If provided, filters are ignored.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "category": { "title": "Professional Category", "enum": [ "architects", "interior-designers", "general-contractors", "landscape-architects", "kitchen-bathroom-designers", "design-build-firms", "swimming-pool-builders", "landscape-contractors", "home-builders", "bathroom-remodelers", "decks-patios", "painters", "countertop-installers", "tile-stone-countertops", "kitchen-remodelers" ], "type": "string", "description": "Type of professional to search for", "default": "interior-designers" }, "location": { "title": "Location", "type": "string", "description": "City or area to search in (e.g., 'New York', 'Los Angeles')" }, "style": { "title": "Design Style", "enum": [ "asian", "contemporary", "eclectic", "modern", "traditional", "tropical", "mediterranean", "coastal", "rustic", "transitional", "industrial", "farmhouse", "mid-century-modern", "craftsman", "southwestern", "scandinavian", "victorian" ], "type": "string", "description": "Filter by design style preference" }, "budget": { "title": "Budget Level", "enum": [ "budget", "low-mid", "mid-high", "premium" ], "type": "string", "description": "Filter by budget level" }, "highlight": { "title": "Professional Highlights", "enum": [ "best-of-houzz", "locally-owned", "family-owned", "free-consultation", "free-estimate", "references-available", "eco-friendly", "evening-consultations", "weekend-consultations", "online-consultation", "woman-owned", "custom-work", "hired-on-houzz", "verified-hires", "responds-quickly", "3d-visualization" ], "type": "string", "description": "Filter by professional highlights/badges" }, "language": { "title": "Language", "enum": [ "spanish", "french", "german", "italian", "chinese", "portuguese", "russian", "japanese" ], "type": "string", "description": "Filter by language spoken" }, "rating": { "title": "Minimum Rating", "enum": [ "3+", "4+", "5" ], "type": "string", "description": "Filter by minimum star rating" }, "serviceType": { "title": "Service Type", "enum": [ "color-consulting", "floor-plans", "holiday-decorating", "lighting-design", "nursery-design", "playroom-design", "space-planning", "sustainable-design", "bedroom-design", "design-consultation" ], "type": "string", "description": "Filter by specific service offered" }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy configuration for the scraper", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }