Skip to content

Stats card

The card counts five things by default — stars earned, commits, pull requests, issues and the repositories contributed to — and grades them into a rank from C to S. Anything else it can show is opt-in through show.

The stats card for a GitHub user

?username=octocat&show_icons=true
OptionWhat it is
usernameThe GitHub login to draw stats for

show takes a comma-separated list. Each value adds a line to the card:

The stats card with extra stats and a percentile rank

?username=octocat&show_icons=true&show=reviews,prs_merged,contributions&rank_icon=percentile
ValueThe line it adds
reviewsPull requests reviewed
prs_mergedPull requests merged
prs_merged_percentageWhat share of your PRs were merged
discussions_startedDiscussions started
discussions_answeredDiscussions answered
prs_authoredPull requests authored
prs_commentedPull requests commented on
prs_reviewedPull requests reviewed, counted by search
issues_authoredIssues authored
issues_commentedIssues commented on
contributionsContributions in the counted range
all_time_contribsContributions across every year of the account

Each extra stat costs another request, so a card asking for all twelve is slower than one asking for none.

hide takes the same shape, and removes a line the card would otherwise draw: stars, commits, prs, issues, contribs.

OptionValuesWhat it does
showthe list aboveExtra stats to draw
hidestars commits prs issues contribsDefault stats to leave out
show_iconstrue falseDraw an icon beside each stat
hide_ranktrue falseLeave out the rank circle
rank_icondefault github percentileWhat the rank circle shows
ring_colora hex colorThe rank ring, when it should differ from the title
include_all_commitstrue falseCount commits of all time rather than the counted range
from / to2024, 2024-03, 2024-03-15The range commits and contributions are counted in
exclude_reporepository namesRepositories to leave out of the totals
repoowner/name or nameScope the search-based stats to these repositories
ownerloginsScope the search-based stats to these owners
roleOWNER COLLABORATOR ORGANIZATION_MEMBERWhich repositories count towards the stats
contribs_include_own_repostrue falseCount contributions to your own repositories
number_formatshort long1.5k or 1500
number_precisiona numberDecimals kept when abbreviating
text_boldtrue falseBold the stat values
line_heighta numberSpace between the lines
disable_animationstrue falseDraw the card with no animation

Plus the common options every card takes, and locale.

from and to bound what “commits” and “contributions” mean, and both ends are inclusive. Either may be left out: an open end is filled with the widest range GitHub will answer for.

?username=octocat&from=2020&to=2024

include_all_commits=true overrides the range for the commit count alone — it asks for every commit the account has ever made.