Core APIs
Product API

Getting Started

7min

Getting Started

Backyard API is an API to retrieve public-domain data from Home Improvement in real-time. You can use Backyard API to retrieve products, reviews, search results and category listings from Home Improvement.

Backyard API returns clean, structured JSON or CSV results. You can achieve fine-grained control over your request using the request parameters.



Retrieving Search Results for Products on Home Improvement

GET /request

Getting search result Home Improvement data with Backyard API is as simple as making an HTTP GET request to the request endpoint. The only required parameters are api_key (sign up for free to get an API key) and type (which defines the type of Home Improvement data you'd like to retrieve).

For example, to retrieve search results ( type=search ) for the search term lawn mower , ordered by best selling products ( sort_by=best_seller ) the Backyard API request would be:

HTTP
Curl
Node.js
Python
PHP


To view Backyard API JSON results clearly in your browser we recommend these extensions for Chrome and Firefox

The search results are shown below within the search_results array. For full documentation on the search results response see the Search Results docs.

JSON


Response Times & Concurrency Backyard API gathers data in real-time and will typically return a result in 1-6 seconds. Please inspect the HTTP Response Code and update your app accordingly.

If you need to run large volumes of requests consider using the Collections API. Collections allow you to enqueue up to 15,000 requests, run them manually or on a schedule and execute them concurrently on Backyard API's infrastructure.



Getting Data for an Individual Product

GET /request

Lets say we want to change our query to request a different type of data - information on a specific product, in this case the product with Item ID 317061059 . Here's the Backyard API request to achieve that:

HTTP
Curl
Node.js
Python
PHP


The result of the Product request is shown below. For full documentation on Product results see the Product Results docs.

JSON


Localizing Results to a Zipcode Backyard API allows you to retrieve results as they would be seen by a user in a given zipcode by specifying the zipcode or postal code in the customer_zipcode request parameter.

For example, to request results as they would be seen by a user in US zipcode 77001 you should append the customer_zipcode=77001 request parameter.


Updated 08 Aug 2024
Did this page help you?