Amazon

Amazon Deals API

Returns Amazon's Today's Deals on any Amazon marketplace, all deals or one category's, in Amazon's own order. Each product has its deal price and the list or typical price it beats, the deal's type, badge and end time, the share of a lightning deal claimed, and any coupon's price. You also get the title, image, brand and star rating with its exact count.

GET /v1/amazon/deal_products

Try it

Example

cURL

curl 'https://socialtap.dev/v1/amazon/deal_products' \
  -H "x-api-key: $SOCIALTAP_API_KEY"

TypeScript SDK

import { SocialTap } from "socialtap";

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

const res = await client.amazon.dealProducts.list({});
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);

Node.js (fetch)

const params = new URLSearchParams({
});
const res = await fetch(`https://socialtap.dev/v1/amazon/deal_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)

import os

import requests

res = requests.get(
    "https://socialtap.dev/v1/amazon/deal_products",
    params={},
    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)

package main

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

func main() {
	q := url.Values{}
	req, err := http.NewRequest("GET", "https://socialtap.dev/v1/amazon/deal_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"])
}

PHP

<?php

$query = http_build_query([
]);
$ch = curl_init('https://socialtap.dev/v1/amazon/deal_products?' . $query);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['x-api-key: ' . getenv('SOCIALTAP_API_KEY')],
]);
$body = json_decode(curl_exec($ch), true);
if (curl_getinfo($ch, CURLINFO_RESPONSE_CODE) >= 400) {
    throw new RuntimeException($body['error']['code'] . ': ' . $body['error']['message']);
}
print_r($body['data']);
echo $body['meta']['credits_charged'], PHP_EOL;

Ruby

require "json"
require "net/http"

uri = URI("https://socialtap.dev/v1/amazon/deal_products")
uri.query = URI.encode_www_form()
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = ENV.fetch("SOCIALTAP_API_KEY")
res = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") { |http| http.request(req) }
body = JSON.parse(res.body)
raise "#{body["error"]["code"]}: #{body["error"]["message"]}" unless res.is_a?(Net::HTTPSuccess)
pp body["data"]
puts body["meta"]["credits_charged"]

Java

import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;

public class Main {
    public static void main(String[] args) throws Exception {
        String query = "";
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://socialtap.dev/v1/amazon/deal_products?" + query))
            .header("x-api-key", System.getenv("SOCIALTAP_API_KEY"))
            .GET()
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        // An error is {"error": {"code", "message", ...}}; success is {data, meta}, meta.credits_charged its price.
        if (response.statusCode() >= 400) throw new RuntimeException(response.body());
        System.out.println(response.body());
    }

    static String encode(String value) {
        return URLEncoder.encode(value, StandardCharsets.UTF_8);
    }
}

.NET

using System.Text.Json;

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("x-api-key", Environment.GetEnvironmentVariable("SOCIALTAP_API_KEY"));

var query = string.Join("&",);
var res = await http.GetAsync("https://socialtap.dev/v1/amazon/deal_products?" + query);
using var body = JsonDocument.Parse(await res.Content.ReadAsStringAsync());
if (!res.IsSuccessStatusCode)
{
    var error = body.RootElement.GetProperty("error");
    throw new Exception($"{error.GetProperty("code")}: {error.GetProperty("message")}");
}
Console.WriteLine(body.RootElement.GetProperty("data"));
Console.WriteLine(body.RootElement.GetProperty("meta").GetProperty("credits_charged"));

Rust

// Cargo.toml: reqwest = { version = "0.12", features = ["blocking", "json"] }, serde_json = "1"
use std::env;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let res = reqwest::blocking::Client::new()
        .get("https://socialtap.dev/v1/amazon/deal_products")
        .query(&[])
        .header("x-api-key", env::var("SOCIALTAP_API_KEY")?)
        .send()?;
    let ok = res.status().is_success();
    let body: serde_json::Value = res.json()?;
    if !ok {
        return Err(format!("{}: {}", body["error"]["code"], body["error"]["message"]).into());
    }
    println!("{} {}", body["data"], body["meta"]["credits_charged"]);
    Ok(())
}

200 OK

{
  "data": [
    {
      "approximate_fields": [
        "platform_specific.amazon.rating",
        "platform_specific.amazon.metrics.rating_distribution"
      ],
      "attributes": [],
      "availability": "in_stock",
      "category": null,
      "category_id": null,
      "condition": "new",
      "condition_label": null,
      "country_code": "US",
      "currency": "USD",
      "description": null,
      "id": "B0G2D1R15Q",
      "max_price": null,
      "media": [],
      "original_price": 99.99,
      "platform": "amazon",
      "platform_specific": {
        "amazon": {
          "availability_label": null,
          "best_sellers_ranks": [],
          "brand": "Ring",
          "categories": [],
          "contributors": [],
          "deal": {
            "badge": "60% off",
            "claimed_percent": null,
            "coupon_id": null,
            "coupon_price": null,
            "department_ids": [
              "16333372011",
              "172282",
              "493964"
            ],
            "ends_at": null,
            "id": "d0d0a6d6",
            "label": "Early Black Friday Deal",
            "original_price_label": "typical",
            "status": "available",
            "type": "best_deal"
          },
          "features": [],
          "is_sponsored": null,
          "metrics": {
            "bought_past_month_count": null,
            "offer_count": null,
            "rating_count": 8694,
            "rating_distribution": {
              "five_star_count": 6260,
              "four_star_count": 696,
              "one_star_count": 956,
              "three_star_count": 522,
              "two_star_count": 261
            }
          },
          "parent_asin": null,
          "rank": null,
          "rating": 4.2,
          "ships_from": null,
          "variants": []
        }
      },
      "price": 39.99,
      "seller": null,
      "shipping": {
        "fee": null,
        "is_offered": null
      },
      "thumbnail_url": "https://m.media-amazon.com/images/I/51kY6VkfPeL.jpg",
      "title": "Ring Battery Doorbell 2K (newest model), Matte Mocha",
      "type": "product",
      "unknown_fields": [
        "media",
        "attributes",
        "platform_specific.amazon.contributors"
      ],
      "url": "https://www.amazon.com/dp/B0G2D1R15Q"
    },
    {
      "approximate_fields": [
        "platform_specific.amazon.rating",
        "platform_specific.amazon.metrics.rating_distribution"
      ],
      "attributes": [],
      "availability": "in_stock",
      "category": null,
      "category_id": null,
      "condition": "new",
      "condition_label": null,
      "country_code": "US",
      "currency": "USD",
      "description": null,
      "id": "B0CHDM8VVZ",
      "max_price": null,
      "media": [],
      "original_price": 399,
      "platform": "amazon",
      "platform_specific": {
        "amazon": {
          "availability_label": null,
          "best_sellers_ranks": [],
          "brand": "Bambu Lab",
          "categories": [],
          "contributors": [],
          "deal": {
            "badge": "13% off",
            "claimed_percent": null,
            "coupon_id": null,
            "coupon_price": null,
            "department_ids": [
              "16310091",
              "16310161"
            ],
            "ends_at": null,
            "id": "23721016",
            "label": "Limited time deal",
            "original_price_label": "list",
            "status": "available",
            "type": "best_deal"
          },
          "features": [],
          "is_sponsored": null,
          "metrics": {
            "bought_past_month_count": null,
            "offer_count": null,
            "rating_count": 444,
            "rating_distribution": {
              "five_star_count": 355,
              "four_star_count": 22,
              "one_star_count": 36,
              "three_star_count": 27,
              "two_star_count": 4
            }
          },
          "parent_asin": null,
          "rank": null,
          "rating": 4.5,
          "ships_from": null,
          "variants": []
        }
      },
      "price": 349,
      "seller": null,
      "shipping": {
        "fee": null,
        "is_offered": null
      },
      "thumbnail_url": "https://m.media-amazon.com/images/I/61IXKmM4f9L.jpg",
      "title": "Bambu Lab P1S 3D Printer, Ready-to-Use FDM 3D Printer | Beginner-Friendly Ecosystem with MakerWorld Model Library, Enclosed CoreXY, High Speed & Precision Printing",
      "type": "product",
      "unknown_fields": [
        "media",
        "attributes",
        "platform_specific.amazon.contributors"
      ],
      "url": "https://www.amazon.com/dp/B0CHDM8VVZ"
    },
    {
      "approximate_fields": [
        "platform_specific.amazon.rating",
        "platform_specific.amazon.metrics.rating_distribution"
      ],
      "attributes": [],
      "availability": "in_stock",
      "category": null,
      "category_id": null,
      "condition": "new",
      "condition_label": null,
      "country_code": "US",
      "currency": "USD",
      "description": null,
      "id": "B0FQV6LMVX",
      "max_price": null,
      "media": [],
      "original_price": 1199,
      "platform": "amazon",
      "platform_specific": {
        "amazon": {
          "availability_label": null,
          "best_sellers_ranks": [],
          "brand": "EF ECOFLOW",
          "categories": [],
          "contributors": [],
          "deal": {
            "badge": "27% off",
            "claimed_percent": null,
            "coupon_id": null,
            "coupon_price": null,
            "department_ids": [
              "16310091",
              "16310161",
              "2972638011"
            ],
            "ends_at": null,
            "id": "ee891d27",
            "label": "Limited time deal",
            "original_price_label": "list",
            "status": "available",
            "type": "best_deal"
          },
          "features": [],
          "is_sponsored": null,
          "metrics": {
            "bought_past_month_count": null,
            "offer_count": null,
            "rating_count": 661,
            "rating_distribution": {
              "five_star_count": 582,
              "four_star_count": 40,
              "one_star_count": 26,
              "three_star_count": 13,
              "two_star_count": 0
            }
          },
          "parent_asin": null,
          "rank": null,
          "rating": 4.7,
          "ships_from": null,
          "variants": []
        }
      },
      "price": 878.99,
      "seller": null,
      "shipping": {
        "fee": null,
        "is_offered": null
      },
      "thumbnail_url": "https://m.media-amazon.com/images/I/61XcQS5XuML.jpg",
      "title": "EF ECOFLOW DELTA 3 Max Portable Power Station, 2048Wh LFP Battery, 2400W | 3400W X-Boost Output, Ultra-Fast 0-80% Charging in 1.13 Hr, Home Backup & RV Camping, Solar Generator (Solar Panel Optional)",
      "type": "product",
      "unknown_fields": [
        "media",
        "attributes",
        "platform_specific.amazon.contributors"
      ],
      "url": "https://www.amazon.com/dp/B0FQV6LMVX"
    }
  ],
  "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": "api",
    "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.

Authorizations

x-api-keystringheaderrequired

Your API key. Authentication

Query parameters

countrystringiso3166-1-alpha-2

Region: an ISO 3166-1 alpha-2 country code such as US or BR (case-insensitive). The Amazon marketplace whose deals to read, by country: US (amazon.com), GB (amazon.co.uk), DE, JP, IN, … Prices are that marketplace's, in its currency. Default: the category link's marketplace, else US. A country other than the category link's is refused.

ExampleUS

categorystringmax 2,048 chars

Only the deals of one category: its browse node ID (172282 is Electronics on amazon.com), or a link that names one: a category link (amazon.com/b?node=172282), a search link filtered to a department, or a Today's Deals link with a department picked (its price and discount filters aren't applied). A product's platform_specific.amazon.categories[].id and a deal's platform_specific.amazon.deal.department_ids are such IDs. Omit for every deal. Browse nodes are each marketplace's own.

Example172282

limitintegermin 1max 100

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.

Example100

cursorstring

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). limit and cursor page through the list: see Pagination.

Parameters every endpoint accepts

max_ageintegermin 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.

fieldsstring

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

application/json

200

{data, page, meta}. data is an array of up to 100 product objects, Amazon's Today's Deals order (its own ranking, as the grid shows it); page says how to get the next page; meta describes the request (meta). Fields only Amazon has are under platform_specific.amazon.

platformstring

Platform ID (tiktokshop, facebook, …).

idstring

Platform-native product or listing ID (string).

urlstring uri

Canonical product page URL.

typestring

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.

One ofproductlisting

titlestring

Product name or listing title, as the seller wrote it.

descriptionstringnullable

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).

categorystringnullable

The platform's most specific category label (Bicycles, Vitamins & Supplements), as shown; not normalized across platforms.

category_idstringnullable

The platform's ID of that category (what its category browsing and filters take).

sellerobjectnullable

The shop or account selling it; null only when the source does not show it.

Show 6 child fields

idstringnullable

Platform-native account ID; null when only the handle is known.

usernamestringnullable

Handle without the @; null when the account has none.

display_namestringnullable

Display name shown on the profile.

urlstring urinullable

Canonical profile URL.

avatar_urlstring urinullable

Profile picture URL. Platform CDN URLs can expire within hours.

is_verifiedbooleannullable

Platform verification badge; null where the platform has no badge.

pricenumbernullable

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.

max_pricenumbernullable

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).

original_pricenumbernullable

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).

currencystringnullable

ISO 4217 code of every amount of this product (USD); null when no amount is shown.

availabilitystringnullable

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.

One ofin_stockout_of_stockpre_orderpendingsold

conditionstringnullable

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.

One ofnewusedrefurbished

condition_labelstringnullable

The condition as the platform labels it (Used - Like New, Used - Good, Pre-owned).

thumbnail_urlstring urinullable

Main product image URL. Platform CDN URLs can expire within hours.

mediaobject[]

Product images in the platform's order (main image first), then any product video; [] when none.

Show 8 child fields

typestring

Kind of file. New values may be added; treat unknown values as other.

One ofimagevideoaudiogif

urlstring urinullable

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.

expires_atstring date-timenullable

When url stops working, RFC 3339 UTC, read from the platform's signed URL; null when unknown or when it does not expire.

thumbnail_urlstring urinullable

Poster or preview image URL.

widthintegernullable

Width in pixels.

heightintegernullable

Height in pixels.

duration_msintegernullable

Duration in milliseconds (video and audio only).

alt_textstringnullable

Accessibility text provided by the author or platform.

attributesobject[]

The product's specifications as name/value pairs, in the platform's order; [] when none.

Show 2 child fields

namestring

Specification name, as shown (Brand, Material, Condition).

valuestring

Its value, as shown.

shippingobject

Delivery terms as shown to a buyer in the product's market; each null when not shown.

Show 2 child fields

is_offeredbooleannullable

The seller ships it (false: local pickup only).

feenumbernullable

Standard shipping fee in major units of the product's currency; 0 = free shipping.

country_codestringnullable

ISO 3166-1 alpha-2 market the product is offered in; prices, stock and shipping are that market's.

platform_specificobject

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.

Show 1 child field

amazonobjectnullable

An Amazon product's own fields.

Show 14 child fields

brandstringnullable

Brand name, as Amazon shows it; null when it shows none (most books: their authors are contributors).

contributorsobject[]

The people the byline credits (a book's authors, narrators and translators), in Amazon's order; [] when the byline names none.

Show 2 child fields

namestring

The contributor's name, as the byline shows it.

rolestringnullable

Their role, as Amazon words it (Author, Narrator, Translator); null when the byline gives none.

ratingnumbernullable

Average customer rating out of 5 (metrics.rating_count ratings behind it), as Amazon shows it, to one decimal; null when unrated.

metricsobject

Counts at fetch time; null = not shown, 0 = zero.

Show 4 child fields

rating_countintegernullable

Customer ratings behind rating (with or without a written review), exact.

bought_past_month_countintegernullable

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.

offer_countintegernullable

Offers from every seller, new and used, as the other sellers box counts them; null when the page shows no such box.

rating_distributionobjectnullable

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.

Show 5 child fields

one_star_countintegernullable

Reviews rating 1 star.

two_star_countintegernullable

Reviews rating 2 stars.

three_star_countintegernullable

Reviews rating 3 stars.

four_star_countintegernullable

Reviews rating 4 stars.

five_star_countintegernullable

Reviews rating 5 stars.

featuresstring[]

The "About this item" bullet points, in Amazon's order; [] when the page has none (books, most media).

is_sponsoredbooleannullable

The product is a paid placement among a search's results (Amazon labels it Sponsored); null outside search results.

categoriesobject[]

The product's category path, from the department down to category (the last one); [] when the page shows none.

Show 2 child fields

idstringnullable

Amazon's browse node ID of the category (what its category pages take as node=); null when the link names none.

namestring

Category name, as shown.

best_sellers_ranksobject[]

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.

Show 3 child fields

rankinteger

The product's sales rank in the category (1 is the best seller).

categorystring

Category name, as shown.

category_idstringnullable

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.

rankintegernullable

Position in the requested Best Sellers or other ranked list (1 = top); null off a list.

parent_asinstringnullable

ASIN of the variation family this product belongs to (every color and size of it shares it); null for a product without variations.

variantsobject[]

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.

Show 8 child fields

idstring

Platform-native variant (SKU) ID; review.variant_id names it.

titlestringnullable

Variant name as shown, else its options joined (Color: Black, Size: M).

optionsobject[]

The option values that make this variant (Color: Black); [] for a product's only variant.

Show 2 child fields

namestring

Option name, as shown (Color, Size).

valuestring

The variant's value of it (Black, M).

pricenumbernullable

Current price of this variant, in major units of the product's currency.

original_pricenumbernullable

This variant's price before the discount; null when no earlier price is shown.

availabilitystringnullable

Whether this variant can be bought now; null when not shown. New values may be added; treat unknown values as null.

One ofin_stockout_of_stockpre_order

stock_countintegernullable

Units in stock as the platform reports them (platforms may cap the number they show); null when hidden.

image_urlstring urinullable

Image of this variant (its color swatch or photo). Platform CDN URLs can expire within hours.

availability_labelstringnullable

The buy box's stock line, as Amazon words it (Only 1 left in stock - order soon.); null when the page shows none.

ships_fromstringnullable

Who ships the featured offer (Amazon, or the seller), as the buy box says; null when not shown.

dealobjectnullable

The deal Amazon's deals list shows the product with: its type, badge, end time, share claimed and coupon; null outside a deals list.

Show 11 child fields

idstringnullable

Amazon's ID of the deal; null for a product listed for its coupon alone.

typestring

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.

statusstringnullable

The deal's state, as Amazon names it, lowercased (available: it can be bought at the deal price now); null for a coupon alone.

badgestringnullable

The deal's badge, as shown (23% off, Up to 40% off); null when it shows none.

labelstringnullable

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.

ends_atstring date-timenullable

When the deal ends, RFC 3339 UTC, from the badge's countdown; null when the badge shows none (most deals but lightning deals).

claimed_percentnumbernullable

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).

original_price_labelstringnullable

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.

One oflisttypicalrrpwas

department_idsstring[]

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.

coupon_pricenumbernullable

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.

coupon_idstringnullable

Amazon's ID of the coupon's promotion (its page is amazon.com/promo/<id>); null when the product has no coupon.

approximate_fieldsstring[]

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.

unknown_fieldsstring[]

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.

invalid_inputNo retry

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_cursorNo retry

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.

unauthorizedNo retry

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.

insufficient_creditsNo retry

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_reachedNo retry

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.

forbiddenNo retry

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. 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_unavailableNo retry

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.

not_foundNo retry

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.

rate_limitedYes, 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 to raise the ceiling; without an API key, send one.

500

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

internalYes, later

An unexpected error on SocialTap's side.

Retry with backoff. If it keeps happening, contact support with the request_id.

502

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

upstream_errorYes, 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.

upstream_blockedYes, later

The platform refused every attempt, our own retries included.

Retry later with backoff. Failed requests are free.

overloadedYes, 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 Today's Deals order (its own ranking, as the grid shows it). 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 Today's Deals order (its own ranking, as the grid shows it)
Page size: Up to 100 deals (the default; limit lowers it)
Cursor lifetime: 1 hour; don't store cursors
Price: Per page, 1 credit

The `page` object

has_moreboolean

True when another page exists; then next_cursor is set. An empty page with has_more true is not the end.

next_cursorstringnullable

Pass as cursor, with the same other parameters, to get the next page; null at the end.

next_cursor_expires_atstring date-timenullable

When next_cursor stops working, RFC 3339 UTC; null at the end. Don't store cursors.

end_reasonstringnullable

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.

One ofendplatform_limitmax_pages

cURL: next page

curl 'https://socialtap.dev/v1/amazon/deal_products?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 100 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 (HTTP 400): Repeat the original request without cursor to start the list again.

Pagination guide

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; sources are tried cheapest first: Platform API → Public page.

Source	Price per successful page	Per 1,000 pages
Platform API `api`	1 credit	$0.75–$1.97
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 (HTTP 402) and costs nothing. Only that minimum is set aside when the request starts.

meta.source	Source	What it means
`api`	Platform API	The platform's public, logged-out API.
`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 · Packs

Endpoint ID amazon.deal_products · operationId amazon.deal_products.list · Product overview

cURL

curl 'https://socialtap.dev/v1/amazon/deal_products' \
  -H "x-api-key: $SOCIALTAP_API_KEY"

TypeScript SDK

import { SocialTap } from "socialtap";

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

const res = await client.amazon.dealProducts.list({});
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);

Node.js (fetch)

const params = new URLSearchParams({
});
const res = await fetch(`https://socialtap.dev/v1/amazon/deal_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)

import os

import requests

res = requests.get(
    "https://socialtap.dev/v1/amazon/deal_products",
    params={},
    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)

package main

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

func main() {
	q := url.Values{}
	req, err := http.NewRequest("GET", "https://socialtap.dev/v1/amazon/deal_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"])
}

PHP

<?php

$query = http_build_query([
]);
$ch = curl_init('https://socialtap.dev/v1/amazon/deal_products?' . $query);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['x-api-key: ' . getenv('SOCIALTAP_API_KEY')],
]);
$body = json_decode(curl_exec($ch), true);
if (curl_getinfo($ch, CURLINFO_RESPONSE_CODE) >= 400) {
    throw new RuntimeException($body['error']['code'] . ': ' . $body['error']['message']);
}
print_r($body['data']);
echo $body['meta']['credits_charged'], PHP_EOL;

Ruby

require "json"
require "net/http"

uri = URI("https://socialtap.dev/v1/amazon/deal_products")
uri.query = URI.encode_www_form()
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = ENV.fetch("SOCIALTAP_API_KEY")
res = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") { |http| http.request(req) }
body = JSON.parse(res.body)
raise "#{body["error"]["code"]}: #{body["error"]["message"]}" unless res.is_a?(Net::HTTPSuccess)
pp body["data"]
puts body["meta"]["credits_charged"]

Java

import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;

public class Main {
    public static void main(String[] args) throws Exception {
        String query = "";
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://socialtap.dev/v1/amazon/deal_products?" + query))
            .header("x-api-key", System.getenv("SOCIALTAP_API_KEY"))
            .GET()
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        // An error is {"error": {"code", "message", ...}}; success is {data, meta}, meta.credits_charged its price.
        if (response.statusCode() >= 400) throw new RuntimeException(response.body());
        System.out.println(response.body());
    }

    static String encode(String value) {
        return URLEncoder.encode(value, StandardCharsets.UTF_8);
    }
}

.NET

using System.Text.Json;

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("x-api-key", Environment.GetEnvironmentVariable("SOCIALTAP_API_KEY"));

var query = string.Join("&",);
var res = await http.GetAsync("https://socialtap.dev/v1/amazon/deal_products?" + query);
using var body = JsonDocument.Parse(await res.Content.ReadAsStringAsync());
if (!res.IsSuccessStatusCode)
{
    var error = body.RootElement.GetProperty("error");
    throw new Exception($"{error.GetProperty("code")}: {error.GetProperty("message")}");
}
Console.WriteLine(body.RootElement.GetProperty("data"));
Console.WriteLine(body.RootElement.GetProperty("meta").GetProperty("credits_charged"));

Rust

// Cargo.toml: reqwest = { version = "0.12", features = ["blocking", "json"] }, serde_json = "1"
use std::env;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let res = reqwest::blocking::Client::new()
        .get("https://socialtap.dev/v1/amazon/deal_products")
        .query(&[])
        .header("x-api-key", env::var("SOCIALTAP_API_KEY")?)
        .send()?;
    let ok = res.status().is_success();
    let body: serde_json::Value = res.json()?;
    if !ok {
        return Err(format!("{}: {}", body["error"]["code"], body["error"]["message"]).into());
    }
    println!("{} {}", body["data"], body["meta"]["credits_charged"]);
    Ok(())
}

200

200 OK

{
  "data": [
    {
      "approximate_fields": [
        "platform_specific.amazon.rating",
        "platform_specific.amazon.metrics.rating_distribution"
      ],
      "attributes": [],
      "availability": "in_stock",
      "category": null,
      "category_id": null,
      "condition": "new",
      "condition_label": null,
      "country_code": "US",
      "currency": "USD",
      "description": null,
      "id": "B0G2D1R15Q",
      "max_price": null,
      "media": [],
      "original_price": 99.99,
      "platform": "amazon",
      "platform_specific": {
        "amazon": {
          "availability_label": null,
          "best_sellers_ranks": [],
          "brand": "Ring",
          "categories": [],
          "contributors": [],
          "deal": {
            "badge": "60% off",
            "claimed_percent": null,
            "coupon_id": null,
            "coupon_price": null,
            "department_ids": [
              "16333372011",
              "172282",
              "493964"
            ],
            "ends_at": null,
            "id": "d0d0a6d6",
            "label": "Early Black Friday Deal",
            "original_price_label": "typical",
            "status": "available",
            "type": "best_deal"
          },
          "features": [],
          "is_sponsored": null,
          "metrics": {
            "bought_past_month_count": null,
            "offer_count": null,
            "rating_count": 8694,
            "rating_distribution": {
              "five_star_count": 6260,
              "four_star_count": 696,
              "one_star_count": 956,
              "three_star_count": 522,
              "two_star_count": 261
            }
          },
          "parent_asin": null,
          "rank": null,
          "rating": 4.2,
          "ships_from": null,
          "variants": []
        }
      },
      "price": 39.99,
      "seller": null,
      "shipping": {
        "fee": null,
        "is_offered": null
      },
      "thumbnail_url": "https://m.media-amazon.com/images/I/51kY6VkfPeL.jpg",
      "title": "Ring Battery Doorbell 2K (newest model), Matte Mocha",
      "type": "product",
      "unknown_fields": [
        "media",
        "attributes",
        "platform_specific.amazon.contributors"
      ],
      "url": "https://www.amazon.com/dp/B0G2D1R15Q"
    },
    {
      "approximate_fields": [
        "platform_specific.amazon.rating",
        "platform_specific.amazon.metrics.rating_distribution"
      ],
      "attributes": [],
      "availability": "in_stock",
      "category": null,
      "category_id": null,
      "condition": "new",
      "condition_label": null,
      "country_code": "US",
      "currency": "USD",
      "description": null,
      "id": "B0CHDM8VVZ",
      "max_price": null,
      "media": [],
      "original_price": 399,
      "platform": "amazon",
      "platform_specific": {
        "amazon": {
          "availability_label": null,
          "best_sellers_ranks": [],
          "brand": "Bambu Lab",
          "categories": [],
          "contributors": [],
          "deal": {
            "badge": "13% off",
            "claimed_percent": null,
            "coupon_id": null,
            "coupon_price": null,
            "department_ids": [
              "16310091",
              "16310161"
            ],
            "ends_at": null,
            "id": "23721016",
            "label": "Limited time deal",
            "original_price_label": "list",
            "status": "available",
            "type": "best_deal"
          },
          "features": [],
          "is_sponsored": null,
          "metrics": {
            "bought_past_month_count": null,
            "offer_count": null,
            "rating_count": 444,
            "rating_distribution": {
              "five_star_count": 355,
              "four_star_count": 22,
              "one_star_count": 36,
              "three_star_count": 27,
              "two_star_count": 4
            }
          },
          "parent_asin": null,
          "rank": null,
          "rating": 4.5,
          "ships_from": null,
          "variants": []
        }
      },
      "price": 349,
      "seller": null,
      "shipping": {
        "fee": null,
        "is_offered": null
      },
      "thumbnail_url": "https://m.media-amazon.com/images/I/61IXKmM4f9L.jpg",
      "title": "Bambu Lab P1S 3D Printer, Ready-to-Use FDM 3D Printer | Beginner-Friendly Ecosystem with MakerWorld Model Library, Enclosed CoreXY, High Speed & Precision Printing",
      "type": "product",
      "unknown_fields": [
        "media",
        "attributes",
        "platform_specific.amazon.contributors"
      ],
      "url": "https://www.amazon.com/dp/B0CHDM8VVZ"
    },
    {
      "approximate_fields": [
        "platform_specific.amazon.rating",
        "platform_specific.amazon.metrics.rating_distribution"
      ],
      "attributes": [],
      "availability": "in_stock",
      "category": null,
      "category_id": null,
      "condition": "new",
      "condition_label": null,
      "country_code": "US",
      "currency": "USD",
      "description": null,
      "id": "B0FQV6LMVX",
      "max_price": null,
      "media": [],
      "original_price": 1199,
      "platform": "amazon",
      "platform_specific": {
        "amazon": {
          "availability_label": null,
          "best_sellers_ranks": [],
          "brand": "EF ECOFLOW",
          "categories": [],
          "contributors": [],
          "deal": {
            "badge": "27% off",
            "claimed_percent": null,
            "coupon_id": null,
            "coupon_price": null,
            "department_ids": [
              "16310091",
              "16310161",
              "2972638011"
            ],
            "ends_at": null,
            "id": "ee891d27",
            "label": "Limited time deal",
            "original_price_label": "list",
            "status": "available",
            "type": "best_deal"
          },
          "features": [],
          "is_sponsored": null,
          "metrics": {
            "bought_past_month_count": null,
            "offer_count": null,
            "rating_count": 661,
            "rating_distribution": {
              "five_star_count": 582,
              "four_star_count": 40,
              "one_star_count": 26,
              "three_star_count": 13,
              "two_star_count": 0
            }
          },
          "parent_asin": null,
          "rank": null,
          "rating": 4.7,
          "ships_from": null,
          "variants": []
        }
      },
      "price": 878.99,
      "seller": null,
      "shipping": {
        "fee": null,
        "is_offered": null
      },
      "thumbnail_url": "https://m.media-amazon.com/images/I/61XcQS5XuML.jpg",
      "title": "EF ECOFLOW DELTA 3 Max Portable Power Station, 2048Wh LFP Battery, 2400W | 3400W X-Boost Output, Ultra-Fast 0-80% Charging in 1.13 Hr, Home Backup & RV Camping, Solar Generator (Solar Panel Optional)",
      "type": "product",
      "unknown_fields": [
        "media",
        "attributes",
        "platform_specific.amazon.contributors"
      ],
      "url": "https://www.amazon.com/dp/B0FQV6LMVX"
    }
  ],
  "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": "api",
    "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": []
  }
}

404

404 not_found

{
  "error": {
    "code": "not_found",
    "message": "The item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why).",
    "request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f",
    "status": 404,
    "retryable": false,
    "param": null,
    "remediation": "Check the link or ID. Do not retry.",
    "doc_url": "https://socialtap.dev/docs/errors/#not_found",
    "details": {},
    "charged": false
  }
}

400

400 invalid_input

{
  "error": {
    "code": "invalid_input",
    "message": "A parameter is missing or malformed, or the link is not one this endpoint takes.",
    "request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f",
    "status": 400,
    "retryable": false,
    "param": null,
    "remediation": "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.",
    "doc_url": "https://socialtap.dev/docs/errors/#invalid_input",
    "details": {},
    "charged": false
  }
}

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

Example

Authorizations

Query parameters

Response

200

400

401

402

403

404

429

500

502

503

Pagination

The page object

Next page

Pricing

The `page` object