Quickstart

Sign-up to first API call in under 90 seconds.

1. Create an account

2. Mint an API key

From the dashboard, go to API Keys and click Create new key. Keys are prefixed with rk_live_ and shown once at creation. Copy and store securely.

You can rotate keys at any time. Revoking a key takes effect within 60 seconds.

3. Call the API

curl -H "Authorization: Bearer rk_live_YOUR_KEY" \
  "https://api.retailerapi.com/v1/products/19667262713"

Expected response shape:

{
  "item_id": "19667262713",
  "title": "12-in-1 Electric Pressure Cooker 6 QT...",
  "brand": "Cooks Essentials",
  "image_url": "https://i5.walmartimages.com/...",
  "current_price": 100.56,
  "buybox_price": 100.56,
  "offers_count": 4,
  "total_offers": 6,
  "walmart_url": "https://www.walmart.com/ip/...",
  "tokens_consumed": 1,
  "tokens_remaining": 999
}

4. Add cross-retailer enrichment

curl -H "Authorization: Bearer rk_live_YOUR_KEY" \
  "https://api.retailerapi.com/v1/products/19667262713?include_cross_retailer=true"

Response now includes a cross_retailer map keyed by retailer slug with current price + URL + Bucket-1 fields per retailer. Served from our cache; when fewer than three stores hold an answer, the call reads the missing stores itself within its time budget. Each cell's read says whether that store was read in this call, read earlier, or not read and why (for example timed_out: call again shortly). To force a fresh scrape of a specific retailer, use ?retailer=<retailer>&force_refresh=true.

5. Add live sellers + reviews

curl -H "Authorization: Bearer rk_live_YOUR_KEY" \
  "https://api.retailerapi.com/v1/products/19667262713?include_offers_reviews=true"

Adds an offers array (current marketplace sellers + their prices, in-stock, buy-box flag) and a review_summary block (average rating, total reviews, rating distribution + top 5 reviews). +5 tokens.

Price history is already included in the base call — no extra flag needed.

What costs how many tokens