Public API
I built this so you can make ladder sites, armories and meta pages for Broken Oath. It is a set of plain JSON files on a CDN, rebuilt once an hour. No key, no login: you just download files. Read only, nothing can write.
Base URL: https://clqwoilqnxutwsvdlrth.supabase.co/storage/v1/object/public/public-api/v1/
Endpoints
index.jsonschema, generated_at, game build, patch, the league ids and where this patch's game data lives. Start here.leagues.jsonevery public league: id, name, hardcore, trade, start and end.ladder/<league>.jsonthe top 200 heroes per class of one league: rank, class, ascendancy, level, Rupture Level, best time, main skill and supports, measured Guardian DPS.builds/<hero>.jsonthe full build of one hero (the top 50 per class per league): passive nodes, skills and supports, gem levels, every item with its affixes and runes.meta/<league>.jsonusage shares for classes, skills, supports, ascendancies, keystones, notables and uniques.market/index.jsonandmarket/<league>/page-<n>.jsonthe read only market feed, see Market below.static/index.jsonthenstatic/b<build>/game_data/*.json: skills, supports, passive tree, item bases, affixes, uniques, runes and more, per patch.
Every file starts with schema, generated_at (UTC), game_build and patch. Hero ids are opaque 16 character ids.
Example
const base = "https://clqwoilqnxutwsvdlrth.supabase.co/storage/v1/object/public/public-api/v1/";
const idx = await (await fetch(base + "index.json")).json();
const ladder = await (await fetch(base + "ladder/" + idx.leagues[0] + ".json")).json();
const top = ladder.heroes.find(h => h.has_build);
const build = await (await fetch(base + "builds/" + top.hero + ".json")).json();
console.log(top.class, top.rupture_level, build.build.items.length, "items");
Market (read only)
Every active Wagon Market listing of the public trade leagues, as plain files you can search however you like. There is no buy, sell or login call anywhere in it: you can look, you cannot trade. Buying and selling stay in the game.
market/index.jsonthe trade leagues with listing counts, and where each league's files are.market/<league>/index.jsontotal, page count, price range, how many sellers are online, and counts per slot, rarity, base and unique (build your filter boxes from these).market/<league>/page-<n>.json250 listings per file, cheapest first. Each listing has the item base, rarity, unique, item level, required level, mods and rolls, sockets and runes, price in gold, listed and expiry time, the seller's hero name and the seller code.
Seller code: the seller's friend code, like K7QM-4TZ2. A buyer pastes it in Friends, Add, and once the seller accepts they can whisper, ask to join each other and trade in the game. A seller can hide his code in the game; that listing then shows only the hero name. Show the code with a copy button, never as something to message outside the game.
const base = "https://clqwoilqnxutwsvdlrth.supabase.co/storage/v1/object/public/public-api/v1/market/";
const idx = await (await fetch(base + "index.json")).json();
const lg = idx.leagues[0];
const info = await (await fetch(base + lg.league + "/index.json")).json();
const pages = await Promise.all(info.files.map(f => fetch(base + lg.league + "/" + f).then(r => r.json())));
const all = pages.flatMap(p => p.listings);
const cheap = all.filter(l => l.rarity === "Unique" && l.price_gold < 5000);
console.log(cheap.length, "cheap uniques, first seller code:", cheap[0]?.seller_code);
Refreshed every 5 minutes and cached for 2 minutes. Fetch market/index.json at most once every 5 minutes, then only the files you need. Listings are a snapshot: one can be sold before you see it, so check in the game. Hidden, banned and bot sellers are left out, and so are account names and Steam ids.
Refresh times
- Ladder, builds and meta: once an hour, a few minutes after minute 41.
- Measured Guardian numbers: every 6 hours.
- Market files: every 5 minutes (see above).
- Game data: with every patch.
- Files are cached for 10 minutes. Check
generated_atinindex.jsonand fetch again only when it changed. Please do not poll more than once every 10 minutes.
Fair use and privacy
- Use the files, never the game's servers. Do not scrape the game, its login or the in game ladder.
- Only heroes in the official public leagues. No Steam ids, account names, emails or IPs, ever. Bots, banned accounts and players who opted out are left out.
- Credit "Data: Broken Oath public API" with a link to the game. Do not present your site as official.
- Do not try to tie a hero id to a real person.
- It is an alpha. Numbers, fields and the meta change with every patch. Please tell your users.
Versions
The folder name v1 changes only for a breaking change, and a new v2 runs beside it for at least 30 days. New fields can appear in v1 at any time, so ignore fields you do not know.
Made a tool? Tell me on Discord, I read every post.