Books and price summaries
Upload auction books; read the summaries the service derives from them.
One upload format
The API accepts order books at POST /api/v1/ah/books. Each entry describes a group of auctions with the same item variant, unit buyout, stack size and time-left band. No seller identities are included.
What a book preserves
[
[14047, 125, 20, 4, 2],
[14047, 150, 10, 2, 1]
]| Market fact | In this book | In its price summary |
|---|---|---|
| Lowest unit buyout | 125 copper | 125 copper |
| Total quantity | 2 × 20 + 1 × 10 = 50 | 50 |
| Price levels | 125 and 150 copper | Lost |
| Stack sizes & auction counts | Two 20-stacks; one 10-stack | Lost |
| Time-left bands | Very long and medium | Lost |
Books also preserve bid-only auctions. Disappearance between books is an estimate of volume, not proof of a sale.
Where summaries fit
The server derives one price summary per item key: its lowest positive unit buyout and total quantity across the book’s entries (including bid-only stacks). Items with only bid-only auctions have no buyout summary.
These compact views serve tooltips, price tables and candles. Read responses still use names such as scan and scans for observation times and counts. They do not imply a second upload format.
Completeness changes the meaning
complete: true means an unfiltered, finished read of the whole market. It can mark previously listed keys absent from this book as no longer listed. A filtered search, interrupted read or subset must use false.
An empty book is valid only as an actual observation of an empty market. A missing or failed read is not an empty market. An incomplete book still contains real auction detail and can contribute readings, but receives no contributor credit. The addon sends nothing when replication is missing or gets no answer; it never substitutes a browse summary.
Versioned contracts and runnable examples live with the source specification →.