Badge Showcase

Embed your burntop stats anywhere with these customizable SVG badges.

Getting Started
Add these badges to your GitHub README, personal website, or anywhere that supports images.

Quick Start

  1. Choose a badge variant below
  2. Copy the Markdown or HTML code
  3. Paste it into your README or website
  4. Replace "your-username" with your actual username

Example for GitHub README:

[![burntop stats](https://burntop.dev/api/badge/your-username)](https://burntop.dev/p/your-username)

Badge Variants

Compact Badge
Minimal badge showing total tokens only
Compact Badge
[![burntop stats](https://burntop.dev/api/badge/your-username?variant=compact)](https://burntop.dev/p/your-username)
Standard Badge
Shows tokens, streak, and level
Standard Badge
[![burntop stats](https://burntop.dev/api/badge/your-username)](https://burntop.dev/p/your-username)
Detailed Badge
Full stats including tokens, cost, streak, level, and achievements
Detailed Badge
[![burntop stats](https://burntop.dev/api/badge/your-username?variant=detailed)](https://burntop.dev/p/your-username)
Streak Badge
Shows current streak only
Streak Badge
[![burntop stats](https://burntop.dev/api/badge/your-username?variant=streak)](https://burntop.dev/p/your-username)
Level Badge
Shows current level only
Level Badge
[![burntop stats](https://burntop.dev/api/badge/your-username?variant=level)](https://burntop.dev/p/your-username)
Customization Options
Customize badges with query parameters

Styles

Flat (default)

Flat (default)
?style=flat

Flat Square

Flat Square
?style=flat-square

Plastic

Plastic
?style=plastic

For The Badge

For The Badge
?style=for-the-badge

Themes

Dark (default)

Dark (default)
?theme=dark

Light

Light
?theme=light

Custom Color

Add ?color=HEX to use a custom accent color (without the #).

Custom blue color
?color=3B82F6
API Reference
Badge endpoint documentation

Endpoint

GET https://burntop.dev/api/badge/:username

Query Parameters

ParameterTypeOptionsDefault
variantstringcompact, standard, detailed, streak, levelstandard
stylestringflat, flat-square, plastic, for-the-badgeflat
themestringdark, lightdark
colorstringHex color (without #)FF6B00

Example

https://burntop.dev/api/badge/alice?variant=detailed&style=flat-square&theme=dark

Notes

  • Badges are cached for 15 minutes for optimal performance
  • Private profiles will return a "Private profile" error badge
  • Non-existent users will return a "User not found" error badge
  • All badges are generated as SVG for crisp rendering at any size