Skip to content
DonutStatsAPI
Sign up
Images

Leaderboard card

A share card with the top players on any leaderboard.

GET/v1/images/leaderboard/{board}.png

Renders the top of a leaderboard as a card: each player's rank, head and value, on the board's own color. It shows the top 5 by default, or anything from 1 to 10 with top.

Use it for a daily baltop post in Discord, a banner on your site or a README. Try every board on the image generator.

Authentication

None needed. 60 images per minute per IP.

Cached for

10 min

Data updates

Rendered from the latest leaderboard, then cached for 10 minutes.

No key needed

Image endpoints are public so you can put them straight into an <img> tag, a Discord embed or a README. They are limited to 60 images per minute per IP address, and every image is cached for 10 minutes.

Path parameters

  • boardstringrequired

    Which board, followed by .png.

    moneydeathsplaytimeplacedBlocksbrokenBlocksmobsKilledkillsshardsbounties

Query parameters

  • topintegeroptionaldefault 5

    How many players to show.

    1 to 10

Response

A 1200 x 630 PNG image.

  • content-typeheader

    Always image/png.

  • cache-controlheader

    public, max-age=600: cache the image for 10 minutes.

Status codes

StatusWhen
400Bad RequestUnknown board, or top outside 1 to 10.
404Not FoundThe board has no players yet.
429Too Many RequestsMore than 60 images in a minute from your IP address.