GET/api/v1

Stats Card

Generate a GitHub stats card as SVG image showing stars, commits, PRs, issues, and rank.

Parameters

usernamerequired

string

GitHub username

theme

stringdefault: default

Card theme

title_color

string

Title color (hex without #, e.g. ff0000)

text_color

string

Text color (hex without #)

icon_color

string

Icon color (hex without #)

bg_color

string

Background color (hex without #)

border_color

string

Border color (hex without #)

ring_color

string

Rank ring color (hex without #)

hide_rank

booleandefault: false

Hide rank display

hide_title

booleandefault: false

Hide card title

hide_border

booleandefault: false

Hide card border

show_icons

booleandefault: true

Show stat icons

hide

string

Comma-separated stats to hide

line_height

numberdefault: 25range: 1+

Line height for stats (positive integer)

include_all_commits

booleandefault: false

Include all commits (not just current year)

count_private

booleandefault: false

Count private contributions

font

stringdefault: google-sans-flex

Font family for card text

icon_set

stringdefault: default

Icon library to use for stats icons

emoji_set

stringdefault: twitter

Emoji style for rendering emojis in names/titles

border_radius

numberdefault: 6range: 0-50

Card border radius in pixels

refresh

booleandefault: false

Force refresh the card (bypass cache)

Caching

SVG cards are cached in Cloudflare R2 storage for optimal performance.

SVG Cache

Generated SVG cards are cached until manually refreshed using the refresh parameter

Force Refresh

Add refresh=true parameter to force regenerate the card with fresh data

Data Cache

GitHub API data is cached for 24 hours in KV storage to reduce API calls

Example

Request URL

/api/v1?username=hehehai&show_icons=true

Markdown (for README)

![Stats Card](/api/v1?username=hehehai&show_icons=true)

HTML

<img src="/api/v1?username=hehehai&show_icons=true" alt="Stats Card" />

Preview