Developer Reference

WoW Token Price API

Version 0.1.0 ·  OpenAPI 3.0

Public REST API for real-time and historical World of Warcraft Token prices. Sourced from the official Blizzard Game Data API. Endpoints flagged as `planned` are documented for contract-first design but are not yet implemented.

Base URL

/api

Endpoints

get/api/docsLive

Get the OpenAPI specification

Returns this OpenAPI 3.0 document as JSON. This endpoint is implemented and live.

get/api/v1/statusLive

Get market ingestion status

Returns sanitized market status derived from the ingestion pipeline. Exposes only safe, non-sensitive fields — no metadata, no error messages, no raw_payload, no secrets. Use `lastSuccessfulIngestionAt` to display accurate 'Last server check' timing in the UI without relying on client-side estimates. Always returns fresh data (no CDN cache).

get/api/v1/tokens/pricesLive

Get current WoW Token prices

Returns the latest WoW Token price per region for the requested game version, enriched with previousPriceGold, changeGold, changePercent, and enoughHistory. Change fields are null when fewer than two history candles exist for the region. Read from the `latest_token_prices` and `token_price_history_5m` safe views. Always returns fresh data (no CDN cache). Never exposes raw_payload. `gameVersion` defaults to `retail` for backward compatibility — existing consumers that never sent the parameter continue to receive Retail-only prices. Use `gameVersion=classic` for Classic Progression prices, or `gameVersion=all` for both. Classic is tracked for us/eu/kr/tw only (no CN).

get/api/v1/tokens/historyLive

Get WoW Token price history

Returns historical OHLC candles for a region/game version from the `token_price_history_5m` safe view. Supports time-range filtering via the `range` parameter. Only interval=5m is currently implemented; 1h and 1d return 400. Raw tables are not exposed. Never exposes raw_payload. When `range` is specified, the response includes a `meta` object describing data coverage and whether the requested range is fully covered.

Note: Endpoints marked Planned are published for contract-first design but are not yet implemented. They will be built alongside the Blizzard API integration in a later phase. Only endpoints marked Live are currently available.