Category Object

An Amazon Category Object provides information about a category, including its name and details about subcategories and parent categories, enabling navigation through the category tree.

The Category object is returned by the following requests:

• Category Searches
• Category Lookups

Format#

{
    "domainId": Integer,
    "catId": Long,
    "name": String,
    "websiteDisplayGroup": String,
    "children": Long[],
    "parent": Long,
    "isBrowseNode": Boolean,
    "highestRank": Integer,
    "lowestRank": Integer,
    "productCount": Integer,
    "avgBuyBox": Integer,
    "avgBuyBox90": Integer,
    "avgBuyBox365": Integer,
    "avgBuyBoxDeviation": Integer,
    "avgReviewCount": Integer,
    "avgRating": Integer,
    "isFBAPercent": Float,
    "soldByAmazonPercent": Float,
    "hasCouponPercent": Float,
    "avgOfferCountNew": Float,
    "avgOfferCountUsed": Float,
    "sellerCount": Integer,
    "brandCount": Integer,
    "avgDeltaPercent30BuyBox": Float,
    "avgDeltaPercent90BuyBox": Float,
    "avgDeltaPercent30Amazon": Float,
    "avgDeltaPercent90Amazon": Float,
    "relatedCategories": Long[],
    "topBrands": String[]
}

Fields#

Domain IDs#

Possible values for the domainId field:

Example#

Category Objects are obtained through a Category Lookup (by category ID) or a Category Search (by search term). The following request fetches the category 281052 ("Digital Cameras") on amazon.com:

KeepaAPI api = new KeepaAPI("YOUR_API_KEY");
Request r = Request.getCategoryLookupRequest(AmazonLocale.US, false, 281052);
api.sendRequest(r)
    .done(result -> {
        System.out.println(result.categories.get(281052L).name);
    })
    .fail(failure -> System.out.println(failure));

<?php
use Keepa\KeepaAPI;
use Keepa\API\Request;
use Keepa\API\ResponseStatus;
use Keepa\objects\AmazonLocale;

$api = new KeepaAPI("YOUR_API_KEY");
$response = $api->sendRequestWithRetry(Request::getCategoryLookupRequest(AmazonLocale::US, false, "281052"));
if ($response->status == ResponseStatus::OK) {
    print_r($response->categories);
}

import requests

params = {"key": "YOUR_API_KEY", "domain": 1, "category": 281052}
r = requests.get("https://api.keepa.com/category", params=params)
data = r.json()

category = data["categories"]["281052"]
print(category["name"], "-", category["productCount"], "products")

const res = await fetch("https://api.keepa.com/category?key=YOUR_API_KEY&domain=1&category=281052");
const data = await res.json();

const category = data.categories["281052"];
console.log(`${category.name} - ${category.productCount} products`);

curl -s "https://api.keepa.com/category?key=YOUR_API_KEY&domain=1&category=281052"

Example Category Object#

{
    "domainId": 1,
    "catId": 281052,
    "name": "Digital Cameras",
    "websiteDisplayGroup": "ce_display_on_website",
    "children": [3109924011, 7242008011, 3017941, 2476680011, 330405011, 2476681011, 3109925011],
    "parent": 502394,
    "isBrowseNode": true,
    "highestRank": 2452122,
    "lowestRank": 1,
    "productCount": 148733,
    "avgBuyBox": 25499,
    "avgBuyBox90": 26120,
    "avgBuyBox365": 26890,
    "avgBuyBoxDeviation": 1450,
    "avgReviewCount": 235,
    "avgRating": 42,
    "isFBAPercent": 65.5,
    "soldByAmazonPercent": 21.4,
    "hasCouponPercent": 10.2,
    "avgOfferCountNew": 3.5,
    "avgOfferCountUsed": 1.2,
    "sellerCount": 4520,
    "brandCount": 120,
    "avgDeltaPercent30BuyBox": 2.1,
    "avgDeltaPercent90BuyBox": 3.4,
    "avgDeltaPercent30Amazon": 0.8,
    "avgDeltaPercent90Amazon": 1.5,
    "relatedCategories": [672123011, 281407, 11057241],
    "topBrands": ["Sony", "Canon", "Panasonic"]
}

Illustrative values. Prices are integers in the smallest currency unit (e.g. cents: 25499 = $254.99); avgRating 42 corresponds to 4.2 stars. In the actual lookup response, Category Objects are contained in the categories result field — see Category Lookup.