Canonical developer quickstart

API key to first BuyWhere query in under five minutes.

This is the single onboarding path for BuyWhere developers: create a key, run a product search, then wire BuyWhere into your MCP-compatible agent stack.

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/search` with a bearer token and natural-language query.

Step 3

Connect MCP

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

Step 1

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/search.

Request checklist

Base URL: https://api.buywhere.ai
Auth: Authorization: Bearer YOUR_KEY
Required query: q
Helpful starter params: limit, platform, price_min, price_max

curlCopy and run

curl -sS "https://api.buywhere.ai/v1/search?q=wireless+headphones&limit=5" \
  -H "Authorization: Bearer bw_live_your_key_here"

jsonCopy and run

{
  "total": 5,
  "limit": 5,
  "offset": 0,
  "has_more": true,
  "items": [
    {
      "id": 12345,
      "name": "Sony WH-1000XM5 Wireless Headphones",
      "price": 429.0,
      "currency": "SGD",
      "source": "lazada_sg",
      "buy_url": "https://...",
      "affiliate_url": "https://api.buywhere.ai/v1/track/12345",
      "is_available": true
    }
  ]
}

Step 3

Connect BuyWhere to MCP

BuyWhere ships an MCP server so agent builders can expose product search as tools inside Claude Desktop, Cursor, and other MCP-compatible environments.

Setup notes

Install the BuyWhere API repo dependencies on the machine running the MCP client.
Point `args` to the absolute path of mcp_server.py.
Set both BUYWHERE_API_KEY and BUYWHERE_API_URL.

claude_desktop_config.jsonCopy and run

{
  "mcpServers": {
    "buywhere": {
      "command": "python",
      "args": ["/absolute/path/to/buywhere-api/mcp_server.py"],
      "env": {
        "BUYWHERE_API_KEY": "bw_live_your_key_here",
        "BUYWHERE_API_URL": "https://api.buywhere.ai"
      }
    }
  }
}

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.

Example agents

Reference implementations for agent builders using BuyWhere in practice.