GitHub Profile StatsView on GitHub

GitHub Stats for Your README

One line in your README — that's it. Your stats card stays up to date automatically. Pick a theme, hide what you don't need, and you're done.

Demo stats card

default

Quick Start

1Create your profile README

GitHub displays a special README on your profile when you create a repo with the same name as your username.

  1. Go to github.com/new
  2. Set the repo name to your exact username
  3. Make it public and check "Add a README file"
  4. Click Create repository

Already have a profile README? Skip to step 2.

2Add your stats card

Edit the README.md in your profile repo and paste:

![GitHub Stats](https://ghstats.dev/api/card?username=YOUR_USERNAME)

Want a different look? Add &theme=tokyonight or use the editor below to customise everything.

Try It Out

Customise your card and copy the embed code.

Enter a username to see the preview

Markdown
![GitHub Stats](https://ghstats.dev/api/card?username=octocat)
HTML
<img src="https://ghstats.dev/api/card?username=octocat" alt="GitHub Stats" />

All Parameters

Everything you can pass as a URL query parameter.

ParameterTypeDefaultDescription
usernamestringrequiredGitHub username to fetch stats for
themestring"default"Theme preset name (see Themes below)
bghexCustom background color (without #)
texthexCustom text color (without #)
title_colorhexCustom title color (without #)
icon_colorhexCustom icon color (without #)
border_colorhexCustom border color (without #)
hide_borderbooleanfalseSet to "true" to remove the border
hide_titlebooleanfalseSet to "true" to remove the title
show_iconsbooleantrueSet to "false" to hide stat icons
show_ringbooleantrueSet to "false" to hide the activity ring
hidestringComma-separated stat keys to hide
border_radiusnumber4.5Card corner radius (0–50)
custom_titlestringOverride the card title text

Stats You Can Hide

Pass a comma-separated list of keys to the hide parameter:

?hide=stars,issues,followers
KeyStat
starsTotal Stars Earned
commitsTotal Commits (year)
prsPull Requests
issuesIssues Opened
streakCurrent Streak
weekCommits This Week
trendWeekly Trend (+/-)
avgAvg Commits Per Day
active_dayMost Active Day
gradeActivity Grade
contributionsContributions This Year
reposPublic Repos
followersFollowers