Common

common parameters get get /request the following parameters are used to configure your request to the home improvement product data api they should be appended as querystring parameters to a get http request to the /request endpoint for example, to request search results, for the search term highlighter pens , sorted by best seller , on homedepot com 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; ?> request specific parameters additional parameters are available depending on the type of request being made (as determined by the type parameter) for example, if you make a request with type=reviews then additional reviews parameters https //docs trajectdata com/backyardapi/home improvement product data api/parameters/reviews , specific to reviews requests, are available common parameters the following common parameters are required for all requests to the home improvement product data api parameter required description api key required the api key for your backyard api account engine required the engine of home improvement data to retrieve, for example homedepot type required the type of home improvement data to retrieve the value of the type parameter determines which additional parameters are available for example, if you make a request with type=search then additional search parameters https //docs trajectdata com/backyardapi/home improvement product data api/parameters/search , specific to search requests, are available valid values for type are search request search results for a search term or home improvement search results page url see additional search parameters https //docs trajectdata com/backyardapi/home improvement product data api/parameters/search category request category listing results for a category id or home improvement search results page url see additional category parameters https //docs trajectdata com/backyardapi/home improvement product data api/parameters/category product request data from a home improvement product page via an item id or home improvement product page url see additional product parameters https //docs trajectdata com/backyardapi/home improvement product data api/parameters/product reviews request customer reviews for an item id or home improvement product page url see additional reviews parameters https //docs trajectdata com/backyardapi/home improvement product data api/parameters/reviews questions request customer questions & answers for an item id or home improvement product page url see additional questions parameters https //docs trajectdata com/backyardapi/home improvement product data api/parameters/questions customer zipcode optional determines the specific customer zipcode location of the request this is useful to see in store pricing for a particular location to use the customer zipcode parameter you must first setup the zipcode in the zipcodes section https //app backyardapi com/zipcodes of the dashboard for more information please see the customer zipcode reference https //docs trajectdata com/backyardapi/zipcodes api/overview output optional determines the format in which results are returned can be set to json (default) to get the results as structured json, html to get the raw html retrieved or csv to return the results in csv format when using csv you can also use the csv fields parameter to specify which fields to return in the csv csv fields optional determines the fields that are returned when returning in csv mode (i e when the output parameter is set to csv ) should be specified as a comma seperated list of fields (in nested field, dot notation, format) for more information on the csv fields parameter please see the csv fields reference https //docs trajectdata com/backyardapi/home improvement product data api/reference/csv fields include fields optional a comma seperated list json field names to include in the json object the api returns you can specify the field names in dot notation i e include fields=pagination will only include the the pagination property in the response json use include fields if you only want to include specific fields in the api's json response exclude fields optional a comma seperated list of json field names to exclude from the json object the api returns you can specify the field names in dot notation i e exclude fields=pagination will remove the pagination property from the response json use exclude fields if there are specific fields you wish to exclude from the api's json response next steps search parameters https //docs trajectdata com/backyardapi/home improvement product data api/parameters/search category parameters https //docs trajectdata com/backyardapi/home improvement product data api/parameters/category product parameters https //docs trajectdata com/backyardapi/home improvement product data api/parameters/product reviews parameters https //docs trajectdata com/backyardapi/home improvement product data api/parameters/reviews