Getting Started
7 min
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:
https://api.backyardapi.com/request?api_key=demo&engine=homedepot&type=search&search_term=lawn+mower&sort_by=best_sellerThe search results are shown below within the search_results array. For full documentation on the search results response see the Search Results docs.
{
"request_info": {
"success": true,
"credits_used": 1,
"credits_remaining": 999
},
"request_metadata": {
"created_at": "2020-01-01T00:00:00.000Z",
"processed_at": "2020-01-01T00:00:00.000Z",
"total_time_taken": 2.15,
"homedepot_url": "https://www.homedepot.com/s/lawn+mower?NCNI-5"
},
"request_parameters": {
"engine": "homedepot",
"type": "search",
"search_term": "lawn mower",
"sort_by": "best_seller"
},
"search_results": [
{
"position": 1,
"product": {
"title": "Honda 21 in. 3-in-1 Variable Speed Gas Walk Behind Self Propelled Lawn Mower with Auto Choke",
"link": "https://www.homedepot.com/p/Honda-21-in-3-in-1-Variable-Speed-Gas-Walk-Behind-Self-Propelled-Lawn-Mower-with-Auto-Choke-HRN216VKA/314013158",
"is_bestseller": true,
"brand": "Honda",
"favorite_count": 1053,
"item_id": "314013158",
"store_sku": "1004556576",
"model_number": "HRN216VKA",
"images": [
"https://images.thdstatic.com/productImages/b805cb94-f0f9-4800-bf93-2070a92a8704/svn/honda-self-propelled-lawn-mowers-hrn216vka-64_1000.jpg",
"https://images.thdstatic.com/productImages/2da3aa20-c521-4191-8855-32c65af1ec4e/svn/honda-self-propelled-lawn-mowers-hrn216vka-e4_1000.jpg"
],
"primary_image": "https://images.thdstatic.com/productImages/b805cb94-f0f9-4800-bf93-2070a92a8704/svn/honda-self-propelled-lawn-mowers-hrn216vka-64_1000.jpg",
"rating": 4.5,
"ratings_total": 5192,
"collection": {
"id": "Family-312406020",
"name": "Family-312406020",
"link": "https://www.homedepot.com/collection/Outdoors/Honda-Lawn-Mowers-Collection/Family-312406020?omsid=314013158"
},
"features": [
{
"name": "Power Type",
"value": "Gas"
},
{
"name": "Cutting Width (in.)",
"value": "21 inches"
},
{
"name": "Size of Yard",
"value": "1/4 - 1/2 Acre"
},
{
"name": "Engine Make",
"value": "Honda Engine"
},
{
"name": "Features",
"value": "Mulching Lawn Mower"
}
]
},
"fulfillment": {
"pickup": false,
"ship_to_store": true,
"ship_to_home": true,
"scheduled_delivery": false,
"ship_to_store_info": {
"store_id": "6242",
"store_state": "Stamford",
"store_name": "CT",
"stock_level": 2427,
"in_stock": true
},
"ship_to_home_info": {
"in_stock": true,
"stock_level": 9999
}
},
"offers": {
"primary": {
"price": 469,
"regular_price": 549,
"symbol": "$",
"currency": "USD"
}
}
},
{
"position": 2,
"product": {
"title": "RYOBI 40V HP Brushless 20 in. Cordless Battery Walk Behind Push Mower with 6.0 Ah Battery and Charger",
"link": "https://www.homedepot.com/p/RYOBI-40V-HP-Brushless-20-in-Cordless-Battery-Walk-Behind-Push-Mower-with-6-0-Ah-Battery-and-Charger-RY401170VNM/317061059",
"is_bestseller": true,
"is_top_rated": true,
"brand": "RYOBI",
"item_id": "317061059",
"store_sku": "1006431841",
"model_number": "RY401170VNM",
"images": [
"https://images.thdstatic.com/productImages/63e8deea-ed6d-442d-8d0c-5a061c301bff/svn/ryobi-push-lawn-mowers-ry401170vnm-64_1000.jpg",
"https://images.thdstatic.com/productImages/06034308-37ee-4a31-bcc2-94862828c43d/svn/ryobi-push-lawn-mowers-ry401170vnm-e4_1000.jpg"
],
"primary_image": "https://images.thdstatic.com/productImages/63e8deea-ed6d-442d-8d0c-5a061c301bff/svn/ryobi-push-lawn-mowers-ry401170vnm-64_1000.jpg",
"rating": 4.7,
"ratings_total": 835,
"features": [
{
"name": "Power Type",
"value": "Battery"
},
{
"name": "Cutting Width (in.)",
"value": "20 inches"
},
{
"name": "Voltage (v)",
"value": "40v"
},
{
"name": "Size of Yard",
"value": "1/4 - 1/2 Acre"
},
{
"name": "Battery Run Time (min.)",
"value": "48"
}
]
},
"fulfillment": {
"pickup": true,
"ship_to_store": false,
"ship_to_home": true,
"scheduled_delivery": false,
"pickup_info": {
"store_id": "6242",
"store_state": "Stamford",
"store_name": "CT",
"stock_level": 9,
"in_stock": true
},
"ship_to_home_info": {
"in_stock": true,
"stock_level": 9999
}
},
"offers": {
"primary": {
"price": 299,
"symbol": "$",
"currency": "USD"
}
}
},
{
"position": 3,
"product": {
"title": "RYOBI 40V HP Brushless 21 in. Cordless Battery Walk Behind Self-Propelled Lawn Mower with (2) 6.0 Ah Batteries and Charger",
"link": "https://www.homedepot.com/p/RYOBI-40V-HP-Brushless-21-in-Cordless-Battery-Walk-Behind-Self-Propelled-Lawn-Mower-with-2-6-0-Ah-Batteries-and-Charger-RY401140US/314600837",
"is_exclusive": true,
"brand": "RYOBI",
"item_id": "314600837",
"store_sku": "1005788802",
"model_number": "RY401140US",
"images": [
"https://images.thdstatic.com/productImages/6edf6453-7ea4-4e52-9478-b4fc3cf850e6/svn/ryobi-self-propelled-lawn-mowers-ry401140us-64_1000.jpg",
"https://images.thdstatic.com/productImages/06034308-37ee-4a31-bcc2-94862828c43d/svn/ryobi-self-propelled-lawn-mowers-ry401140us-e4_1000.jpg"
],
"primary_image": "https://images.thdstatic.com/productImages/6edf6453-7ea4-4e52-9478-b4fc3cf850e6/svn/ryobi-self-propelled-lawn-mowers-ry401140us-64_1000.jpg",
"rating": 4.5,
"ratings_total": 1766,
"features": [
{
"name": "Cutting Width (in.)",
"value": "21 inches"
},
{
"name": "Power Type",
"value": "Battery"
},
{
"name": "Size of Yard",
"value": "1/2 - 1 Acre"
},
{
"name": "Features",
"value": "Mulching Lawn Mower"
},
{
"name": "Rear Wheel Height (in.)",
"value": "High Wheel"
}
]
},
"fulfillment": {
"pickup": false,
"ship_to_store": true,
"ship_to_home": true,
"scheduled_delivery": false,
"ship_to_store_info": {
"store_id": "6242",
"store_state": "Stamford",
"store_name": "CT",
"stock_level": 408,
"in_stock": true
},
"ship_to_home_info": {
"in_stock": true,
"stock_level": 9999
}
},
"offers": {
"primary": {
"price": 499,
"regular_price": 549,
"symbol": "$",
"currency": "USD"
}
}
},
{
"position": 4,
"product": {
"title": "Toro Flex-Force 22 in. 60-Volt Cordless 2-Tool Combo Kit Recycler Mower & 14 in./16 in. String Trimmer - Charger/2 Batteries",
"link": "https://www.homedepot.com/p/Toro-Flex-Force-22-in-60-Volt-Cordless-2-Tool-Combo-Kit-Recycler-Mower-14-in-16-in-String-Trimmer-Charger-2-Batteries-66351/320792383",
"sponsored": true,
"brand": "Toro",
"item_id": "320792383",
"model_number": "66351",
"images": [
"https://images.thdstatic.com/productImages/a3dd1331-9abd-4908-bde8-d24048693089/svn/toro-self-propelled-lawn-mowers-66351-64_1000.jpg",
"https://images.thdstatic.com/productImages/ea72f0b1-c2dd-4595-b90d-a3bc764953e9/svn/toro-self-propelled-lawn-mowers-66351-e4_1000.jpg"
],
"primary_image": "https://images.thdstatic.com/productImages/a3dd1331-9abd-4908-bde8-d24048693089/svn/toro-self-propelled-lawn-mowers-66351-64_1000.jpg",
"rating": 0,
"ratings_total": 0,
"features": [
{
"name": "Cutting Width (in.)",
"value": "22 inches"
},
{
"name": "Power Type",
"value": "Battery"
},
{
"name": "Size of Yard",
"value": "1/4 - 1/2 Acre"
},
{
"name": "Rear Wheel Height (in.)",
"value": "High Wheel"
},
{
"name": "Drive Type",
"value": "Rear-wheel Drive"
}
]
},
"fulfillment": {
"pickup": false,
"ship_to_store": true,
"ship_to_home": true,
"scheduled_delivery": false,
"ship_to_store_info": {
"store_id": "6242",
"store_state": "Stamford",
"store_name": "CT",
"stock_level": 158,
"in_stock": true
},
"ship_to_home_info": {
"in_stock": true,
"stock_level": 9999
}
},
"offers": {
"primary": {
"price": 798.99,
"symbol": "$",
"currency": "USD"
}
}
},
{
"position": 5,
"product": {
"title": "RYOBI 40V HP Brushless 21 in. Cordless Battery Walk Behind Dual-Blade Self-Propelled Mower with (2) 6.0 Ah Batteries & Charger",
"link": "https://www.homedepot.com/p/RYOBI-40V-HP-Brushless-21-in-Cordless-Battery-Walk-Behind-Dual-Blade-Self-Propelled-Mower-with-2-6-0-Ah-Batteries-Charger-RY401150US/314428494",
"is_top_rated": true,
"is_exclusive": true,
"brand": "RYOBI",
"item_id": "314428494",
"store_sku": "1005788757",
"model_number": "RY401150US",
"images": [
"https://images.thdstatic.com/productImages/ede5f12d-4e02-4de1-8719-c77d0b32f0a8/svn/ryobi-self-propelled-lawn-mowers-ry401150us-64_1000.jpg",
"https://images.thdstatic.com/productImages/06034308-37ee-4a31-bcc2-94862828c43d/svn/ryobi-self-propelled-lawn-mowers-ry401150us-e4_1000.jpg"
],
"primary_image": "https://images.thdstatic.com/productImages/ede5f12d-4e02-4de1-8719-c77d0b32f0a8/svn/ryobi-self-propelled-lawn-mowers-ry401150us-64_1000.jpg",
"rating": 4.4,
"ratings_total": 1078,
"features": [
{
"name": "Cutting Width (in.)",
"value": "21 inches"
},
{
"name": "Power Type",
"value": "Battery"
},
{
"name": "Size of Yard",
"value": "1/2 - 1 Acre"
},
{
"name": "Features",
"value": "Mulching Lawn Mower"
},
{
"name": "Rear Wheel Height (in.)",
"value": "High Wheel"
}
]
},
"fulfillment": {
"pickup": true,
"ship_to_store": false,
"ship_to_home": false,
"scheduled_delivery": true,
"pickup_info": {
"store_id": "6242",
"store_state": "Stamford",
"store_name": "CT",
"stock_level": 4,
"in_stock": true
},
"scheduled_delivery_info": {
"in_stock": false,
"stock_level": 11
}
},
"offers": {
"primary": {
"price": 599,
"symbol": "$",
"currency": "USD"
}
}
}
],
"breadcrumbs": [
{
"name": "Outdoors",
"link": "https://www.homedepot.com/b/Outdoors/N-5yc1vZbx82"
},
{
"name": "Outdoor Power Equipment",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment/N-5yc1vZbx5c"
},
{
"name": "Lawn Mowers",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/N-5yc1vZc5ar"
}
],
"related_queries": [
{
"query": "dewalt cordless screwdriver"
},
{
"query": "dewalt screwdriver"
},
{
"query": "cordless screwdriver"
},
{
"query": "milwaukee electric screwdriver"
},
{
"query": "dewalt gyroscopic screwdriver"
},
{
"query": "cordless electric screwdriver"
},
{
"query": "dewalt drill"
},
{
"query": "electric screwdriver"
}
],
"facets": [
{
"name": "Availability",
"display_name": "Availability",
"values": [
{
"display_name": "Show Unavailable Products",
"value": "bwo5s",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/Show-Unavailable-Products/N-5yc1vZc5arZbwo5s?NCNI-5",
"count": 0,
"active": false
}
]
},
{
"name": "Category",
"display_name": "Category",
"values": [
{
"display_name": "Lawn Mower Parts",
"value": "2fkp8zm",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers-Lawn-Mower-Parts/N-5yc1vZ2fkp8zm",
"count": 341,
"active": false
},
{
"display_name": "Self Propelled Lawn Mowers",
"value": "c5ap",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers-Self-Propelled-Lawn-Mowers/N-5yc1vZc5ap",
"count": 114,
"active": false
},
{
"display_name": "Push Lawn Mowers",
"value": "c5ah",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers-Push-Lawn-Mowers/N-5yc1vZc5ah",
"count": 72,
"active": false
},
{
"display_name": "Reel Lawn Mowers",
"value": "c5av",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers-Reel-Lawn-Mowers/N-5yc1vZc5av",
"count": 20,
"active": false
},
{
"display_name": "Field Mowers",
"value": "c5aq",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers-Field-Mowers/N-5yc1vZc5aq",
"count": 7,
"active": false
},
{
"display_name": "Commercial Lawn Mowers",
"value": "c7gx",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers-Commercial-Lawn-Mowers/N-5yc1vZc7gx",
"count": 6,
"active": false
},
{
"display_name": "Robotic Lawn Mowers",
"value": "c5at",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers-Robotic-Lawn-Mowers/N-5yc1vZc5at",
"count": 6,
"active": false
}
]
},
{
"name": "Battery Run Time (min.)",
"display_name": "Battery Run Time (min.)",
"values": [
{
"display_name": "60",
"value": "1z183mn",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/60/N-5yc1vZc5arZ1z183mn",
"count": 30,
"active": false
},
{
"display_name": "0",
"value": "1z183nb",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/0/N-5yc1vZc5arZ1z183nb",
"count": 18,
"active": false
},
{
"display_name": "40",
"value": "1z183lz",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/40/N-5yc1vZc5arZ1z183lz",
"count": 14,
"active": false
},
{
"display_name": "70",
"value": "1z183mv",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/70/N-5yc1vZc5arZ1z183mv",
"count": 14,
"active": false
},
{
"display_name": "45",
"value": "1z183m1",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/45/N-5yc1vZc5arZ1z183m1",
"count": 8,
"active": false
},
{
"display_name": "0.0",
"value": "1z1czwc",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/00/N-5yc1vZc5arZ1z1czwc",
"count": 7,
"active": false
},
{
"display_name": "43",
"value": "1z1p8ko",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/43/N-5yc1vZc5arZ1z1p8ko",
"count": 7,
"active": false
},
{
"display_name": "30",
"value": "1z183ln",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/30/N-5yc1vZc5arZ1z183ln",
"count": 6,
"active": false
},
{
"display_name": "50",
"value": "1z183mc",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/50/N-5yc1vZc5arZ1z183mc",
"count": 6,
"active": false
},
{
"display_name": "1",
"value": "1z1rutf",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/1/N-5yc1vZc5arZ1z1rutf",
"count": 3,
"active": false
},
{
"display_name": "240",
"value": "1z183ne",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/240/N-5yc1vZc5arZ1z183ne",
"count": 3,
"active": false
},
{
"display_name": "25",
"value": "1z183lf",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/25/N-5yc1vZc5arZ1z183lf",
"count": 3,
"active": false
},
{
"display_name": "120",
"value": "1z183oy",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/120/N-5yc1vZc5arZ1z183oy",
"count": 2,
"active": false
},
{
"display_name": "20",
"value": "1z183lb",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/20/N-5yc1vZc5arZ1z183lb",
"count": 2,
"active": false
},
{
"display_name": "48",
"value": "1z1b6d4",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/48/N-5yc1vZc5arZ1z1b6d4",
"count": 2,
"active": false
},
{
"display_name": "90",
"value": "1z183nn",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/90/N-5yc1vZc5arZ1z183nn",
"count": 2,
"active": false
},
{
"display_name": "0.00",
"value": "1z1narh",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/000/N-5yc1vZc5arZ1z1narh",
"count": 1,
"active": false
},
{
"display_name": "180",
"value": "1z183kp",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/180/N-5yc1vZc5arZ1z183kp",
"count": 1,
"active": false
},
{
"display_name": "42",
"value": "1z1a9wt",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/42/N-5yc1vZc5arZ1z1a9wt",
"count": 1,
"active": false
},
{
"display_name": "75",
"value": "1z183mw",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/75/N-5yc1vZc5arZ1z183mw",
"count": 1,
"active": false
}
]
},
{
"name": "Voltage (v)",
"display_name": "Voltage (v)",
"values": [
{
"display_name": "18v",
"value": "1z17p5w",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/18v/N-5yc1vZc5arZ1z17p5w",
"count": 39,
"active": false
},
{
"display_name": "40v",
"value": "1z17owe",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/40v/N-5yc1vZc5arZ1z17owe",
"count": 27,
"active": false
},
{
"display_name": "60v",
"value": "1z17ozo",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/60v/N-5yc1vZc5arZ1z17ozo",
"count": 26,
"active": false
},
{
"display_name": "36v",
"value": "1z17p7b",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/36v/N-5yc1vZc5arZ1z17p7b",
"count": 18,
"active": false
},
{
"display_name": "120v",
"value": "1z17owx",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/120v/N-5yc1vZc5arZ1z17owx",
"count": 15,
"active": false
},
{
"display_name": "20v",
"value": "1z17otq",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/20v/N-5yc1vZc5arZ1z17otq",
"count": 14,
"active": false
},
{
"display_name": "28v",
"value": "1z17pk4",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/28v/N-5yc1vZc5arZ1z17pk4",
"count": 2,
"active": false
},
{
"display_name": "56v",
"value": "1z17ovl",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/56v/N-5yc1vZc5arZ1z17ovl",
"count": 2,
"active": false
},
{
"display_name": "62v",
"value": "1z1bur8",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/62v/N-5yc1vZc5arZ1z1bur8",
"count": 2,
"active": false
},
{
"display_name": "12v",
"value": "1z17p15",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/12v/N-5yc1vZc5arZ1z17p15",
"count": 1,
"active": false
},
{
"display_name": "80v",
"value": "1z1c2pv",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/80v/N-5yc1vZc5arZ1z1c2pv",
"count": 1,
"active": false
}
]
},
{
"name": "Engine Make",
"display_name": "Engine Make",
"values": [
{
"display_name": "OEM Branded Engine",
"value": "1z1s3yy",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/OEM-Branded-Engine/N-5yc1vZc5arZ1z1s3yy",
"count": 63,
"active": false
},
{
"display_name": "Briggs and Stratton Engine",
"value": "1z1s3vq",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/Briggs-and-Stratton-Engine/N-5yc1vZc5arZ1z1s3vq",
"count": 35,
"active": false
},
{
"display_name": "Ryobi Engine",
"value": "1z1s477",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/Ryobi-Engine/N-5yc1vZc5arZ1z1s477",
"count": 7,
"active": false
},
{
"display_name": "Honda Engine",
"value": "1z1s3xx",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/Honda-Engine/N-5yc1vZc5arZ1z1s3xx",
"count": 5,
"active": false
},
{
"display_name": "Troy-Bilt Engine",
"value": "1z1s4cc",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/Troy-Bilt-Engine/N-5yc1vZc5arZ1z1s4cc",
"count": 2,
"active": false
},
{
"display_name": "Kawasaki Engine",
"value": "1z1s49r",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/Kawasaki-Engine/N-5yc1vZc5arZ1z1s49r",
"count": 1,
"active": false
},
{
"display_name": "Stanley Engine",
"value": "1z1t3pz",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/Stanley-Engine/N-5yc1vZc5arZ1z1t3pz",
"count": 1,
"active": false
}
]
}
],
"pagination": {
"total_results": 562,
"total_pages": 24,
"current": {
"page": 1,
"link": "https://www.homedepot.com/s/lawn%20mower?NCNI-5"
},
"next": {
"page": 2,
"link": "https://www.homedepot.com/s/lawn%20mower?NCNI-5=&Nao=24"
}
},
"location_info": {
"store_id": "6242",
"store_name": "Stamford",
"zipcode": "06902"
}
}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:
https://api.backyardapi.com/request?api_key=demo&engine=homedepot&type=product&item_id=317061059The result of the Product request is shown below. For full documentation on Product results see the Product Results docs.
{
"request_info": {
"success": true,
"credits_used": 1,
"credits_remaining": 999
},
"request_metadata": {
"created_at": "2020-01-01T00:00:00.000Z",
"processed_at": "2020-01-01T00:00:00.001Z",
"total_time_taken": 0.1,
"homedepot_url": "https://www.homedepot.com/p/317061059"
},
"request_parameters": {
"engine": "homedepot",
"type": "product",
"item_id": "317061059"
},
"product": {
"link": "https://www.homedepot.com/p/RYOBI-40V-HP-Brushless-20-in-Cordless-Battery-Walk-Behind-Push-Mower-with-6-0-Ah-Battery-and-Charger-RY401170VNM/317061059",
"brand": "RYOBI",
"brand_link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers-Push-Lawn-Mowers/RYOBI/N-5yc1vZm5dZc5ah",
"title": "RYOBI 40V HP Brushless 20 in. Cordless Battery Walk Behind Push Mower with 6.0 Ah Battery and Charger",
"upc": "046396037169",
"item_id": "317061059",
"store_sku": "1006431841",
"model_number": "RY401170VNM",
"description": "RYOBI continues to lead the industry in cordless mower innovation with their 40V HP 20 in. Brushless Push Mower. Combining 40V Lithium-Ion Battery power with Brushless Technology this mower delivers gas-like power, without the hassle of gas, oil, or maintenance. The high capacity 6.0 Ah battery provides extended run time and instant power at the push of a button. With the 3-in-1 mowing functions you can choose between bagging, mulching, or side discharge functions right out of the box. Select your ideal grass height with the 7-position single point height adjustment. The easy lift bag removal allows you to quickly and easily empty the grass catcher bag and get back to work. With folding handles, this mower easily folds down when the job is done and can be stored vertically making it ideal for compact spaces.",
"is_bestseller": true,
"is_top_rated": true,
"aisle": "52",
"bay": "011",
"collection": {
"id": "Family-308879048",
"name": "Family-308879048",
"link": "https://www.homedepot.com/collection/Outdoors/RYOBI-40-Volt-Collection/Family-308879048?omsid=317061059"
},
"feature_bullets": [
"Includes 40V 6.0 Ah Battery and a Quick Charger",
"3-in-1 Capable Right Out of the Box",
"Works with All RYOBI 40V Batteries"
],
"feature_bullets_count": 3,
"descriptive_attributes": [
"High performance brushless motor delivers maximum performance for GAS-LIKE POWER",
"Push button for hassle free starting",
"Up to 48-minutes of runtime, ideal for 1/2 acre or less",
"7-position, single-point height adjustment from 1.5 in. to 4 in.",
"3-in-1 mulching, bagging and side discharge capable right out of the box",
"Easy lift bag removal",
"Folding handles for compact vertical storage",
"On-board battery storage compartment for easy battery exchange",
"6.0 Ah high-capacity battery for extended run time",
"Includes quick charger for 2X faster charging",
"5-year tool warranty, 3-year battery warranty"
],
"descriptive_attributes_count": 14,
"images": [
{
"link": "https://images.thdstatic.com/productImages/63e8deea-ed6d-442d-8d0c-5a061c301bff/svn/ryobi-push-lawn-mowers-ry401170vnm-64_1000.jpg",
"type": "primary"
},
{
"link": "https://images.thdstatic.com/productImages/06034308-37ee-4a31-bcc2-94862828c43d/svn/ryobi-push-lawn-mowers-ry401170vnm-e1_1000.jpg",
"type": "image_left_view"
},
{
"link": "https://images.thdstatic.com/productImages/f7b5f873-f7ca-400a-b5df-d7f338743245/svn/ryobi-push-lawn-mowers-ry401170vnm-40_1000.jpg",
"type": "image_right_view"
},
{
"link": "https://images.thdstatic.com/productImages/3da668c3-3d5b-4508-87f6-700c6e6681f3/svn/ryobi-push-lawn-mowers-ry401170vnm-a0_1000.jpg",
"type": "image_top_view"
},
{
"link": "https://images.thdstatic.com/productImages/5317a55a-d3e2-4ff4-a668-d6f45e76752e/svn/ryobi-push-lawn-mowers-ry401170vnm-1d_1000.jpg",
"type": "image_bottom_view"
},
{
"link": "https://images.thdstatic.com/productImages/b7c36076-3358-46fc-9d1e-e51e8c3bd0ac/svn/ryobi-push-lawn-mowers-ry401170vnm-66_1000.jpg",
"type": "image_back_view"
},
{
"link": "https://images.thdstatic.com/productImages/0d2651b9-f713-42d6-a5d5-4503832b7b6a/svn/ryobi-push-lawn-mowers-ry401170vnm-77_1000.jpg",
"type": "image_open_view"
},
{
"link": "https://images.thdstatic.com/productImages/7dfaf8a4-2818-449f-ba88-f0b777999a4b/svn/ryobi-push-lawn-mowers-ry401170vnm-c3_1000.jpg",
"type": "image_alternate_view"
},
{
"link": "https://images.thdstatic.com/productImages/f896c50e-f29d-46be-af2a-9562e3a1722a/svn/ryobi-push-lawn-mowers-ry401170vnm-4f_1000.jpg",
"type": "image_alternate_view_2"
},
{
"link": "https://images.thdstatic.com/productImages/2dad2206-d356-4fb2-8c37-33282dd81476/svn/ryobi-push-lawn-mowers-ry401170vnm-1f_1000.jpg",
"type": "image_alternate_view_3"
},
{
"link": "https://images.thdstatic.com/productImages/cd083757-5d0b-4f8a-8ab6-013c316d3f39/svn/ryobi-push-lawn-mowers-ry401170vnm-44_1000.jpg",
"type": "image_alternate_view_4"
},
{
"link": "https://images.thdstatic.com/productImages/857c441a-b78e-4c61-a8c8-74137f447e83/svn/ryobi-push-lawn-mowers-ry401170vnm-fa_1000.jpg",
"type": "image_alternate_view_5"
},
{
"link": "https://images.thdstatic.com/productImages/ddfed769-c6ad-4eb9-a964-6c78ae69bd50/svn/ryobi-push-lawn-mowers-ry401170vnm-76_1000.jpg",
"type": "image_alternate_view_6"
},
{
"link": "https://images.thdstatic.com/productImages/258875ba-e76c-4c60-9504-3e2450d705bf/svn/ryobi-push-lawn-mowers-ry401170vnm-d4_1000.jpg",
"type": "image_catalog_view"
},
{
"link": "https://images.thdstatic.com/productImages/34320099-ed94-499d-a848-b763fe8caf5c/svn/ryobi-push-lawn-mowers-ry401170vnm-31_1000.jpg",
"type": "image_life_style"
}
],
"main_image": {
"link": "https://images.thdstatic.com/productImages/63e8deea-ed6d-442d-8d0c-5a061c301bff/svn/ryobi-push-lawn-mowers-ry401170vnm-64_1000.jpg",
"type": "primary"
},
"ratings_total": 103,
"rating": 4.5,
"specifications": [
{
"group_name": "Details",
"name": "Amperage (amps)",
"value": "0"
},
{
"group_name": "Details",
"name": "Assembly Required",
"value": "No"
},
{
"group_name": "Details",
"name": "Battery Amp Hours",
"value": "6 Ah"
},
{
"group_name": "Details",
"name": "Battery Run Time (min.)",
"value": "48"
},
{
"group_name": "Details",
"name": "Battery Type",
"value": "Lithium Ion"
},
{
"group_name": "Details",
"name": "Battery/Charger",
"value": "(1) 6 Ah Battery & Charger Included"
},
{
"group_name": "Details",
"name": "CA (CARB) Compliant",
"value": "Not CARB Compliant"
},
{
"group_name": "Details",
"name": "Charge Time (hours)",
"value": "1.5"
},
{
"group_name": "Details",
"name": "Charger Included",
"value": "Charger Included"
},
{
"group_name": "Details",
"name": "Cutting Height Options",
"value": "7-position"
},
{
"group_name": "Details",
"name": "Cutting Options",
"value": "Bag,Mulch,Side-Discharge"
},
{
"group_name": "Details",
"name": "Deck Material",
"value": "Polymer Composite"
},
{
"group_name": "Details",
"name": "Deck Type",
"value": "Fabricated"
},
{
"group_name": "Details",
"name": "Engine Make",
"value": "OEM Branded Engine"
},
{
"group_name": "Details",
"name": "Engine Torque (ft.-lb.)",
"value": "0"
},
{
"group_name": "Details",
"name": "Features",
"value": "Adjustable Cutting Height,Adjustable Handlebar,Bagger,Brushless Motor,Collapsible,Foldable handle,Mulching Lawn Mower,No Oil Change Required,Residential,Single-lever height adjustment,Tool-free adjustments"
},
{
"group_name": "Details",
"name": "Included",
"value": "Bagger,Battery(s),Charger,Wheels"
},
{
"group_name": "Details",
"name": "Lawn Mower Type",
"value": "Push Mower"
},
{
"group_name": "Details",
"name": "Maximum Cutting Height (in.)",
"value": "4"
},
{
"group_name": "Details",
"name": "Minimum Cutting Height (in.)",
"value": "1.5"
},
{
"group_name": "Details",
"name": "Mower Size Type",
"value": "Standard"
},
{
"group_name": "Details",
"name": "Number of Batteries Required",
"value": "1"
},
{
"group_name": "Details",
"name": "Number of Blades",
"value": "1"
},
{
"group_name": "Details",
"name": "Number of Handlebar Positions",
"value": "2"
},
{
"group_name": "Details",
"name": "Number of Total Batteries Included",
"value": "1"
},
{
"group_name": "Details",
"name": "Power Type",
"value": "Battery"
},
{
"group_name": "Details",
"name": "Product Weight (lb.)",
"value": "43 lb"
},
{
"group_name": "Details",
"name": "Recommended Terrain",
"value": "Flat,Sloped"
},
{
"group_name": "Details",
"name": "Refurbished",
"value": "No"
},
{
"group_name": "Details",
"name": "Returnable",
"value": "90-Day"
},
{
"group_name": "Details",
"name": "Size of Yard",
"value": "1/4 - 1/2 Acre"
},
{
"group_name": "Details",
"name": "Start Type",
"value": "Push Button Start"
},
{
"group_name": "Details",
"name": "Tools Included",
"value": "Battery,Charger"
},
{
"group_name": "Details",
"name": "Voltage (v)",
"value": "40v"
},
{
"group_name": "Details",
"name": "Walk Behind Mower Type",
"value": "Manual Push"
},
{
"group_name": "Warranty / Certifications",
"name": "Certifications and Listings",
"value": "UL Certified"
},
{
"group_name": "Warranty / Certifications",
"name": "Manufacturer Warranty",
"value": "5-Year Limited Tool Warranty, 3-Year Limited Battery Warranty"
},
{
"group_name": "Dimensions",
"name": "Assembled Depth (in.)",
"value": "62.5 in"
},
{
"group_name": "Dimensions",
"name": "Assembled Height (in.)",
"value": "39 in"
},
{
"group_name": "Dimensions",
"name": "Assembled Width (in.)",
"value": "21.5 in"
},
{
"group_name": "Dimensions",
"name": "Blade Length (in.)",
"value": "20"
},
{
"group_name": "Dimensions",
"name": "Cutting Width (in.)",
"value": "20 inches"
},
{
"group_name": "Dimensions",
"name": "Front Wheel Size (in.)",
"value": "8"
},
{
"group_name": "Dimensions",
"name": "Mower Deck Width (in.)",
"value": "20"
},
{
"group_name": "Dimensions",
"name": "Rear Wheel Height (in.)",
"value": "High Wheel"
},
{
"group_name": "Dimensions",
"name": "Rear Wheel Size (in.)",
"value": "10"
}
],
"breadcrumbs": [
{
"name": "Outdoors",
"link": "https://www.homedepot.com/b/Outdoors/N-5yc1vZbx82"
},
{
"name": "Outdoor Power Equipment",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment/N-5yc1vZbx5c"
},
{
"name": "Lawn Mowers",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/N-5yc1vZc5ar"
},
{
"name": "Push Lawn Mowers",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers-Push-Lawn-Mowers/N-5yc1vZc5ah"
}
],
"buybox_winner": {
"price": 299,
"currency_symbol": "$",
"currency": "USD",
"unit": "each",
"fulfillment": {
"pickup": true,
"ship_to_store": false,
"ship_to_home": true,
"scheduled_delivery": true,
"pickup_info": {
"store_id": "0121",
"store_state": "Cumberland",
"store_name": "GA",
"in_stock": false,
"stock_level": 0
},
"scheduled_delivery_info": {
"in_stock": true,
"stock_level": 1,
"price": 35,
"start_date": "2022-05-31",
"end_date": "2022-05-31",
"delivery_date_name": "tomorrow"
},
"ship_to_home_info": {
"store_id": "8119",
"store_name": "GA",
"in_stock": true,
"stock_level": 1539,
"price": 0,
"start_date": "2022-06-02",
"end_date": "2022-06-02",
"delivery_date_name": "later"
}
}
}
}
}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.