Core APIs
...
Product API
Parameters
Product
4min
product parameters get get /request the product parameters are applicable when making a request with type=product to retrieve details of a single product on home depot the product is specified using either the item id parameter or the url parameter (where the url parameter contains a link to a home depot product page) the parameters should be appended as querystring parameters to the home improvement product data api get http request product details are retrieved from the product page https //www homedepot com/p/317061059 for a single product on home depot lookup an asin by gtin / isbn / upc / ean backyard api can automatically convert gtin/isbn/upc codes to item ids and return product data for that gtin for details of how to lookup backyard product details by gtin/isbn/upc/ean please see refer to the guide https //docs trajectdata com/backyardapi/home improvement product data api/reference/gtin upc to home improvement item id note that backyard api will cache the gtin to asin mapping for 2 months to force a new gtin lookup (for example, if you suspect the existing mapping is stale), use the skip gtin cache=true request parameter (note that using skip gtin cache=true decrements 2 credits from your balance, instead of 1) for example, to request details a product with item id=317061059 the request would be http https //api backyardapi com/request?api key=demo\&enginge=homedepot\&type=product\&item id=317061059curl l get https //api backyardapi com/request d api key="demo" d engine="homedepot" d type="product" d item id="317061059"const axios = require('axios'); // set up the request parameters const params = { api key "demo", engine "homedepot", type "product", item id "317061059" } // make the http get request to backyard api axios get('https //api backyardapi com/request', { params }) then(response => { // print the json response from backyard api console log(json stringify(response data, 0, 2)); }) catch(error => { // catch and print the error console log(error); })import requests import json \# set up the request parameters params = { 'api key' 'demo', 'engine' 'homedepot', 'type' 'product', 'item id' '317061059' } \# make the http get request to backyard api api result = requests get('https //api backyardapi com/request', params) \# print the json response from backyard api print(json dumps(api result json()))\<?php \# set up the request parameters $querystring = http build query(\[ 'api key' => 'demo', 'engine' 'homedepot', 'type' 'product', 'item id' '317061059' ]); \# make the http get request to backyard api $ch = curl init(sprintf('%s?%s', 'https //api backyardapi com/request', $querystring)); curl setopt($ch, curlopt returntransfer, true); curl setopt($ch, curlopt followlocation, true); \# the following options are required if you're using an outdated openssl version \# more details https //www openssl org/blog/blog/2021/09/13/letsencryptrootcertexpire/ curl setopt($ch, curlopt ssl verifyhost, false); curl setopt($ch, curlopt ssl verifypeer, false); curl setopt($ch, curlopt timeout, 180); $api result = curl exec($ch); curl close($ch); \# print the json response from backyard api echo $api result; ?> product parameters the following parameters are available for all requests made when type=product parameter required description engine required the engine of home improvement data to retrieve, for example homedepot item id optional the home improvement item id to retrieve product details for gtin optional the gtin/isbn/upc code to look up a matching product on home improvement for if the gtin parameter is supplied then the item id parameter is ignored gtin based requests work by looking up the gtin/isbn/upc on home improvement first, then retrieving the product details for the first matching item id url optional the home improvement product page url to retrieve product details from note if the url parameter is supplied then the item id and gtin parameters are ignored (the url overrides other parameters) include html optional determines whether raw html is included in the response (this can increase the size of the response) can be set to true or false (the default) next steps product results https //docs trajectdata com/backyardapi/home improvement product data api/results/product