Core APIs
...
Core Requests
Search
2 min
search results when making a request with the type https //docs trajectdata com/bigboxapi/homedepot product data api/parameters/search set to type=search bigbox api will return search results from home depot search results are retrieved from the https //www homedepot com/s/lawn+mower on home depot an example of the json object returned from a search request is shown below { "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" { "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" } } bigbox api returns the following properties for search requests true 220,220,221left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type next steps https //docs trajectdata com/bigboxapi/homedepot product data api/parameters/search