Getting Started
Get up and running with the BuyWhere API in minutes.
Overview
BuyWhere provides a unified API for searching, comparing, and purchasing products across multiple e-commerce platforms in Singapore and Southeast Asia.
Base URL: https://api.buywhere.ai
Quick Start
1. Get Your API Key
Contact the BuyWhere team to provision an API key. You'll receive a key in the format bw_live_xxxxx.
2. Make Your First Request
Test the API with a simple health check:
curl https://api.buywhere.ai/health
Expected response:
{
"status": "ok"
}
3. Search Products
Make your first authenticated request:
curl "https://api.buywhere.ai/v1/products?q=wireless%20headphones&limit=3" \
-H "Authorization: Bearer bw_live_xxxxx"
Core Features
| Feature | Endpoint | Description |
|---|---|---|
| Search | GET /v1/search | Full-text product search |
| Products | GET /v1/products | Product listing with filters |
| Best Price | GET /v1/products/best-price | Find cheapest listing |
| Compare | GET /v1/products/compare | Compare across platforms |
| Categories | GET /v1/categories | Browse by category |
| Deals | GET /v1/deals | Current discounts |
| Export | GET /v1/products/export | Bulk data export |
Authentication
All API requests require authentication via Bearer token:
-H "Authorization: Bearer bw_live_xxxxx"
See the Authentication Guide for details.
Next Steps
- Quickstart Guide - Detailed first query walkthrough
- API Reference - Complete endpoint documentation
- Code Samples - Integration examples