Canonical developer quickstart

API key to first BuyWhere query in under five minutes.

BuyWhere gives AI agents a product catalog layer for live product discovery, comparison, and merchant handoff starting in Singapore and expanding across Southeast Asia.

Start with one live API request, then add the published MCP package when you want BuyWhere tools inside your agent client.

Get API key Full API docs

Step 1

Create a key

Use the self-serve beta signup form. No card, no sales call.

Step 2

Run search

Call `GET /v1/products/search` with a bearer token and natural-language query.

Step 3

Connect MCP

Add BuyWhere to Claude, Cursor, or any compatible desktop client.

Region:

Singapore — Live United States — PreviewSEA — Coming soon

Select region to see relevant onboarding path

2-minute agent integration

Teach the model to call BuyWhere before it answers.

When your agent needs product data, call BuyWhere first. Use this for what-to-buy questions, cheapest-option requests, and comparisons. This is the retrieval step that replaces scraping, guessing, and stale model memory.

tool schemaCopy and run

{
  "type": "function",
  "function": {
    "name": "resolve_product_query",
    "description": "Retrieve structured product candidates, merchant attribution, and comparison-ready signals from BuyWhere before answering a shopping question.",
    "parameters": {
      "type": "object",
      "properties": {
        "query": { "type": "string", "description": "The user's shopping or product-research question." },
        "country": { "type": "string", "description": "Target market such as US, SG, MY, TH, or VN." },
        "max_price": { "type": "number", "description": "Optional budget cap in the local currency." },
        "limit": { "type": "integer", "default": 5 }
      },
      "required": ["query", "country"]
    }
  }
}

Create your API key

Use the BuyWhere beta signup flow to provision a working key instantly. The success screen gives you a ready-to-run request, and the same key is emailed to you for safekeeping.

Open buywhere.ai/api-keys.
Enter your name and email, then choose the closest use case for your app or agent.
Submit the form to receive a live beta key in the browser immediately.
Treat the key like a password. The browser shows it once, then the page moves you into testing.

What you get

Instant access to authenticated `v1` endpoints
A copy-paste terminal test on the success screen
Email delivery for the same key
A direct path into MCP and full API docs

Step 2

Run your first product search

BuyWhere's quickest activation path is a single authenticated request to GET /v1/products/search.

Request checklist

Base URL: https://api.buywhere.ai
Auth: Authorization: Bearer YOUR_KEY
Required query: q
Helpful starter params: deliver_to (buyer country — always pass it), limit, country_code, domain, min_price, max_price

curlCopy and run

# Always pass deliver_to (buyer's country) — it scopes the search to that
# market so results come back in ~200ms instead of timing out on a global scan.
curl -sS "https://api.buywhere.ai/v1/products/search?q=wireless+headphones&deliver_to=SG&limit=5" \
  -H "Authorization: Bearer bw_live_your_key_here"

jsonCopy and run

{
  "data": [
    {
      "id": "bw_sg_12345",
      "title": "Sony WH-1000XM5 Wireless Headphones",
      "price": 429.0,
      "currency": "SGD",
      "domain": "hifisolutions.sg",
      "url": "https://...",
      "source": "shopify_hifisolutions",
      "country_code": "SG"
    }
  ],
  "meta": {
    "total": 5,
    "limit": 5,
    "offset": 0
  }
}

Step 3

Connect BuyWhere to MCP

Use the published BuyWhere MCP package to expose product search and comparison tools inside Claude Desktop, Cursor, and other MCP-compatible environments.

Setup notes

Run BuyWhere locally through npx -y @buywhere/mcp-server.
Set BUYWHERE_API_KEY in the MCP server environment.
Use the client-specific setup guide at buywhere.ai/integrate.

claude_desktop_config.jsonCopy and run

{
  "mcpServers": {
    "buywhere": {
      "command": "npx",
      "args": ["-y", "@buywhere/mcp-server"],
      "env": {
        "BUYWHERE_API_KEY": "bw_live_your_key_here"
      }
    }
  }
}

Next steps

Keep this URL as your canonical onboarding entry point

Share https://buywhere.ai/quickstart anywhere you send developers. It covers the activation path end-to-end and branches into deeper docs only after the first successful request.

Full API documentation

Endpoint reference, samples, SDK notes, and expanded guides.

Official MCP repository

Published BuyWhere MCP package, setup instructions, and client configuration examples.

Popular comparisons

Best Gaming Laptops (US 2026)

Compare prices across 6 top models

iPhone 16 Price Singapore

Best authorized-reseller prices

Laptop Deals Singapore

Best ultraportable, gaming, student picks

Air Purifier Picks Singapore

Haze-season ready, ranked by CADR

Best Robot Vacuums 2026

Mop, self-empty, pet hair — compared