{ "openapi": "3.0.1", "info": { "title": "Home Depot Browser", "description": "πŸ’« All-in-One Homedepot.com Scraper", "version": "0.1", "x-build-id": "DLmNBoBbGtJwHURdr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jupri~homedepot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jupri-homedepot", "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/jupri~homedepot/runs": { "post": { "operationId": "runs-sync-jupri-homedepot", "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/jupri~homedepot/run-sync": { "post": { "operationId": "run-sync-jupri-homedepot", "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": { "prompt": { "title": "✨ Prompt", "type": "string", "description": "" }, "query": { "title": "❓ Query", "type": "array", "description": "πŸ’‘ QUERY, Search Terms or URL (consult README for more details)", "items": { "type": "string" } }, "example": { "title": "πŸ’‘ Examples", "enum": [ "starship engines", "321639489", "321639489/reviews", "N-5yc1vZaq1w", "stores:New York", "store:2406", "store:2406/reviews", "store:2406/content", "https://www.homedepot.com/s/egg" ], "type": "string", "description": "πŸ’‘Query Examples" }, "operation": { "title": "πŸ”Ž Operation", "enum": [ "products", "collections", "stores" ], "type": "string", "description": "" }, "limit": { "title": "♾️ Limit", "type": "integer", "description": "Number of results (max=768)" }, "map_viewer": { "title": "🌍️ Generate Map Viewer", "type": "boolean", "description": "" }, "include_details": { "title": "Product Details", "type": "boolean", "description": "πŸ’‘ Crawl for products detail info." }, "store_id": { "title": "Store", "type": "string", "description": "πŸ’‘ Store Location: Zip Code, City, State, Store ID or LATITUDE,LONGITUDE" }, "store_features": { "title": "Store Features", "type": "array", "description": "πŸ’‘ Store Filters", "items": { "type": "string", "enum": [ "appliance_showroom", "expanded_flooring_showroom", "wifi", "key_cutting", "load_and_go", "propane", "tool_rental", "penske" ], "enumTitles": [ "Expanded Appliance Showroom", "Expanded Flooring Showroom", "Free WiFi", "Key Cutting", "Load n Go", "Propane", "Tool Rental Center", "Penske Truck Rental" ] } }, "zip_code": { "title": "Zip Code", "type": "string", "description": "Delivery Location" }, "sort": { "title": "Sorting", "enum": [ "best-match", "popular", "top-sellers", "price-low", "price-high", "top-rated" ], "type": "string", "description": "" }, "rating": { "title": "Stars", "enum": [ "5", "4", "3", "2", "1" ], "type": "string", "description": "" }, "min_price": { "title": "Price Range", "type": "integer", "description": "" }, "max_price": { "title": "", "type": "integer", "description": "" }, "style": { "title": "Style", "type": "array", "description": "", "items": { "type": "string", "enum": [ "art-deco", "bohemian", "classic", "coastal", "cottage", "farmhouse", "glam", "industrial", "mid-century-modern", "mission", "modern", "rustic", "vintage" ], "enumTitles": [ "Art Deco", "Bohemian", "Classic", "Coastal", "Cottage", "Farmhouse", "Glam", "Industrial", "Mid-Century Modern", "Mission", "Modern", "Rustic", "Vintage" ] } }, "color": { "title": "Color", "type": "array", "description": "", "items": { "type": "string", "enum": [ "aqua", "beige", "black", "blue", "blush", "brown", "copper", "cream", "gold", "gray", "green", "orange", "pink", "purple", "red", "silver", "tan", "white", "wood", "yellow" ], "enumTitles": [ "Aqua", "Beige", "Black", "Blue", "Blush", "Brown", "Copper", "Cream", "Gold", "Gray", "Green", "Orange", "Pink", "Purple", "Red", "Silver", "Tan", "White", "Wood", "Yellow" ] } }, "room": { "title": "Room", "type": "array", "description": "", "items": { "type": "string", "enum": [ "bathroom", "bedroom", "closet", "dining-room", "dorm-room", "entryway", "garage", "home-office", "kids-room", "kitchen", "laundry-room", "living-room", "outdoor" ], "enumTitles": [ "Bathroom", "Bedroom", "Closet", "Dining Room", "Dorm Room", "Entryway", "Garage", "Home Office", "Kids Room", "Kitchen", "Laundry Room", "Living Room", "Outdoor" ] } }, "review_sort": { "title": "Sorting", "enum": [ "photoreview", "mosthelpfull", "oldest", "newest", "highestrating", "lowestrating" ], "type": "string", "description": "πŸ’‘ Reviews sorting" }, "review_search": { "title": "Search", "type": "string", "description": "πŸ’‘ Review search" }, "review_stars": { "title": "Ratings", "type": "array", "description": "πŸ’‘ Star ratings", "items": { "type": "string", "enum": [ "5", "4", "3", "2", "1" ], "enumTitles": [ "5 ⭐⭐⭐⭐⭐", "4 ⭐⭐⭐⭐", "3 ⭐⭐⭐", "2 ⭐⭐", "1 ⭐" ] } }, "review_verified": { "title": "", "type": "boolean", "description": "" }, "review_profile": { "title": "Profile", "type": "array", "description": "πŸ’‘ [Store Reviews] Home Improvement Profile", "items": { "type": "string", "enum": [ "DIYer", "Professional" ] } }, "review_gender": { "title": "Gender", "type": "array", "description": "πŸ’‘ [Store Reviews] Gender", "items": { "type": "string", "enum": [ "Male", "Female" ] } }, "review_age": { "title": "Age Range", "type": "array", "description": "πŸ’‘ [Store Reviews] Age Range", "items": { "type": "string", "enum": [ "18to24", "25to34", "35to44", "45to54", "55to64", "65orOver" ], "enumTitles": [ "18 to 24", "25 to 34", "35 to 44", "45 to 54", "55 to 64", "65 or Over" ] } }, "dev_proxy_config": { "title": "🌐 PROXY NETWORKING", "type": "object", "description": "πŸ’‘ Supported protocol:

HTTP(S), SOCKS5
{http|socks5}://{user:pass}@{hostname|ip-address}:port

Example: socks5://example.com:9000" }, "dev_custom_headers": { "title": "πŸ“œ HTTP HEADERS", "type": "array", "description": "πŸ’‘ Additional HTTP Headers", "items": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "title": "Key" }, "value": { "type": "string", "title": "Value" } } } }, "dev_custom_cookies": { "title": "🍰 HTTP COOKIES", "type": "array", "description": "πŸ’‘ Additional HTTP Cookies", "items": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "title": "Key" }, "value": { "type": "string", "title": "Value" } } } }, "dev_transform_fields": { "title": "♻️ CUSTOM FIELD", "type": "array", "description": "πŸ’‘ Transform the resulting output. Select only needed fields.

For nested object use DOT. For example: 
address.streetAddress

For nested array use NUMBER (index of array element starting from index=0). For example: 
images.0.url
", "items": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "title": "Key" }, "value": { "type": "string", "title": "Value" } } } }, "dev_dataset_name": { "title": "πŸ“ CUSTOM STORAGE", "type": "string", "description": "πŸ’‘ Save results into custom named Dataset, use mask to customize dataset name

{ACTOR} = actor name
{DATE} = date (YYYYMMDD)
{TIME} = time (HHMMSS)

This masks can be used to autogenerate Dataset Name.

example: data-{DATE}
Depending on today date the dataset name will be: data-20230603

default: data-{ACTOR}-{DATE}-{TIME}" }, "dev_dataset_clear": { "title": "Clear Storage", "type": "boolean", "description": "Clear Dataset before insert/update." }, "dev_no_strip": { "title": "Disable data cleansing", "type": "boolean", "description": "πŸ’‘ Keep/Save empty values (NULL, FALSE, empty ARRAY, empty OBJECT, empty STRING)" } } }, "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 } } } } } } } } } }