auctionhouse.fyiPREVIEW
Sign in
Documentation / Get started

Introduction

Build with player-sourced auction data.

Start building

Building an agent or plugin? Start with the OpenAPI contract and downloadable Rust client.

01 →

Make your first request

Fetch an item price. No account or API key required.

02 →

Contribute auction data

Prepare a book, authenticate, upload and verify the result.

03 →

Connect your addon

Follow the export path with downloadable Lua and Rust examples.

How the data moves

  1. 01 · OBSERVERead auctionsWoW: Forever addon
  2. 02 · TRANSFERExport a bookPixel strip → desktop
  3. 03 · INGESTUpload oncePOST /ah/books
  4. 04 · BUILDRead the marketPrices, depth & history

A scan is the act of reading the auction house. A book is the observed auction data you upload. One book feeds the price table, historical candles and order-book views.

The essentials

Base URLHTTPS
https://auctionhouse.fyi/api/v1
FormatJSON
Unix milliseconds for HTTP timestamps. Integer copper per item for prices. Gzip supported for uploads.
AuthenticationBearer
Public reads need no key. Uploads need a paired device token or an API key with api.upload. Set up authentication →
ScopeWoW: Forever
Six separate markets. Player-observed auction facts only; never seller, bidder or character names.

Versioned contracts and runnable examples live with the source specification →.