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.

Try It OutDocumentation
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.

Try it out

Generate your embed, preview it, then copy a single line.

Live preview refreshes automatically

Enter a username to see the preview

Link
Markdown
HTML
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)
bghex—Custom background color (without #)
texthex—Custom text color (without #)
title_colorhex—Custom title color (without #)
icon_colorhex—Custom icon color (without #)
border_colorhex—Custom 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
hidestring—Comma-separated stat keys to hide
border_radiusnumber4.5Card corner radius (0–50)
custom_titlestring—Override the card title text
sizestring"default"Card density — "default" or "compact" (smaller fonts & tighter rows)
layoutstring"bar"Languages chart style — "bar", "stacked", "horizontal_list", "vertical_list", or "grid"
max_langsnumber8Max languages to show in the chart (1–12)
stylestring"flat"Badge style for /api/mini and /api/badge — "flat", "flat-square", "for-the-badge", "plastic", or "minimal"
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
Badge Styles
Pass style to /api/mini or /api/badge to switch the badge look.
?style=for-the-badge
StylePreviewDescription
flat
Flat
Flat badge previewDefault shields.io look with subtle gradient and rounded corners.
flat-square
Flat Square
Flat Square badge previewSame as Flat, but with sharp square corners.
for-the-badge
For The Badge
For The Badge badge previewLarge, bold, uppercase — built to stand out in a README.
plastic
Plastic
Plastic badge previewGlossy plastic finish with a top-light, bottom-shadow gradient.
minimal
Minimal
Minimal badge previewJust text on a transparent background — clean and unobtrusive.