Ecommerce Data API
Along with scraping reviews, our endpoint also supports scraping product details and search results from e-commerce platforms.
Again, if you don't see the platform of your interest listed here, please write to us and we will add support for the platform within 3 days in most cases.
Product Data API
To get details for a product in structured JSON, you need the following query paraemters:
-
An API key, available here as
api_key -
The encoded listing or product URL for which you need the details as
url -
The platform the product url belongs to along with its type defined as
platform=name_detail. So for Amazon, the value isplatform=amazon_detail.
Here too, the product URL must be encoded as described here.
Details
The details include the product's name, brand, description, rating, total_ratings, specifications, total_reviews, seller details, bestseller ranks and more.
The exact attributes available vary depending on the platform.
Supported Platforms
| Platform | Value for query param platform |
|---|---|
| Amazon | amazon_detail |
| BestBuy | bestbuy_detail |
| Costco | costco_detail |
| Target | target_detail |
| Sam's Club | samsclub_detail |
Credits
Each request for product details costs 10 credits.
Requests for BestBuy cost 50 credits.
Examples
The following snippet shows how you can get product details using this API.
curl -L -X GET 'https://data.unwrangle.com/api/getter/?url=https%3A%2F%2Fwww.amazon.com%2FIsopure-Protein-Powder-Isolate-Flavor%2Fdp%2FB000E8ZJGS%2F&platform=amazon_detail&api_key=<API_KEY>'
import requests
url = "https://data.unwrangle.com/api/getter/?url=https%3A%2F%2Fwww.amazon.com%2FIsopure-Protein-Powder-Isolate-Flavor%2Fdp%2FB000E8ZJGS%2F&platform=amazon_detail&api_key=<API_KEY>"
payload={}
headers = {}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
var axios = require('axios');
var config = {
method: 'get',
url: 'https://data.unwrangle.com/api/getter/?url=https%3A%2F%2Fwww.amazon.com%2FIsopure-Protein-Powder-Isolate-Flavor%2Fdp%2FB000E8ZJGS%2F&platform=amazon_detail&api_key=<API_KEY>',
headers: { }
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://data.unwrangle.com/api/getter/?url=https%3A%2F%2Fwww.amazon.com%2FIsopure-Protein-Powder-Isolate-Flavor%2Fdp%2FB000E8ZJGS%2F&platform=amazon_detail&api_key=<API_KEY>")
.asString();
require "uri"
require "net/http"
url = URI("https://data.unwrangle.com/api/getter/?url=https%3A%2F%2Fwww.amazon.com%2FIsopure-Protein-Powder-Isolate-Flavor%2Fdp%2FB000E8ZJGS%2F&platform=amazon_detail&api_key=<API_KEY>")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
response = https.request(request)
puts response.read_body
<?php
$client = new http\Client;
$request = new http\Client\Request;
$request->setRequestUrl('https://data.unwrangle.com/api/getter/?url=https%3A%2F%2Fwww.amazon.com%2FIsopure-Protein-Powder-Isolate-Flavor%2Fdp%2FB000E8ZJGS%2F&platform=amazon_detail&api_key=<API_KEY>');
$request->setRequestMethod('GET');
$request->setOptions(array());
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https://data.unwrangle.com/api/getter/?url=https%3A%2F%2Fwww.amazon.com%2FIsopure-Protein-Powder-Isolate-Flavor%2Fdp%2FB000E8ZJGS%2F&platform=amazon_detail&api_key=<API_KEY>"
method := "GET"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
}
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
For the above request, the response will look like this:
{
"success": true,
"url": "https://www.amazon.com/Isopure-Protein-Powder-Isolate-Flavor/dp/B000E8ZJGS/",
"result_count": 1,
"detail": {
"name": "Isopure Low Carb, Vitamin C and Zinc for Immune Support, 25g Protein, Keto Friendly Protein Powder, 100% Whey Protein Isolate, Flavor: Dutch Chocolate, 3 Pounds (Packaging May Vary)",
"brand": "Isopure",
"categories": [
{
"name": "Health & Household",
"url": "https://www.amazon.com/health-personal-care-nutrition-fitness/b/ref=dp_bc_aui_C_1/139-8505795-2150109"
},
{
"name": "Sports Nutrition",
"url": "https://www.amazon.com/Sports-Nutrition/b/ref=dp_bc_aui_C_2/139-8505795-2150109"
},
{
"name": "Protein",
"url": "https://www.amazon.com/Sports-Nutrition-Protein/b/ref=dp_bc_aui_C_3/139-8505795-2150109"
},
{
"name": "Powders",
"url": "https://www.amazon.com/Sports-Nutrition-Protein-Powders/b/ref=dp_bc_aui_C_4/139-8505795-2150109"
},
{
"name": "Whey",
"url": "https://www.amazon.com/Sports-Nutrition-Whey-Protein-Powders/b/ref=dp_bc_aui_C_5/139-8505795-2150109"
}
],
"price": "$44.99",
"price_reduced": null,
"max_quantity": 30,
"rating": 4.6,
"total_ratings": 45131,
"asin": "B000E8ZJGS",
"overview": [
{
"name": "Ingredients",
"value": "Whey Protein Isolate, Cocoa (Processed with Alkali), Vitamin and Mineral Blend (Dicalcium Phosphate, Potassium Chloride, Magnesium Oxide, Ascorbic Acid, Sodium Chloride, Zinc Sulfate, D-Alpha Tocopheryl Acetate, Niacinamide, Calcium D-Pantothenate, Copper Sulfate, Manganese Sulfate, Pyridoxine Hydrochloride, Riboflavin, Thiamin Hydrochloride, Vitamin A Acetate, Chromium Chloride, Folic Acid, D-Biotin, Potassium Iodide, Sodium Molybdate, Sodium Selenite, Phytonadione, Cyanocobalamin), Soy Lecithin, L-Glutamine, Xanthan Gum, Natural and Artificial Flavor, Sucralose."
},
{
"name": "Flavor",
"value": "Dutch Chocolate"
},
{
"name": "Brand",
"value": "Isopure"
},
{
"name": "Item Weight",
"value": "3 Pounds"
},
{
"name": "Serving Description",
"value": "2 scoopfuls (65g)"
}
],
"details_table": [
{
"name": "Is Discontinued By Manufacturer\n\n\n",
"value": "No"
},
{
"name": "Product Dimensions\n\n\n",
"value": "6 x 5 x 4 inches; 3 Pounds"
},
{
"name": "Item model number\n\n\n",
"value": "1062165"
},
{
"name": "Department\n\n\n",
"value": "Unisex-adult"
},
{
"name": "Date First Available\n\n\n",
"value": "December 30, 2003"
},
{
"name": "Manufacturer\n\n\n",
"value": "Glanbia Performance Nutrition"
},
{
"name": "ASIN\n\n\n",
"value": "B000E8ZJGS"
},
{
"name": "Country of Origin\n\n\n",
"value": "USA"
},
{
"name": "Domestic Shipping",
"value": "Currently, item can be shipped only within the U.S. and to APO/FPO addresses. For APO/FPO shipments, please check with the manufacturer regarding warranty and support issues."
},
{
"name": "International Shipping",
"value": "This item is not eligible for international shipping."
}
],
"bestseller_ranks": [
{
"name": "See Top 100 in Health & Household",
"url": "https://www.amazon.com/gp/bestsellers/hpc/ref=pd_zg_ts_hpc",
"rank": null
},
{
"name": "Sports Nutrition Whey Protein Powders",
"url": "https://www.amazon.com/gp/bestsellers/hpc/6973717011/ref=pd_zg_hrsr_hpc",
"rank": 3
},
{
"name": "Sales & Deals",
"url": "https://www.amazon.com/gp/bestsellers/hpc/353413011/ref=pd_zg_hrsr_hpc",
"rank": 47
}
],
"seller_name": null,
"seller_url": null
}
}
The attributes available differ based on platform. Please contact us if you would like us to add an attribute that does not currently exist in the output.
SERP (Search Results) Scraping API
To get search results for popular e-commerce stores in structured JSON, you need the following query parameters:
-
An API key, available here as
api_key -
The keyword of interest for which you want product listings as
search -
The platform you want to search product listings from as
platform=name_search. So for Target, the value isplatform=target_search. -
(Optional) The page number from which you want the results as
page
Details
We try to include the following data attributes for the search results: id (product or sku id), name, brand, model_no, rating, total_ratings, price, whether the result isSponsored and more.
The exact attributes available vary depending on the platform.
Supported Platforms
| Platform | Value for query param platform |
|---|---|
| BedBathAndBeyond | bedbathbeyond_search |
| BestBuy | bestbuy_search |
| Costco | costco_search |
| Home Depot | homedepot_search |
| Target | target_search |
| Sam's Club | samsclub_search |
| Shopee | shopee_search |
Credits
An API requests costs 10 credits or 1 credit per result, whichever is higher.
Requests to BestBuy cost 50 credits regardless of number of results.
Example
The following snippet shows how you can get search results from any of the above e-commerce platforms using this API.
curl -L -X GET 'https://data.unwrangle.com/api/getter/?search=soap&platform=bedbathbeyond_search&page=5&api_key=<API_KEY>'
import requests
url = "https://data.unwrangle.com/api/getter/?search=soap&platform=bedbathbeyond_search&page=5&api_key=<API_KEY>"
payload={}
headers = {}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
var axios = require('axios');
var config = {
method: 'get',
url: 'https://data.unwrangle.com/api/getter/?search=soap&platform=bedbathbeyond_search&page=5&api_key=<API_KEY>',
headers: { }
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://data.unwrangle.com/api/getter/?search=soap&platform=bedbathbeyond_search&page=5&api_key=<API_KEY>")
.asString();
require "uri"
require "net/http"
url = URI("https://data.unwrangle.com/api/getter/?search=soap&platform=bedbathbeyond_search&page=5&api_key=<API_KEY>")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
response = https.request(request)
puts response.read_body
<?php
$client = new http\Client;
$request = new http\Client\Request;
$request->setRequestUrl('https://data.unwrangle.com/api/getter/?search=soap&platform=bedbathbeyond_search&page=5&api_key=<API_KEY>');
$request->setRequestMethod('GET');
$request->setOptions(array());
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https://data.unwrangle.com/api/getter/?search=soap&platform=bedbathbeyond_search&page=5&api_key=<API_KEY>"
method := "GET"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
}
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
For the above request, the response will look like this:
{
"success": true,
"search": "soap",
"page": 5,
"total_results": 642,
"no_of_pages": 27,
"result_count": 24,
"results": [
{
"id": "1017573730",
"url": "https://www.bedbathandbeyond.com/product/method-12-oz-gel-hand-wash-in-waterfall/1017573730",
"thumbnail": "https://b3h2.scene7.com/is/image/BedBathandBeyond/83660817573730p",
"name": "Method® 12 oz. Gel Hand Wash in Waterfall",
"brand": "method",
"sku_id": "17573730",
"price": "$2.99",
"member_price": "$2.39",
"rating": 4.8,
"total_reviews": 9,
"in_stock": true
},
{
"id": "1014824626",
"url": "https://www.bedbathandbeyond.com/product/method-34-oz-gel-hand-wash-refill-in-sweet-water/1014824626",
"thumbnail": "https://b3h2.scene7.com/is/image/BedBathandBeyond/83651214824626p",
"name": "Method® 34 oz. Gel Hand Wash Refill in Sweet Water",
"brand": "method",
"sku_id": "14824626",
"price": "$5.99",
"member_price": "$4.79",
"rating": 4.8,
"total_reviews": 18,
"in_stock": true
},
{
"id": "5215591",
"url": "https://www.bedbathandbeyond.com/product/johnson-39-s-head-to-toe-27-1-oz-wash-shampoo/5215591",
"thumbnail": "https://b3h2.scene7.com/is/image/BedBathandBeyond/216535220530105p",
"name": "Johnson's® Head-To-Toe® 27.1 oz. Wash & Shampoo",
"brand": "Johnson & Johnson",
"sku_id": "20530105",
"price": "$7.99",
"member_price": "$6.39",
"rating": 4.6,
"total_reviews": 907,
"in_stock": true
},
{
"id": "5623654",
"url": "https://www.bedbathandbeyond.com/product/alaffia-16-fl-oz-authentic-african-black-soap-all-in-one-in-eucalyptus-tea-tree/5623654",
"thumbnail": "https://b3h2.scene7.com/is/image/BedBathandBeyond/2021-07-01-13-24_8413201027352_imageset",
"name": "Alaffia® 16 fl. oz. Authentic African Black Soap All-In-One in Eucalyptus Tea Tree",
"brand": null,
"sku_id": "20709044",
"price": "$9.99",
"member_price": "$7.99",
"rating": 4.8,
"total_reviews": 39,
"in_stock": true
},
{
"id": "5621158",
"url": "https://www.bedbathandbeyond.com/product/method-green-tea-aloe-foaming-10-oz-hand-soap/5621158",
"thumbnail": "https://b3h2.scene7.com/is/image/BedBathandBeyond/817939003626_imageset",
"name": "method® Green Tea + Aloe Foaming 10 oz. Hand Soap",
"brand": "method",
"sku_id": "20195298",
"price": "$2.99",
"member_price": "$2.39",
"rating": 4.5,
"total_reviews": 12,
"in_stock": true
},
{
"id": "1020281700",
"url": "https://www.bedbathandbeyond.com/product/dial-8-count-4-oz-omega-moisture-glycerin-bar-soap-with-sea-berry/1020281700",
"thumbnail": "https://b3h2.scene7.com/is/image/BedBathandBeyond/126154420281700p",
"name": "Dial® 8-Count 4 oz. Omega Moisture Glycerin Bar Soap with Sea Berry",
"brand": "Dial",
"sku_id": "20281700",
"price": "$4.99",
"member_price": "$3.99",
"rating": 4.6,
"total_reviews": 36,
"in_stock": true
},
{
"id": "1020358655",
"url": "https://www.bedbathandbeyond.com/product/coast-8-count-4-oz-refreshing-deodorant-bar-soap-in-classic-pacific-force-scent/1020358655",
"thumbnail": "https://b3h2.scene7.com/is/image/BedBathandBeyond/2021-07-20-21-14_816559011974_imageset",
"name": "Coast® 8-Count 4 oz. Refreshing Deodorant Bar Soap in Classic Pacific Force Scent",
"brand": "Coast",
"sku_id": "20358655",
"price": "$5.49",
"member_price": "$4.39",
"rating": 4.8,
"total_reviews": 12,
"in_stock": true
},
{
"id": "1020108809",
"url": "https://www.bedbathandbeyond.com/product/dial-complete-7-5-fl-oz-foaming-antibacterial-hand-wash-in-coconut-water/1020108809",
"thumbnail": "https://b3h2.scene7.com/is/image/BedBathandBeyond/2021-08-13-14-34_dl_fhw_7p5oz_carton_coconutwater_2749525_fnt_imageset",
"name": "Dial® Complete® 7.5 fl. oz. Foaming Antibacterial Hand Wash in Coconut Water",
"brand": "Dial",
"sku_id": "20108809",
"price": "$2.19",
"member_price": "$1.75",
"rating": 5.0,
"total_reviews": 28,
"in_stock": true
},
{
"id": "1020225230",
"url": "https://www.bedbathandbeyond.com/product/south-of-france-6-oz-french-milled-oval-bar-soap-in-blooming-jasmine/1020225230",
"thumbnail": "https://b3h2.scene7.com/is/image/BedBathandBeyond/126152720225230p",
"name": "South of France 6 oz. French Milled Oval Bar Soap in Blooming Jasmine",
"brand": "South of France",
"sku_id": "20225230",
"price": "$3.49",
"member_price": "$2.79",
"rating": 4.4,
"total_reviews": 8,
"in_stock": true
},
{
"id": "1020225162",
"url": "https://www.bedbathandbeyond.com/product/south-of-france-6-oz-french-milled-oval-bar-soap-in-lavender-fields/1020225162",
"thumbnail": "https://b3h2.scene7.com/is/image/BedBathandBeyond/126152120225162p",
"name": "South of France 6 oz. French Milled Oval Bar Soap in Lavender Fields",
"brand": "South of France",
"sku_id": "20225162",
"price": "$3.49",
"member_price": "$2.79",
"rating": 4.8,
"total_reviews": 12,
"in_stock": true
},
{
"id": "1016285064",
"url": "https://www.bedbathandbeyond.com/product/dr-bronner-39-s-32-oz-18-in-1-pure-castile-liquid-soap-in-eucalyptus/1016285064",
"thumbnail": "https://b3h2.scene7.com/is/image/BedBathandBeyond/68601816285064p",
"name": "Dr Bronner's 32 oz. 18-in-1 Pure-Castile Liquid Soap in Eucalyptus",
"brand": "Dr. Bronner's",
"sku_id": "16285064",
"price": "$14.49",
"member_price": "$11.59",
"rating": 4.8,
"total_reviews": 96,
"in_stock": true
},
{
"id": "1040384757",
"url": "https://www.bedbathandbeyond.com/product/method-12-oz-hand-wash-in-sea-mineral/1040384757",
"thumbnail": "https://b3h2.scene7.com/is/image/BedBathandBeyond/2021-05-03-13-59_817939001622_imageset",
"name": "Method® 12 oz. Hand Wash in Sea Mineral",
"brand": "method",
"sku_id": "40384757",
"price": "$2.99",
"member_price": "$2.39",
"rating": 4.4,
"total_reviews": 9,
"in_stock": true
},
{
"id": "1020281656",
"url": "https://www.bedbathandbeyond.com/product/method-10-oz-foaming-hand-wash-in-orange-ginger/1020281656",
"thumbnail": "https://b3h2.scene7.com/is/image/BedBathandBeyond/62949720281656p",
"name": "Method® 10 oz. Foaming Hand Wash in Orange Ginger",
"brand": "method",
"sku_id": "20281656",
"price": "$2.99",
"member_price": "$2.39",
"rating": 5.0,
"total_reviews": 7,
"in_stock": true
},
{
"id": "1020110789",
"url": "https://www.bedbathandbeyond.com/product/dial-complete-7-5-fl-oz-foaming-antibacterial-hand-wash-in-spring-water/1020110789",
"thumbnail": "https://b3h2.scene7.com/is/image/BedBathandBeyond/126147220110789p",
"name": "Dial® Complete® 7.5 fl. oz. Foaming Antibacterial Hand Wash in Spring Water",
"brand": "Dial",
"sku_id": "20110789",
"price": "$2.19",
"member_price": "$1.75",
"rating": 4.6,
"total_reviews": 51,
"in_stock": true
},
{
"id": "5570339",
"url": "https://www.bedbathandbeyond.com/product/a-la-maison-4-pack-hypoallergenic-unscented-bar-soap-for-hand-amp-body/5570339",
"thumbnail": "https://b3h2.scene7.com/is/image/BedBathandBeyond/182741000393_imageset",
"name": "A La Maison 4-Pack Hypoallergenic Unscented Bar Soap for Hand & Body",
"brand": "A La Maison",
"sku_id": "20614645",
"price": "$5.99",
"member_price": "$3.83",
"rating": null,
"total_reviews": null,
"in_stock": true
},
{
"id": "5571651",
"url": "https://www.bedbathandbeyond.com/product/garrison-home-19-oz-foaming-hand-soap-in-lily-gardenia/5571651",
"thumbnail": "https://b3h2.scene7.com/is/image/BedBathandBeyond/2020-12-16-14-45_garrisonhome_foaminghandsoap_lilygardenia_imageset",
"name": "Garrison Home 19 oz. Foaming Hand Soap in Lily Gardenia",
"brand": null,
"sku_id": "69683464",
"price": "$4.99",
"member_price": "$3.99",
"rating": 5.0,
"total_reviews": 8,
"in_stock": true
},
{
"id": "5623670",
"url": "https://www.bedbathandbeyond.com/product/duke-cannon-10-oz-the-great-american-beer-soap/5623670",
"thumbnail": "https://b3h2.scene7.com/is/image/BedBathandBeyond/2021-07-17-16-56_850008675324_imageset",
"name": "Duke Cannon 10 oz. The Great American Beer Soap",
"brand": "Duke Cannon",
"sku_id": "20707279",
"price": "$7.99",
"member_price": "$6.39",
"rating": 4.7,
"total_reviews": 113,
"in_stock": true
},
{
"id": "3330582",
"url": "https://www.bedbathandbeyond.com/product/dial-antibacterial-hand-soap-with-moisturizer-in-gold-collection/3330582",
"thumbnail": "https://b3h2.scene7.com/is/image/BedBathandBeyond/127534120108793p",
"name": "Dial® Antibacterial Hand Soap with Moisturizer in Gold Collection",
"brand": "Dial",
"sku_id": "20108793",
"price": "$1.79",
"member_price": "$1.43",
"rating": 3.9,
"total_reviews": 39,
"in_stock": true
},
{
"id": "1020225179",
"url": "https://www.bedbathandbeyond.com/product/south-of-france-6-oz-french-milled-oval-bar-soap-in-lemon-verbena/1020225179",
"thumbnail": "https://b3h2.scene7.com/is/image/BedBathandBeyond/126152220225179p",
"name": "South of France 6 oz. French Milled Oval Bar Soap in Lemon Verbena",
"brand": "South of France",
"sku_id": "20225179",
"price": "$3.49",
"member_price": "$2.79",
"rating": 4.9,
"total_reviews": 11,
"in_stock": true
},
{
"id": "1020308827",
"url": "https://www.bedbathandbeyond.com/product/eo-everyone-for-kids-32-oz-3-in-1-tropical-coconut-twist-soap/1020308827",
"thumbnail": "https://b3h2.scene7.com/is/image/BedBathandBeyond/81996720308827p",
"name": "EO® Everyone™ For Kids 32 oz. 3-in-1 Tropical Coconut Twist Soap",
"brand": "EO",
"sku_id": "20308827",
"price": "$13.99",
"member_price": "$11.19",
"rating": 4.3,
"total_reviews": 6,
"in_stock": true
},
{
"id": "5570338",
"url": "https://www.bedbathandbeyond.com/product/a-la-maison-de-provence-4-pack-rosemary-mint-bar-soap-for-hand-amp-body/5570338",
"thumbnail": "https://b3h2.scene7.com/is/image/BedBathandBeyond/182741000980_imageset",
"name": "A La Maison de Provence 4-Pack Rosemary Mint Bar Soap for Hand & Body",
"brand": "A La Maison",
"sku_id": "20614652",
"price": "$5.99",
"member_price": "$3.83",
"rating": null,
"total_reviews": null,
"in_stock": true
},
{
"id": "5310690",
"url": "https://www.bedbathandbeyond.com/product/kirk-39-s-12-fl-oz-odor-neutralizing-hand-wash-in-rosemary-amp-sage/5310690",
"thumbnail": "https://b3h2.scene7.com/is/image/BedBathandBeyond/2021-05-06-13-49_639844110202jpeg_imageset",
"name": "Kirk's™ 12 fl. oz. Odor Neutralizing Hand Wash in Rosemary & Sage",
"brand": "Kirk's",
"sku_id": "20562847",
"price": "$4.99",
"member_price": "$3.99",
"rating": 5.0,
"total_reviews": 3,
"in_stock": true
},
{
"id": "5631927",
"url": "https://www.bedbathandbeyond.com/product/yardley-4-pack-moisturizing-bath-bar-in-english-lavender/5631927",
"thumbnail": "https://b3h2.scene7.com/is/image/BedBathandBeyond/2021-07-15-10-18_41840873706_imageset",
"name": "Yardley® 4-Pack Moisturizing Bath Bar in English Lavender",
"brand": "Yardley",
"sku_id": "12552220",
"price": "$4.19",
"member_price": "$3.35",
"rating": 4.6,
"total_reviews": 807,
"in_stock": true
},
{
"id": "5631936",
"url": "https://www.bedbathandbeyond.com/product/yardley-4-pack-moisturizing-bath-bar-in-aloe-and-avocado/5631936",
"thumbnail": "https://b3h2.scene7.com/is/image/BedBathandBeyond/2021-07-15-10-18_41840873713_imageset",
"name": "Yardley® 4-Pack Moisturizing Bath Bar in Aloe and Avocado",
"brand": "Yardley",
"sku_id": "12552246",
"price": "$4.19",
"member_price": "$3.35",
"rating": 5.0,
"total_reviews": 1,
"in_stock": true
}
],
"meta_data": {}
}
The attributes available differ based on platform. Please contact us if you would like us to add an attribute that does not currently exist in the output.
Additional Filters
Shopee
On Shopee, we support additional filters such as country_code to specify which Shopee website you would like to search. Also, on Shopee, you can extract product lists for a particular category using its category_url.
| Filter | Support values |
|---|---|
country_code |
sg (Singapore), id (Indonesia), my (Malaysia), tw (Taiwan) |
category_url |
https://shopee.tw/運動-健身-cat.11040840 (example) |
Please note that you can use either a search keyword or a category_url to search for products on Shopee, but not both together.
Ecommerce Product Category / Department Scraping API
To scrape product or SKU data by a category or department, you need the following query parameters:
-
An API key, available here as
api_key -
The URL of the category page you want to scrape as
url -
The platform you want to scrape the product category from as
platform=name_category. So for Amazon, the value isplatform=amazon_category. -
(Optional) The page number from which you want the results as
page
The attributes contained within the response are similar to the ones returned by the SERP API described above.
Supported Platforms
At this moment we only support scraping the product category page of Amazon USA. For this you need to set the platform query parameter to amazon_category.
We will continue to update the product category scraper for ecommerce with support for newer platforms. Walmart, and the rest of the Amazon platforms are on our roadmap for now.
Finder the Product Category's URL
Our system expects the URL which returns the products for the category in a grid and not the pages that have further subcategories or brands listed.
On Amazon, this URL can be found by scrolling at the bottom and clicking "See All Results". If you a paid subscriber our support can help you find the URL if you're having difficulties.
The same applies to both main categories (for e.g. Grocery & Gourmet Food) or sub-categories (for e.g. Breads).
Here's an example of a URL that our server expects:
URL for the Category "Yoga & Studio" on Amazon
https://www.amazon.com/s?rh=n%3A23550734011&fs=true
Scraping Product Category with Filters
You can also scrape a product category with additional filters. For e.g. color "black" for clothes or "low-carb" for breads. To do this, you need to check the filter on Amazon.com and then use the product category URL after applying the filter.
Here's how they differ:
URL for the Category "Breads" on Amazon:
https://www.amazon.com/s?k=breads&i=grocery&rh=n%3A16310101%2Cn%3A16318751%2Cn%3A1877687001
URL for the Category "Breads" with the Filter "Low-Carb" on Amazon:
https://www.amazon.com/s?k=breads&i=grocery&rh=n%3A18776870011%2Cp_n_feature_nine_browse-bin%3A114327011&dc&qid=1641138755&rnid=114319011
Credits
An API requests cost 10 credits or 1 credit per result, whichever is higher.
For examples of how to use the API, please refer to the above sections (Product Data API or SERP API) and swap the query parameters for the ones listed in this section.