API reference
Building with an AI agent?
Copy a prompt that describes every route, its parameters and its response format, ready to paste into Claude Code, Cursor or ChatGPT.
Overview
All routes are read only GET requests that return JSON. Data comes from bots in the game that read the auction house and the buy orders every five minutes.
In the examples, {BASE_URL} stands for the address of the API, which will be published at launch. Items are identified by their Minecraft ids, such as diamond or netherite_ingot. API keys and plan quotas are described on the pricing page; how to send a key will be documented at launch.
Status
Tells you when the latest auction house and orders snapshots were taken, and how large they were. Use it to check that the data is fresh.
curl "{BASE_URL}/v1/status"{
"ah": { "at": "2026-11-11T09:40:00Z", "size": 18432 },
"orders": { "at": "2026-11-11T09:40:00Z", "size": 2210 }
}Auction house offers
Offers from the latest auction house snapshot. The snapshot object says when it was taken, how many pages were read, and whether the read was complete.
| Parameter | Description |
|---|---|
| item | Minecraft item id, for example diamond. Filters the offers. |
| limit | Maximum number of offers to return. |
| Field | Description |
|---|---|
| item | Item id. |
| name | Display name of the item. |
| count | Number of items in the offer. |
| price | Total price of the offer. |
| unit_price | Price per single item. |
| snapshot.at | When the snapshot was taken, as Unix time in milliseconds. |
| snapshot.pages | Number of pages read. |
| snapshot.complete | Whether every page was read. |
curl "{BASE_URL}/v1/ah?item=diamond&limit=2"{
"snapshot": { "at": 1794383619041, "pages": 80, "complete": false },
"offers": [
{ "item": "diamond", "name": "Diamond", "count": 64,
"price": 58000, "unit_price": 906.25 },
{ "item": "diamond", "name": "Diamond", "count": 16,
"price": 15000, "unit_price": 937.5 }
]
}Auction house items
One summary line per item in the latest snapshot: how many listings it has, the lowest unit price, and the total number of items on sale.
curl "{BASE_URL}/v1/ah/items"{
"snapshot": { "at": 1794383619041, "pages": 80, "complete": false },
"items": [
{ "item": "ender_chest", "listings": 201,
"lowest_unit_price": 18500, "total_count": 201 },
{ "item": "written_book", "listings": 106,
"lowest_unit_price": 1000, "total_count": 106 }
]
}Buy orders
Open buy orders from the latest orders snapshot.
| Field | Description |
|---|---|
| item | Item id. |
| name | Display name of the item. |
| price_each | Price offered per item. |
| delivered | How many items were already delivered. |
| wanted | How many items the order asks for. |
curl "{BASE_URL}/v1/orders?item=diamond&limit=2"{
"orders": [
{ "item": "diamond", "name": "Diamond",
"price_each": 870, "delivered": 128, "wanted": 512 },
{ "item": "diamond", "name": "Diamond",
"price_each": 850, "delivered": 0, "wanted": 64 }
]
}History
Points from past snapshots for one item, ready to chart. Each point has the time of the snapshot, the price and the number of listings.
| Parameter | Description |
|---|---|
| item | Minecraft item id. |
| type | ah for the auction house or orders for buy orders. |
| hours | How many hours back to look. |
curl "{BASE_URL}/v1/history?item=diamond&type=ah&hours=24"{
"points": [
{ "at": 1794383019041, "price": 892.0, "listings": 40 },
{ "at": 1794383319041, "price": 890.5, "listings": 41 },
{ "at": 1794383619041, "price": 890.5, "listings": 41 }
]
}Money leaderboard Beta
The richest players on the server, ranked by balance. Amounts are rounded the way the in-game menu shows them. This route is in beta: its data is not reliable yet.
| Field | Description |
|---|---|
| rank | Position in the leaderboard, starting at 1. |
| player | Player name. |
| money | Balance, rounded as in the game. |
| snapshot.at | When the snapshot was taken, as Unix time in milliseconds. |
curl "{BASE_URL}/v1/leaderboard/money?limit=10"{
"snapshot": { "at": 1794383619041 },
"players": [
{ "rank": 1, "player": "PlayerName", "money": 5900000000000 }
]
}Coming soon
Two groups of routes are planned but not built yet: statistics for a given player and the balance of a given player. Their format is not decided, so nothing is documented here. They will appear on this page when they exist.