welcome

Welcome to BuyWhere — API Key + Quickstart

Your BuyWhere API key is now active. Here’s everything you need to make your first query in under 5 minutes.

Your Credentials

API Key: bw_xxxxx — replace with your actual key Base URL: https://api.buywhere.ai

Use your key as a Bearer token:

Authorization: Bearer bw_xxxxx

X-API-Key: bw_xxxxx also works, but Bearer auth is the recommended default in the docs.

Quick Sanity Check

curl -sS https://api.buywhere.ai/health
# -> {"status":"ok"}

Your First Product Search

curl -sS --get "https://api.buywhere.ai/v1/products" \
  -H "Authorization: Bearer bw_xxxxx" \
  --data-urlencode "q=wireless headphones" \
  --data-urlencode "limit=3"

Response shape:

{
  "total": 248,
  "items": [
    {
      "id": 78234,
      "name": "Sony WH-1000XM5 Wireless Headphones",
      "price": "449.00",
      "currency": "SGD",
      "source": "shopee_sg",
      "buy_url": "https://shopee.sg/product/12345",
      "affiliate_url": "https://api.buywhere.ai/v1/track/abc123",
      "category": "Electronics"
    }
  ],
  "has_more": true
}

Key Fields

Field	Purpose
`items[].name`	Product title
`items[].price`	Price (always check currency)
`items[].source`	Platform (shopee_sg, lazada_sg, carousell, amazon_sg)
`items[].affiliate_url`	Tracked purchase link (use this over `buy_url`)
`items[].buy_url`	Direct merchant link

Filtering

curl --get "https://api.buywhere.ai/v1/products" \
  -H "Authorization: Bearer bw_xxxxx" \
  --data-urlencode "q=laptop" \
  --data-urlencode "min_price=800" \
  --data-urlencode "max_price=2500" \
  --data-urlencode "source=shopee_sg"

Supported filters: q, category, min_price, max_price, source, limit, offset

What’s Next

Day 3 covers advanced search patterns, SDKs, and comparison workflows. Questions? Reply to this email or open an issue at github.com/buywhere/api.