Home Depot Canada
Pricing
Pay per event
Go to Apify Store
Home Depot Canada
Extract product listings, prices, and store availability from Home Depot Canada.
Home Depot Canada
Pricing
Pay per event
Extract product listings, prices, and store availability from Home Depot Canada.
You can access the Home Depot Canada programmatically from your own applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in API & Integrations in Apify Console.
{ "openapi": "3.0.1", "info": { "version": "1.3", "x-build-id": "k5FxS6b19UeaWGiNf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/canadesk~homedepot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-canadesk-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/canadesk~homedepot/runs": { "post": { "operationId": "runs-sync-canadesk-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/canadesk~homedepot/run-sync": { "post": { "operationId": "run-sync-canadesk-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": { "mode": { "title": "Operation", "enum": [ "search", "product" ], "type": "string", "description": "Search Home Depot Canada or look up a product's store buybox information by product code.", "default": "search" }, "queries": { "title": "Search several keywords", "type": "array", "description": "Optional list of up to 100 inputs in one run. Replaces the single input and selects its corresponding operation. Use only one batch list.", "items": { "type": "string" } }, "query": { "title": "Search keywords", "type": "string", "description": "Required in Search products mode. Use up to 120 characters." }, "productIds": { "title": "Product codes", "type": "array", "description": "Optional list of up to 100 inputs in one run. Replaces the single input and selects its corresponding operation. Use only one batch list.", "items": { "type": "string" } }, "productId": { "title": "Product code", "pattern": "^\\d{6,20}$", "type": "string", "description": "Required in Product lookup mode. Enter one 6 to 20 digit Home Depot Canada product code." }, "storeId": { "title": "Home Depot store ID", "pattern": "^\\d{1,8}$", "type": "string", "description": "Store used for local prices, stock and aisle information. The default is store 7058.", "default": "7058" }, "maxResults": { "title": "Maximum results", "minimum": 1, "type": "integer", "description": "Maximum real records across the entire run, shared by all inputs.", "default": 100 }, "maxResultsPerInput": { "title": "Maximum results per input", "minimum": 1, "type": "integer", "description": "Optional limit per batch input, within the run-wide Maximum results limit. Inputs are processed in order." }, "lang": { "title": "Language", "enum": [ "en", "fr" ], "type": "string", "description": "Language sent to Home Depot Canada for product search and buybox data.", "default": "en" }, "includeDetails": { "title": "Add store buybox details to search results", "type": "boolean", "description": "Request store-specific currency, inventory, aisle/bay and fulfillment information for each search result. A detail error is reported while preserving the search result.", "default": false }, "pageSize": { "title": "Results per page", "minimum": 1, "maximum": 40, "type": "integer", "description": "Number of search products to request per page (1 to 40).", "default": 40 }, "maxPages": { "title": "Maximum pages", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum search pages to read. Product lookup uses one request regardless of this value.", "default": 1 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "The sample uses a Canadian residential proxy, which worked in our Apify checks. You can change this routing; direct cloud requests may be blocked." } } }, "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 } } } } } } } } }}OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for Home Depot Canada from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients: