← Hardcore Market Tools · Interactive docs

Hardcore World Tool Kit - data API

Read-only access to the market data collected by the RuneLite plugin "Hardcore World Tool Kit" on the Hardcore Worlds.

Data from this service must not be used for real-world trading. It is a community tool for the game's Grand Exchange, provided as is.

The basics

• Open to everyone: no key, no account, no sign-up. Plain GET requests; the answers are JSON.
• Any website may call it from a browser (CORS is open for reads). Nothing can be written through it: uploads need a key that only the plugin holds.
• Times are Unix seconds (UTC). Prices and totals are in gp.
• The data comes from players using the plugin, so an item nobody traded has no prices. Names, ids and accounts of the players are never in the data: a trade is only an item, a side, a price, a quantity and a time.
• Answers are shared and kept for up to a minute, so asking more often than that gets you the same data. A client that asks far too often may be refused (HTTP 429 or 503).
• Errors come as {"error": "..."} with a status: 400 for a bad parameter, 404 for an unknown path or item, 429 or 503 when you or the server are too busy (503 carries Retry-After).
• Fields may be added over time. Ignore the ones you don't know.

curl https://HOST/v1/items?ids=2,4151

Replace HOST with this page's address.

GET /v1/items

Every item with trades or open offers: the prices of the last 24 hours and the current offers.

{ "time": 1793735269, "world": null,
  "items": [ { "id": 4151, "name": "Abyssal whip", "hasIcon": true,
      "vol24": 12, "gp24": 3100000, "reporters24": 3, "avgBuy24": 258000, "avgSell24": 259000,
      "lastBuy": 258000, "lastBuyTime": 1793734000, "lastSell": 259000, "lastSellTime": 1793733000,
      "bids": 2, "asks": 4, "bestBid": 255000, "bestAsk": 262000, "bidQty": 3, "askQty": 9 } ] }

GET /v1/item/{id}

One item: a summary, its latest trades and its order book.

{ "id": 4151, "name": "Abyssal whip", "hasIcon": true,
  "summary": { "lastBuy": 258000, "lastBuyTime": 1793734000, "lastSell": 259000, "lastSellTime": 1793733000,
               "vol24": 12, "avgBuy24": 258000, "avgSell24": 259000, "bestBid": 255000, "bestAsk": 262000 },
  "trades": [ { "kind": "fill", "side": "buy", "qty": 1, "price": 258000, "total": 258000,
                "ts": 1793734000, "late": false, "world": 9000 } ],
  "book": { "bids": [ { "price": 255000, "offers": 1, "qty": 2, "oldest": 1793700000 } ],
            "asks": [ { "price": 262000, "offers": 2, "qty": 5, "oldest": 1793690000 } ] },
  "nextBefore": "1793733000_15123" }

• trades[].kind: fill is a trade seen as it happened; history was read later from the game's Grand Exchange History tab (so late is true and the time is approximate); cancelled is an offer that was cancelled.
• side is buy or sell.
• book: open offers grouped by price. oldest is when the oldest offer at that price was placed. Bids are listed highest first, asks lowest first.
• nextBefore is null when there are no older trades.

GET /v1/item/{id}/series

The price history of one item, as averages per time bucket (for a chart).

{ "id": 4151, "step": "1h", "range": "7d",
  "data": [ { "timestamp": 1793732400, "avgBuy": 258000, "avgSell": 259000, "buyVolume": 2, "sellVolume": 1 } ] }

timestamp is the start of the bucket. A bucket without trades on one side has null for that average. Buckets with no trades at all are left out.

GET /v1/recent

The live feed of events (trades and offers), newest first, with the totals of the last 24 hours.

{ "time": 1793735270,
  "stats": { "events24": 666, "reporters24": 26, "units24": 196586, "gp24": 119488147,
             "openBids": 41, "openAsks": 97, "tradersWithOffers": 39 },
  "events": [ { "id": 15126, "kind": "placed", "side": "buy", "itemId": 22552, "name": "Thammaron's sceptre (u)",
                "hasIcon": true, "qty": 1, "price": 10000000, "total": null,
                "ts": 1793734311, "late": false, "receivedAt": 1793734320 } ] }

placed is an offer put into the Grand Exchange (its total is null: nothing traded yet); fill is a trade. receivedAt is when the server got it, rounded down to the minute. reporters24 counts the plugins that reported anything in the last 24 hours.

GET /v1/icon/{id}

The item's icon as a PNG (answers 404 when there is none; hasIcon in the other answers says whether there is one). Cached by browsers for a day.

GET /v1/health

{"ok": true, "time": 1793735270}, or status 503 with "ok": false when the database can't be reached.

Privacy

This API publishes prices, quantities and times only. How the data is collected, which identifiers the server keeps and for how long is in the privacy notice.

Questions or problems: Discord @Novith.