BuyWhere Authentication API

Agent registration and API key issuance.

Operations 1

POST /auth/register Register Agent And Issue API Key #

Documentation

Specifications

Schemas & Data

Other Resources

🔗
MCPDocumentation
https://api.buywhere.ai/docs/guides/mcp
🔗
MCPEndpoint
https://api.buywhere.ai/mcp
🔗
PluginManifest
https://api.buywhere.ai/.well-known/ai-plugin.json
🔗
LlmsText
https://api.buywhere.ai/llms.txt
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/buywhere/refs/heads/main/rules/buywhere-rules.yml
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/buywhere/refs/heads/main/examples/buywhere-searchProducts-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/buywhere/refs/heads/main/examples/buywhere-getDeals-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/buywhere/refs/heads/main/examples/buywhere-compareProducts-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/buywhere/refs/heads/main/examples/buywhere-getProduct-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/buywhere/refs/heads/main/examples/buywhere-getProductPrices-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/buywhere/refs/heads/main/examples/buywhere-listCategories-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/buywhere/refs/heads/main/examples/buywhere-getCategoryProducts-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/buywhere/refs/heads/main/examples/buywhere-registerAgent-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/buywhere/refs/heads/main/examples/buywhere-mcp-tools-call-example.json
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/buywhere/refs/heads/main/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/buywhere-authentication-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

buywhere-authentication-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: BuyWhere Product Catalog Authentication API
  version: '1'
  description: 'Agent-native product catalog API for Southeast Asia and US commerce. Search 1.5M+

    products across Shopee, Lazada, Amazon, Walmart, FairPrice, Carousell, Best Denki,

    and 20+ e-commerce platforms. Compare prices, discover deals, and find best prices

    through REST or MCP (Model Context Protocol).


    Responses are structured for LLM and agent consumption (Schema.org-compatible

    `Product` / `Offer` / `ItemList` shapes). Each product carries normalized

    `structured_specs` (brand, model, size, color) and `comparison_attributes`

    so agents can reason and rank without scraping.


    BuyWhere is MCP-native — the same operations are exposed at

    `POST https://api.buywhere.ai/mcp` for MCP-compatible clients, with a hosted

    HTTP transport and a published `@buywhere/mcp-server` STDIO package.

    '
  contact:
    name: BuyWhere API
    email: api@buywhere.ai
    url: https://api.buywhere.ai/
  termsOfService: https://buywhere.ai/terms
  license:
    name: Commercial
    url: https://buywhere.ai/terms
servers:
- url: https://api.buywhere.ai/v1
  description: Production REST API
tags:
- name: Authentication
  description: Agent registration and API key issuance.
paths:
  /auth/register:
    post:
      summary: Register Agent And Issue API Key
      description: Register an AI agent (or application) and receive a Bearer API key with a free-tier rate limit allocation.
      operationId: registerAgent
      tags:
      - Authentication
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentRegistration'
            example:
              agent_name: shopping-copilot
              contact: dev@example.com
              use_case: Price comparison assistant for Singapore consumers.
      responses:
        '201':
          description: API key issued for the agent.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyIssue'
              example:
                api_key: bw_free_2f7a9c0b1d8e4f3a9c0b1d8e4f3a9c0b
                tier: free
                rate_limit:
                  rpm: 60
                  daily: 1000
        '400':
          $ref: '#/components/responses/BadRequest'
components:
  schemas:
    AgentRegistration:
      type: object
      required:
      - agent_name
      properties:
        agent_name:
          type: string
          description: Name or identifier of your agent.
        contact:
          type: string
          format: email
          description: Contact email (optional).
        use_case:
          type: string
          description: Brief description of your use case.
    ApiKeyIssue:
      type: object
      properties:
        api_key:
          type: string
          description: Bearer token (prefixed with `bw_free_`, `bw_live_`, or `bw_partner_`).
        tier:
          type: string
          enum:
          - free
          - live
          - partner
        rate_limit:
          type: object
          properties:
            rpm:
              type: integer
              description: Requests per minute.
            daily:
              type: integer
              description: Daily request quota.
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
              - invalid_params
              - not_found
              - rate_limited
              - unauthorized
              - internal_error
            message:
              type: string
            request_id:
              type: string
  responses:
    BadRequest:
      description: Invalid request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'Pass your API key as a Bearer token. Get a free key at `POST /v1/auth/register`.

        Tiers: `bw_free_*` (60 rpm), `bw_live_*` (600 rpm), `bw_partner_*` (unlimited).

        '
externalDocs:
  description: BuyWhere developer documentation and MCP guide
  url: https://api.buywhere.ai/docs/guides/mcp