Core APIs
...
Product API
Parameters

Search

3min
search parameters get get /request the search parameters are applicable when making a request with type=search to retrieve search results from home depot the search term is specified in the search term parameter the parameters should be appended as querystring parameters to the home improvement product data api get http request search results are retrieved from the search results page https //www homedepot com/s/lawn+mower on home depot for example, to request search results for the search term lawn mower , sorted by "best selling products", the request would be http https //api backyardapi com/request?api key=demo\&engine=homedepot\&type=search\&search term=lawn+mower\&sort by=best sellercurl l get https //api backyardapi com/request d api key="demo" d engine="homedepot" d type="search" d search term="lawn mower" d sort by="best seller"const axios = require('axios'); // set up the request parameters const params = { api key "demo", engine "homedepot", type "search", search term "lawn mower", sort by "best seller" } // 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' 'search', 'search term' 'lawn mower', 'sort by' 'best seller' } \# 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' 'search', 'search term' 'lawn mower', 'sort by' 'best seller' ]); \# 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; ?> search parameters the following parameters are available for all requests made when type=search parameter required description engine required the engine of home improvement data to retrieve, for example homedepot search term required a search term to use to search for home improvement items either the search term or url parameter must be supplied sort by optional determines how the results are sorted valid values are best seller sort results by best selling products first most popular sort results by most popular products first price high to low sort results by highest to lowest priced price low to high sort results by lowest to highest priced highest rating sort results by highest rated first min price optional determines the minimum price of results to return, expressed in dollars and cents (i e min price=2 99 for $2 99) max price optional determines the maximum price of results to return, expressed in dollars and cents (i e min price=39 99 for $39 99) page optional the current page of results to retrieve inspect the pagination results property for details on the number of pages available max page optional use the max page parameter to get multiple pages of results in one request the api will automatically paginate through pages and concatenate the results into one response see the pagination https //docs trajectdata com/backyardapi/home improvement product data api/pagination docs for more information url optional the home improvement search results page to retrieve results from note if the url parameter is supplied then all other parameters are ignored as they are overriden be those specified in the url parameter next steps search results https //docs trajectdata com/backyardapi/home improvement product data api/results/search