# Amazon Best Sellers API

Amazon

Returns Amazon's Best Sellers of a category, ranked from the top, from its department, browse node or Best Sellers link, on any Amazon marketplace. Each product has its rank, ASIN, title, image, current price, star rating and exact rating count, and a book's author. The same category's New Releases come back the same way.

GET `/v1/amazon/top_products`

## Example

cURL:

```shell
curl 'https://socialtap.dev/v1/amazon/top_products?category=electronics' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
```

TypeScript SDK:

```typescript
import { SocialTap } from "socialtap";

const client = new SocialTap(); // apiKey defaults to process.env.SOCIALTAP_API_KEY

const res = await client.amazon.topProducts.list({ category: "electronics" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);
```

Node.js (fetch):

```javascript
const params = new URLSearchParams({
  category: "electronics",
});
const res = await fetch(`https://socialtap.dev/v1/amazon/top_products?${params}`, {
  headers: { "x-api-key": process.env.SOCIALTAP_API_KEY ?? "" },
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
const { data, page, meta } = body;
console.log(data, meta.credits_charged);
```

Python (requests):

```python
import os

import requests

res = requests.get(
    "https://socialtap.dev/v1/amazon/top_products",
    params={"category": "electronics"},
    headers={"x-api-key": os.environ["SOCIALTAP_API_KEY"]},
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
data, page, meta = body["data"], body["page"], body["meta"]
print(data, meta["credits_charged"])
```

Go (net/http):

```go
package main

import (
	"encoding/json"
	"fmt"
	"log"
	"net/http"
	"net/url"
	"os"
)

func main() {
	q := url.Values{}
	q.Set("category", "electronics")
	req, err := http.NewRequest("GET", "https://socialtap.dev/v1/amazon/top_products?"+q.Encode(), nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("x-api-key", os.Getenv("SOCIALTAP_API_KEY"))
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer res.Body.Close()
	var body struct {
		Data  json.RawMessage `json:"data"`
		Page  json.RawMessage `json:"page"`
		Meta  map[string]any  `json:"meta"`
		Error *struct {
			Code    string `json:"code"`
			Message string `json:"message"`
		} `json:"error"`
	}
	if err := json.NewDecoder(res.Body).Decode(&body); err != nil {
		log.Fatal(err)
	}
	if body.Error != nil {
		log.Fatalf("%s: %s", body.Error.Code, body.Error.Message)
	}
	fmt.Println(string(body.Data), body.Meta["credits_charged"])
}
```

200 OK:

```json
{
  "data": [
    {
      "approximate_fields": [
        "platform_specific.amazon.rating"
      ],
      "attributes": [],
      "availability": null,
      "category": null,
      "category_id": null,
      "condition": null,
      "condition_label": null,
      "country_code": "US",
      "currency": "USD",
      "description": null,
      "id": "B08JHCVHTY",
      "max_price": null,
      "media": [],
      "original_price": null,
      "platform": "amazon",
      "platform_specific": {
        "amazon": {
          "availability_label": null,
          "best_sellers_ranks": [],
          "brand": null,
          "categories": [],
          "contributors": [],
          "deal": null,
          "features": [],
          "is_sponsored": null,
          "metrics": {
            "bought_past_month_count": null,
            "offer_count": null,
            "rating_count": 281899,
            "rating_distribution": null
          },
          "parent_asin": null,
          "rank": 1,
          "rating": 4.4,
          "ships_from": null,
          "variants": []
        }
      },
      "price": 11.99,
      "seller": null,
      "shipping": {
        "fee": null,
        "is_offered": null
      },
      "thumbnail_url": "https://images-na.ssl-images-amazon.com/images/I/31YHGbJsldL._AC_UL900_SR900,600_.png",
      "title": "blink plus plan with monthly auto-renewal",
      "type": "product",
      "unknown_fields": [
        "media",
        "attributes",
        "platform_specific.amazon.contributors"
      ],
      "url": "https://www.amazon.com/dp/B08JHCVHTY"
    },
    {
      "approximate_fields": [
        "platform_specific.amazon.rating"
      ],
      "attributes": [],
      "availability": null,
      "category": null,
      "category_id": null,
      "condition": null,
      "condition_label": null,
      "country_code": "US",
      "currency": "USD",
      "description": null,
      "id": "B0DCH8VDXF",
      "max_price": null,
      "media": [],
      "original_price": null,
      "platform": "amazon",
      "platform_specific": {
        "amazon": {
          "availability_label": null,
          "best_sellers_ranks": [],
          "brand": null,
          "categories": [],
          "contributors": [],
          "deal": null,
          "features": [],
          "is_sponsored": null,
          "metrics": {
            "bought_past_month_count": null,
            "offer_count": null,
            "rating_count": 20075,
            "rating_distribution": null
          },
          "parent_asin": null,
          "rank": 2,
          "rating": 4.5,
          "ships_from": null,
          "variants": []
        }
      },
      "price": 19,
      "seller": null,
      "shipping": {
        "fee": null,
        "is_offered": null
      },
      "thumbnail_url": "https://images-na.ssl-images-amazon.com/images/I/513OSdW4elL._AC_UL900_SR900,600_.jpg",
      "title": "Apple EarPods Headphones with USB-C Plug, Wired Ear Buds with Built-in Remote to Control Music, Phone Calls, and Volume",
      "type": "product",
      "unknown_fields": [
        "media",
        "attributes",
        "platform_specific.amazon.contributors"
      ],
      "url": "https://www.amazon.com/dp/B0DCH8VDXF"
    },
    {
      "approximate_fields": [
        "platform_specific.amazon.rating"
      ],
      "attributes": [],
      "availability": null,
      "category": null,
      "category_id": null,
      "condition": null,
      "condition_label": null,
      "country_code": "US",
      "currency": "USD",
      "description": null,
      "id": "B0GJTFXNRX",
      "max_price": null,
      "media": [],
      "original_price": null,
      "platform": "amazon",
      "platform_specific": {
        "amazon": {
          "availability_label": null,
          "best_sellers_ranks": [],
          "brand": null,
          "categories": [],
          "contributors": [],
          "deal": null,
          "features": [],
          "is_sponsored": null,
          "metrics": {
            "bought_past_month_count": null,
            "offer_count": null,
            "rating_count": 13061,
            "rating_distribution": null
          },
          "parent_asin": null,
          "rank": 3,
          "rating": 4.6,
          "ships_from": null,
          "variants": []
        }
      },
      "price": 23,
      "seller": null,
      "shipping": {
        "fee": null,
        "is_offered": null
      },
      "thumbnail_url": "https://images-na.ssl-images-amazon.com/images/I/61Qd9Z9caRL._AC_UL900_SR900,600_.jpg",
      "title": "Apple AirTag (2nd Generation): Tracker for Keychain, Wallet, and More; Locator with Sound; Simple One-Tap Setup with iPhone or iPad; Key Finder with up to 1.5X Precision Finding Range",
      "type": "product",
      "unknown_fields": [
        "media",
        "attributes",
        "platform_specific.amazon.contributors"
      ],
      "url": "https://www.amazon.com/dp/B0GJTFXNRX"
    }
  ],
  "page": {
    "has_more": true,
    "next_cursor": "c1.EXAMPLE_CURSOR",
    "next_cursor_expires_at": "2026-10-26T12:00:00Z",
    "end_reason": null
  },
  "meta": {
    "request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f",
    "platform": "amazon",
    "source": "page",
    "is_cached": false,
    "credits_charged": 1,
    "latency_ms": 0,
    "fetched_at": "2026-10-25T12:00:00Z",
    "input": null,
    "credits_remaining": 9999,
    "client_request_id": null,
    "warnings": []
  }
}
```

Long arrays and strings are shortened for display; real responses are complete.

> [!NOTE]
>
> **Good to know**
>
> - Amazon ranks the top hundred of each list, fifty to a page, so a list ends after its second page with page.end_reason end.
> - platform_specific.amazon.rank is the product's place in the list you asked for. Description, specifications, seller and variations aren't on a list: send the ASIN to the Amazon Product API for them.
> - A product with no featured offer shows the lowest of its offers as price, and platform_specific.amazon.metrics.offer_count counts them.
> - list also takes movers_and_shakers, most_wished_for and gift_ideas, but Amazon shows no products in those three lists today, in any category or marketplace we checked. Most Wished For and Gift Ideas of a category Amazon names come back as an empty page with page.end_reason end. Movers & Shakers, and those two lists of a browse node sent alone, return not_found, because Amazon's page names no category for them.
> - A category Amazon doesn't know returns not_found.
> - Prices and lists are the marketplace's own, in its currency, and each marketplace has its own departments and slugs.

## Authorizations

`x-api-key`stringheaderrequired

Your API key. [Authentication](https://socialtap.dev/docs/authentication/index.md)

## Query parameters

| Name | Type | Description | Example |
| --- | --- | --- | --- |
| `category` required | `string`<br>max 2,048 chars | The category: its department's slug as Amazon's Best Sellers links write it (electronics, books, or ce-de on Amazon Germany), optionally with a browse node after a slash (electronics/12097478011), the browse node alone (12097478011), or the list's link itself (amazon.com/gp/bestsellers/electronics/12097478011, a /zgbs/ link, or a New Releases, Movers & Shakers, Most Wished For or Gift Ideas link). A product's platform_specific.amazon.best_sellers_ranks\[\].category_id is one of these. | `electronics` |
| `list` optional | `string` | Which of the category's lists: best_sellers (the most sold), new_releases (the best-selling new and upcoming products), movers_and_shakers (the biggest sales rank gains in a day), most_wished_for (the most added to wish lists) or gift_ideas (the most bought as gifts). Amazon shows no products in the last three today. Default: the link's list, else best_sellers.<br>One of `best_sellers`, `new_releases`, `movers_and_shakers`, `most_wished_for`, `gift_ideas` | `new_releases` |
| `country` optional | `string`<br>iso3166-1-alpha-2 | Region: an ISO 3166-1 alpha-2 country code such as US or BR (case-insensitive). The Amazon marketplace whose list to read, by country: US (amazon.com), GB (amazon.co.uk), DE, JP, IN, … Departments and their slugs are each marketplace's own. Default: the link's marketplace, else US. | `US` |
| `limit` optional | `integer`<br>min 1<br>max 50 | Items per page, 1 to the endpoint's page size (its default and maximum; larger values are reduced to it). Omit it: every page costs the same, so a smaller limit means more pages to pay for. | `50` |
| `cursor` optional | `string` | page.next_cursor from the previous response. Send the same other parameters; omit to start from the first page. | — |

Unknown parameters are rejected with a suggestion, never ignored ([Requests](https://socialtap.dev/docs/requests/index.md)). `limit` and `cursor` page through the list: see Pagination.

**Parameters every endpoint accepts**

| Name | Type | Description | Example |
| --- | --- | --- | --- |
| `max_age` optional | `integer`<br>min 0 | Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent. | — |
| `fields` optional | `string` | Return only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments\[\].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole. | — |

## Response

### 200

`{data, page, meta}`. `data` is an array of up to 50 [product](https://socialtap.dev/resources/product/index.md) objects, Amazon's rank in the list (1 = top); `page` says how to get the next page; `meta` describes the request ([meta](https://socialtap.dev/docs/reference/index.md#meta)). Fields only Amazon has are under `platform_specific.amazon`.

| Field | Type | Description |
| --- | --- | --- |
| `data[].platform` | `string` | Platform ID (tiktokshop, facebook, …). |
| `data[].id` | `string` | Platform-native product or listing ID (string). |
| `data[].url` | `string` (uri) | Canonical product page URL. |
| `data[].type` | `string` | product: a catalog product a shop sells in many units, often in variants (TikTok Shop, Instagram and YouTube shopping); listing: a single item a person or business lists for sale (Facebook Marketplace). New values may be added; treat unknown values as product.<br>One of `product`, `listing` |
| `data[].title` | `string` | Product name or listing title, as the seller wrote it. |
| `data[].description` | `string` or `null` | Description as plain text (paragraphs separated by blank lines); null when it has none or the source does not show it (lists and search results). |
| `data[].category` | `string` or `null` | The platform's most specific category label (Bicycles, Vitamins & Supplements), as shown; not normalized across platforms. |
| `data[].category_id` | `string` or `null` | The platform's ID of that category (what its category browsing and filters take). |
| `data[].seller` | `object` or `null` | The shop or account selling it; null only when the source does not show it. |
| `data[].seller.id` | `string` or `null` | Platform-native account ID; null when only the handle is known. |
| `data[].seller.username` | `string` or `null` | Handle without the @; null when the account has none. |
| `data[].seller.display_name` | `string` or `null` | Display name shown on the profile. |
| `data[].seller.url` | `string` (uri) or `null` | Canonical profile URL. |
| `data[].seller.avatar_url` | `string` (uri) or `null` | Profile picture URL. Platform CDN URLs can expire within hours. |
| `data[].seller.is_verified` | `boolean` or `null` | Platform verification badge; null where the platform has no badge. |
| `data[].price` | `number` or `null` | Current price in major units of currency (58.47), discounts applied; for a product whose variants cost different amounts, the lowest (the platform's "from" price). Coupons and shipping excluded. 0 = free; null when not shown. |
| `data[].max_price` | `number` or `null` | Highest current variant price, in major units of currency; equal to price when every variant costs the same; null when unknown (a source that shows one price). |
| `data[].original_price` | `number` or `null` | Price before the discount (the struck-through list price), in major units of currency; null when the platform shows no earlier price (not discounted, or not shown). |
| `data[].currency` | `string` or `null` | ISO 4217 code of every amount of this product (USD); null when no amount is shown. |
| `data[].availability` | `string` or `null` | in_stock: can be bought now; out_of_stock: sold out for now (a product can be restocked); pre_order: ships later; pending: a listing with a sale pending; sold: a listing marked sold. Null when the platform does not say. New values may be added; treat unknown values as null.<br>One of `in_stock`, `out_of_stock`, `pre_order`, `pending`, `sold` |
| `data[].condition` | `string` or `null` | Item condition, coarse: new, used (any grade) or refurbished; null when the platform does not say. The platform's own grade is condition_label. New values may be added; treat unknown values as used.<br>One of `new`, `used`, `refurbished` |
| `data[].condition_label` | `string` or `null` | The condition as the platform labels it (Used - Like New, Used - Good, Pre-owned). |
| `data[].thumbnail_url` | `string` (uri) or `null` | Main product image URL. Platform CDN URLs can expire within hours. |
| `data[].media` | `object[]` | Product images in the platform's order (main image first), then any product video; \[\] when none. |
| `data[].media[].type` | `string` | Kind of file. New values may be added; treat unknown values as other.<br>One of `image`, `video`, `audio`, `gif` |
| `data[].media[].url` | `string` (uri) or `null` | Direct file URL; null when the platform withholds it, or when the link would only work from SocialTap's network or with a login. Often signed and expiring: see expires_at. |
| `data[].media[].expires_at` | `string` (date-time) or `null` | When url stops working, RFC 3339 UTC, read from the platform's signed URL; null when unknown or when it does not expire. |
| `data[].media[].thumbnail_url` | `string` (uri) or `null` | Poster or preview image URL. |
| `data[].media[].width` | `integer` or `null` | Width in pixels. |
| `data[].media[].height` | `integer` or `null` | Height in pixels. |
| `data[].media[].duration_ms` | `integer` or `null` | Duration in milliseconds (video and audio only). |
| `data[].media[].alt_text` | `string` or `null` | Accessibility text provided by the author or platform. |
| `data[].attributes` | `object[]` | The product's specifications as name/value pairs, in the platform's order; \[\] when none. |
| `data[].attributes[].name` | `string` | Specification name, as shown (Brand, Material, Condition). |
| `data[].attributes[].value` | `string` | Its value, as shown. |
| `data[].shipping` | `object` | Delivery terms as shown to a buyer in the product's market; each null when not shown. |
| `data[].shipping.is_offered` | `boolean` or `null` | The seller ships it (false: local pickup only). |
| `data[].shipping.fee` | `number` or `null` | Standard shipping fee in major units of the product's currency; 0 = free shipping. |
| `data[].country_code` | `string` or `null` | ISO 3166-1 alpha-2 market the product is offered in; prices, stock and shipping are that market's. |
| `data[].platform_specific` | `object` | Fields only this platform has, under its ID (platform_specific.\<platform>): TikTok Shop's brand, rating, variants, stock and units sold; Marketplace's location and listing date. Each null when unknown. |
| `data[].platform_specific.amazon` | `object` or `null` | An Amazon product's own fields. |
| `data[].platform_specific.amazon.brand` | `string` or `null` | Brand name, as Amazon shows it; null when it shows none (most books: their authors are contributors). |
| `data[].platform_specific.amazon.contributors` | `object[]` | The people the byline credits (a book's authors, narrators and translators), in Amazon's order; \[\] when the byline names none. |
| `data[].platform_specific.amazon.contributors[].name` | `string` | The contributor's name, as the byline shows it. |
| `data[].platform_specific.amazon.contributors[].role` | `string` or `null` | Their role, as Amazon words it (Author, Narrator, Translator); null when the byline gives none. |
| `data[].platform_specific.amazon.rating` | `number` or `null` | Average customer rating out of 5 (metrics.rating_count ratings behind it), as Amazon shows it, to one decimal; null when unrated. |
| `data[].platform_specific.amazon.metrics` | `object` | Counts at fetch time; null = not shown, 0 = zero. |
| `data[].platform_specific.amazon.metrics.rating_count` | `integer` or `null` | Customer ratings behind rating (with or without a written review), exact. |
| `data[].platform_specific.amazon.metrics.bought_past_month_count` | `integer` or `null` | Units bought in the past month as Amazon's badge rounds them (10K+ is 10000): a lower bound; null when the page shows no badge. |
| `data[].platform_specific.amazon.metrics.offer_count` | `integer` or `null` | Offers from every seller, new and used, as the other sellers box counts them; null when the page shows no such box. |
| `data[].platform_specific.amazon.metrics.rating_distribution` | `object` or `null` | Ratings per star, from the histogram's whole percentages times rating_count (so each can be off by half a percent of rating_count); null when unrated. |
| `data[].platform_specific.amazon.metrics.rating_distribution.one_star_count` | `integer` or `null` | Reviews rating 1 star. |
| `data[].platform_specific.amazon.metrics.rating_distribution.two_star_count` | `integer` or `null` | Reviews rating 2 stars. |
| `data[].platform_specific.amazon.metrics.rating_distribution.three_star_count` | `integer` or `null` | Reviews rating 3 stars. |
| `data[].platform_specific.amazon.metrics.rating_distribution.four_star_count` | `integer` or `null` | Reviews rating 4 stars. |
| `data[].platform_specific.amazon.metrics.rating_distribution.five_star_count` | `integer` or `null` | Reviews rating 5 stars. |
| `data[].platform_specific.amazon.features` | `string[]` | The "About this item" bullet points, in Amazon's order; \[\] when the page has none (books, most media). |
| `data[].platform_specific.amazon.is_sponsored` | `boolean` or `null` | The product is a paid placement among a search's results (Amazon labels it Sponsored); null outside search results. |
| `data[].platform_specific.amazon.categories` | `object[]` | The product's category path, from the department down to category (the last one); \[\] when the page shows none. |
| `data[].platform_specific.amazon.categories[].id` | `string` or `null` | Amazon's browse node ID of the category (what its category pages take as node=); null when the link names none. |
| `data[].platform_specific.amazon.categories[].name` | `string` | Category name, as shown. |
| `data[].platform_specific.amazon.best_sellers_ranks` | `object[]` | The product's sales rank in each category Amazon ranks it in (#49 in Electronics, #7 in Earbud & In-Ear Headphones), department first; \[\] when the page shows none. |
| `data[].platform_specific.amazon.best_sellers_ranks[].rank` | `integer` | The product's sales rank in the category (1 is the best seller). |
| `data[].platform_specific.amazon.best_sellers_ranks[].category` | `string` | Category name, as shown. |
| `data[].platform_specific.amazon.best_sellers_ranks[].category_id` | `string` or `null` | Amazon's ID of the ranking: a browse node ID, or a department's slug (electronics) for a department's rank; null when the row links none. |
| `data[].platform_specific.amazon.rank` | `integer` or `null` | Position in the requested Best Sellers or other ranked list (1 = top); null off a list. |
| `data[].platform_specific.amazon.parent_asin` | `string` or `null` | ASIN of the variation family this product belongs to (every color and size of it shares it); null for a product without variations. |
| `data[].platform_specific.amazon.variants` | `object[]` | Every variation of the product (its colors, sizes, styles), each an ASIN with its options, in Amazon's order; prices and stock are this product's only, so they are null on variants. \[\] for a product without variations. |
| `data[].platform_specific.amazon.variants[].id` | `string` | Platform-native variant (SKU) ID; review.variant_id names it. |
| `data[].platform_specific.amazon.variants[].title` | `string` or `null` | Variant name as shown, else its options joined (Color: Black, Size: M). |
| `data[].platform_specific.amazon.variants[].options` | `object[]` | The option values that make this variant (Color: Black); \[\] for a product's only variant. |
| `data[].platform_specific.amazon.variants[].options[].name` | `string` | Option name, as shown (Color, Size). |
| `data[].platform_specific.amazon.variants[].options[].value` | `string` | The variant's value of it (Black, M). |
| `data[].platform_specific.amazon.variants[].price` | `number` or `null` | Current price of this variant, in major units of the product's currency. |
| `data[].platform_specific.amazon.variants[].original_price` | `number` or `null` | This variant's price before the discount; null when no earlier price is shown. |
| `data[].platform_specific.amazon.variants[].availability` | `string` or `null` | Whether this variant can be bought now; null when not shown. New values may be added; treat unknown values as null.<br>One of `in_stock`, `out_of_stock`, `pre_order` |
| `data[].platform_specific.amazon.variants[].stock_count` | `integer` or `null` | Units in stock as the platform reports them (platforms may cap the number they show); null when hidden. |
| `data[].platform_specific.amazon.variants[].image_url` | `string` (uri) or `null` | Image of this variant (its color swatch or photo). Platform CDN URLs can expire within hours. |
| `data[].platform_specific.amazon.availability_label` | `string` or `null` | The buy box's stock line, as Amazon words it (Only 1 left in stock - order soon.); null when the page shows none. |
| `data[].platform_specific.amazon.ships_from` | `string` or `null` | Who ships the featured offer (Amazon, or the seller), as the buy box says; null when not shown. |
| `data[].platform_specific.amazon.deal` | `object` or `null` | The deal Amazon's deals list shows the product with: its type, badge, end time, share claimed and coupon; null outside a deals list. |
| `data[].platform_specific.amazon.deal.id` | `string` or `null` | Amazon's ID of the deal; null for a product listed for its coupon alone. |
| `data[].platform_specific.amazon.deal.type` | `string` | The kind of deal, as Amazon names it, lowercased: lightning_deal (a limited number of units for a few hours), best_deal (a limited time deal), others as Amazon adds them; coupon when the product is listed for its coupon alone. |
| `data[].platform_specific.amazon.deal.status` | `string` or `null` | The deal's state, as Amazon names it, lowercased (available: it can be bought at the deal price now); null for a coupon alone. |
| `data[].platform_specific.amazon.deal.badge` | `string` or `null` | The deal's badge, as shown (23% off, Up to 40% off); null when it shows none. |
| `data[].platform_specific.amazon.deal.label` | `string` or `null` | The deal's label, as shown (Limited time deal, Early Black Friday Deal, Limited Prime deal); null when the badge shows a countdown instead (see ends_at) or nothing. |
| `data[].platform_specific.amazon.deal.ends_at` | `string` (date-time) or `null` | When the deal ends, RFC 3339 UTC, from the badge's countdown; null when the badge shows none (most deals but lightning deals). |
| `data[].platform_specific.amazon.deal.claimed_percent` | `number` or `null` | Share of the deal's units already claimed, in percent (0 to 100) as Amazon rounds it; null when Amazon shows none (most deals but lightning deals). |
| `data[].platform_specific.amazon.deal.original_price_label` | `string` or `null` | What original_price is: list (the list price), typical (the typical price of the last 90 days), rrp (the recommended retail price) or was (the price before the deal); null when no earlier price is shown or Amazon labels it otherwise. New values may be added; treat unknown values as null.<br>One of `list`, `typical`, `rrp`, `was` |
| `data[].platform_specific.amazon.deal.department_ids` | `string[]` | The browse nodes Amazon's deals list files the deal under, in no particular order (one to several, from a department down to a sub-category): each is a category the Amazon Deals API takes. Empty when it names none. |
| `data[].platform_specific.amazon.deal.coupon_price` | `number` or `null` | The price after the product's clippable coupon, in major units of the product's currency; null when it has no coupon or the coupon shows no price. |
| `data[].platform_specific.amazon.deal.coupon_id` | `string` or `null` | Amazon's ID of the coupon's promotion (its page is amazon.com/promo/\<id>); null when the product has no coupon. |
| `data[].approximate_fields` | `string[]` | JSON paths of values rounded by the platform or parsed from display text ("10K+ sold"), and of Facebook's coarse listing coordinates. \[\] when all exact. |
| `data[].unknown_fields` | `string[]` | JSON paths of lists whose \[\] means unknown rather than none (a list or search result that does not show attributes or variants); null already means unknown for every other field. \[\] when every list is known. |

not_found and private_or_unavailable are item-level: the request was fine, the item can't be returned.

### 400

400 Bad Request: 2 error codes. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `invalid_input` | 400 | No | A parameter is missing or malformed, or the link is not one this endpoint takes. | Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one. |
| `invalid_cursor` | 400 | No | The cursor is malformed or expired, belongs to another endpoint, or came with other parameters than the request that returned it. | Repeat the original request without cursor to start the list again. |

### 401

401 Unauthorized: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `unauthorized` | 401 | No | The x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired. | Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url. |

### 402

402 Payment Required: 2 error codes. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `insufficient_credits` | 402 | No | The account does not have enough credits for this request. | Have a person buy credits at details.purchase_url (or make them a checkout link with details.checkout), then repeat the request. Do not retry automatically. |
| `spend_limit_reached` | 402 | No | The API key reached its spend limit for this period. The account may still have credits. | Wait until details.resets_at, or raise the key's spend limit (PATCH /v1/api_keys/{id}). Do not retry automatically. |

### 403

403 Forbidden: 2 error codes. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `forbidden` | 403 | No | The API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, waits for its owner to confirm it by email, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item: a private item is private_or_unavailable, also 403, so branch on the code. | Act on details.reason. suspended: contact [support](mailto:support@socialtap.dev). scope: use a key with details.required_scope. previous_secret: use the new secret. key_pending: have the owner open the emailed link. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP. |
| `private_or_unavailable` | 403 | No | The item exists but is not public: it is private, age- or region-restricted, or needs a login to view. It shares 403 with forbidden (which is about the key), so branch on the code. | Only public items can be fetched. Do not retry. |

### 404

404 Not Found: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `not_found` | 404 | No | The item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why). | Check the link or ID. Do not retry. |

### 429

429 Too Many Requests: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `rate_limited` | 429 | Yes, later | The account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it. | Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask [support](mailto:support@socialtap.dev) to raise the ceiling; without an API key, send one. |

### 500

500 Internal Error: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `internal` | 500 | Yes, later | An unexpected error on SocialTap's side. | Retry with backoff. If it keeps happening, contact [support](mailto:support@socialtap.dev) with the request_id. |

### 502

502 Bad Gateway: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `upstream_error` | 502 | Yes, later | The platform failed, or answered with something we could not read. | Retry with backoff. Failed requests are free. |

### 503

503 Unavailable: 2 error codes. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `upstream_blocked` | 503 | Yes, later | The platform refused every attempt, our own retries included. | Retry later with backoff. Failed requests are free. |
| `overloaded` | 503 | Yes, later | SocialTap was at capacity, or paused by its operators, and did not start the request. Nothing was fetched or charged. | Retry after the seconds in the retry-after header. Failed requests are free. |

## Pagination

Items come in pages, **Amazon's rank in the list (1 = top)**. To get the next page, send **the same request plus `cursor`** set to `page.next_cursor` from the previous response. Keep every other parameter the same (limit, max_age and fields may change); anything else that differs is rejected. When `page.has_more` is `false` the walk is over, and `page.end_reason` says why: only `end` means you have every item (the others say the platform or a page cap stopped the walk early).

- **Order**: Amazon's rank in the list (1 = top)
- **Page size**: Up to 50 top 100 products (the default; `limit` lowers it)
- **Cursor lifetime**: 24 hours; don't store cursors
- **Price**: Per page, 1 credit

### The `page` object

| Field | Type | Description |
| --- | --- | --- |
| `page.has_more` | `boolean` | True when another page exists; then next_cursor is set. An empty page with has_more true is not the end. |
| `page.next_cursor` | `string` or `null` | Pass as cursor, with the same other parameters, to get the next page; null at the end. |
| `page.next_cursor_expires_at` | `string` (date-time) or `null` | When next_cursor stops working, RFC 3339 UTC; null at the end. Don't store cursors. |
| `page.end_reason` | `string` or `null` | Why there are no more pages; null while has_more is true. end: the list ended, or reached since/until. platform_limit: the platform stops serving further pages although the list goes on. max_pages: SocialTap's cap on pages in one walk. New values may be added. A short or empty page is not the end: only has_more false is.<br>One of `end`, `platform_limit`, `max_pages` |

### Next page

cURL: next page:

```shell
curl 'https://socialtap.dev/v1/amazon/top_products?category=electronics&cursor=c1.EXAMPLE_CURSOR' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
```

- The price is per page: each successful page costs the same, whatever `limit` is and however many items it has. Empty pages are charged too (an empty page with `has_more: true` is not the end).
- A `limit` below 50 doesn't save credits: the next request serves the rest of the same platform page, which is fetched again and charged as a page each time, and items can shift between those requests if the platform changes the list. Omitting `limit` is the cheapest way to walk the list.
- Errors are free, including a rejected cursor.
- Pages served from the cache are free.
- An expired or altered cursor, or one sent with different parameters, fails with [`invalid_cursor`](https://socialtap.dev/docs/errors/index.md#invalid_cursor) (HTTP 400): Repeat the original request without cursor to start the list again.

[Pagination guide](https://socialtap.dev/docs/pagination/index.md)

## Pricing

From **1 credit** per page. Charged per successful page, whatever its number of items. Errors are free. The price depends on the source that produced the result, reported as `meta.source`.

| Source | Price per successful page | Per 1,000 pages |
| --- | --- | --- |
| Public page `page` | 1 credit | $0.75–$1.97 |

**Balance, sources and what you were charged**

Your balance must be at least **1 credit** to start a request; with less, it is refused with [`insufficient_credits`](https://socialtap.dev/docs/errors/index.md#insufficient_credits) (HTTP 402) and costs nothing. Only that minimum is set aside when the request starts.

| meta.source | Source | What it means |
| --- | --- | --- |
| `page` | Public page | Data embedded in the platform's public web page. |

`meta.credits_charged` and the `x-credits-charged` header show what you paid. [How credits work](https://socialtap.dev/docs/credits/index.md) · [Packs](https://socialtap.dev/pricing/index.md)

Endpoint ID `amazon.top_products` · operationId `amazon.top_products.list` · [Product overview](https://socialtap.dev/apis/amazon/top_products/index.md)

---

[HTML version](https://socialtap.dev/docs/reference/amazon/top_products/) · [Docs index for AI agents](https://socialtap.dev/llms.txt) · [All docs in one file](https://socialtap.dev/llms-full.txt)
