{ "openapi": "3.0.1", "info": { "title": "Houzz Pro Directory Finder by City & Category", "description": "Find Houzz contractors, architects, and designers by city and category across 16 countries, with ratings, reviews, hires, services, license status, and location for each professional.", "version": "1.0", "x-build-id": "TRlqaqbv6wYcl6cdj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dataspryva~houzz-pro-directory-finder-by-city-and-category/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dataspryva-houzz-pro-directory-finder-by-city-and-category", "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/dataspryva~houzz-pro-directory-finder-by-city-and-category/runs": { "post": { "operationId": "runs-sync-dataspryva-houzz-pro-directory-finder-by-city-and-category", "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/dataspryva~houzz-pro-directory-finder-by-city-and-category/run-sync": { "post": { "operationId": "run-sync-dataspryva-houzz-pro-directory-finder-by-city-and-category", "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": "Mode", "enum": [ "search", "byUrls", "profiles", "reviews", "photos" ], "type": "string", "description": "What to scrape. `search` builds a directory from country + city + profession; `byUrls` reads directory URLs; `profiles` reads profile URLs; `reviews` emits review rows; `photos` browses photo inspiration.", "default": "search" }, "country": { "title": "Country", "enum": [ "us", "ca", "uk", "ie", "au", "nz", "de", "fr", "it", "es", "in", "sg", "jp", "dk", "se", "ru" ], "type": "string", "description": "Houzz market used for search and profile URLs.", "default": "us" }, "city": { "title": "City", "type": "string", "description": "City or city + state to search, e.g. `Los Angeles, CA`, `London`, `Berlin`. Used with profession or categorySlug in search mode.", "default": "Los Angeles, CA" }, "profession": { "title": "Profession", "enum": [ "general-contractor", "architect", "interior-designer", "kitchen-bath", "home-builder", "design-build", "landscape", "painter", "roofer", "flooring", "tile-stone", "cabinet-maker", "carpenter", "pool-spa", "windows-doors", "home-stager" ], "type": "string", "description": "Universal profession mapped to the selected market's Houzz category. Used in search mode.", "default": "general-contractor" }, "categorySlug": { "title": "Category slug override", "type": "string", "description": "Exact Houzz category slug, used instead of the mapped profession, e.g. `general-contractor`, `architekten`, `architectes`. Use a direct directory URL if you are unsure.", "default": "" }, "keyword": { "title": "Keyword", "type": "string", "description": "Optional keyword filter for professional search, or the search term for photo mode.", "default": "" }, "sortBy": { "title": "Sort professionals by", "enum": [ "relevance", "reviews", "rating", "distance" ], "type": "string", "description": "Server-side order for professional directory results.", "default": "relevance" }, "minRating": { "title": "Minimum rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Drop professionals below this star rating. Set 0 to keep all.", "default": 0 }, "minReviewCount": { "title": "Minimum review count", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Drop professionals with fewer reviews. Set 0 to keep all.", "default": 0 }, "directoryUrls": { "title": "Directory URLs", "type": "array", "description": "Houzz professional directory, category or search-result URLs. All live markets and localised paths are accepted.", "default": [], "items": { "type": "string" } }, "profileUrls": { "title": "Profile URLs", "type": "array", "description": "Direct Houzz professional profile URLs, including localised paths such as /experten/, /professionnels/ and /profesionales/.", "default": [], "items": { "type": "string" } }, "photoUrls": { "title": "Photo URLs", "type": "array", "description": "Direct Houzz photo detail URLs. Use mode=photos.", "default": [], "items": { "type": "string" } }, "photoCategory": { "title": "Photo room", "enum": [ "kitchen", "bathroom", "bedroom", "living-room", "dining-room", "outdoor", "baby-kids", "home-office", "storage-closet", "exterior", "basement", "entry", "garage-shed", "gym", "home-bar", "hallway", "laundry", "staircase", "wine-cellar", "all-rooms" ], "type": "string", "description": "Room category for photo inspiration browsing. Use keyword to search instead.", "default": "kitchen" }, "photoStyle": { "title": "Photo style", "enum": [ "", "asian", "contemporary", "eclectic", "modern", "traditional", "tropical", "mediterranean", "coastal", "rustic", "transitional", "industrial", "farmhouse", "mid-century-modern", "craftsman", "southwestern", "shabby-chic-style", "scandinavian", "victorian", "french-country" ], "type": "string", "description": "Optional design style filter for photo inspiration.", "default": "" }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Attach review history to each professional record.", "default": false }, "maxReviewsPerPro": { "title": "Max reviews per professional", "minimum": 0, "maximum": 1024, "type": "integer", "description": "Review cap per professional. Set 0 to fetch the full history (up to 1,024).", "default": 20 }, "fetchDetails": { "title": "Fetch full profiles", "type": "boolean", "description": "Open each professional profile for services, awards, socials, counts and licensing. Turn off for directory-card-only records.", "default": true }, "fetchPhotoDetails": { "title": "Fetch photo details", "type": "boolean", "description": "Open each photo for full image sizes, owner, location and question count.", "default": false }, "enrichEmails": { "title": "Enrich contact emails", "type": "boolean", "description": "Best-effort email lookup on each professional's own website. Adds requests and is optional.", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on emitted records.", "default": 25 }, "maxPages": { "title": "Max pages", "minimum": 0, "maximum": 500, "type": "integer", "description": "Optional page cap. Set 0 to use the source ceiling: 100 directory pages, 30 keyword pages, 250 photo pages or 10 photo keyword pages.", "default": 0 } } }, "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 } } } } } } } } } }