Using it

Embeds and the JSON API

Embed a board#

Put a compact board on your own website, a Discord bot page or an OBS overlay:

<iframe src="https://boards.yourserver.com/embed/global-elo?rows=10"></iframe>

Add &theme=<name> to force a theme inside the frame. Turn the embed page off with site.embed.enabled: false.

JSON API#

EndpointReturns
/api/statusLive status: online, in fights, in queue, live fights, players ranked, fights recorded and season.
/api/configBranding, theme, boards and site language.
/api/leaderboard/<board>One board, paginated. Add ?player=<name> to get the page that holds that player.
/api/leaderboard/kit/<kit>One ranked kit board.
/api/player/<name>Full profile including ELO history, ELO change, percentile and recent form.
/api/search?q=Player name autocomplete.
/api/compareTwo players side by side.
/api/kitsRanked kits with their top players.
/api/moversThe biggest ELO gains of the week.
/api/live, /api/seasons, /api/matchesLive fights, archived seasons and recent matches.

To protect the API, set web.api-key. Clients then send it as ?key= or an X-Api-Key header. Leave it empty and the API is public. API and image proxy calls are rate limited per IP (see the Configuration section).