GitHub Profile 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 Out Documentation

default

A live GitHub stats card for your profile

GHStats turns your public GitHub activity into an SVG card you can embed in a profile README. Show the numbers that matter to you, including commits, stars, pull requests, contributions, streaks, repositories and followers. The card refreshes as your public activity changes, so you do not need to edit your README each time.

Profile stats card

Put your GitHub user stats in one card, then choose which metrics and theme to display.

Top languages

Add a separate languages card when you want your profile to show the languages in your public repositories.

Badges and activity

Use a compact stats badge or contribution sparkline when a full-size card does not fit your README.

Build your GitHub profile card →

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.

Go to github.com/new
Set the repo name to your exact username
Make it public and check "Add a README file"
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

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

Live preview refreshes automatically

Embed Type

GitHub Username

Custom Title (optional)

Border Radius: 4.5

Layout

Show IconsShow RingHide BorderHide Title

Advanced Options

Live Preview

Enter a username to see the preview

Link

https://ghstats.dev/api/card?username=octocat

Markdown

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

HTML

<img src="https://ghstats.dev/api/card?username=octocat" alt="GitHub Stats Card" />

Theme

All Parameters

Everything you can pass as a URL query parameter.

Parameter	Type	Default	Description
`username`	string	`required`	GitHub username to fetch stats for
`theme`	string	`"default"`	Theme preset name (see Themes below)
`bg`	hex	`—`	Custom background color (without #)
`text`	hex	`—`	Custom text color (without #)
`title_color`	hex	`—`	Custom title color (without #)
`icon_color`	hex	`—`	Custom icon color (without #)
`border_color`	hex	`—`	Custom border color (without #)
`hide_border`	boolean	`false`	Set to "true" to remove the border
`hide_title`	boolean	`false`	Set to "true" to remove the title
`show_icons`	boolean	`true`	Set to "false" to hide stat icons
`show_ring`	boolean	`true`	Set to "false" to hide the activity ring
`hide`	string	`—`	Comma-separated stat keys to hide
`border_radius`	number	`4.5`	Card corner radius (0–50)
`custom_title`	string	`—`	Override the card title text
`size`	string	`"default"`	Card density — "default" or "compact" (smaller fonts & tighter rows)
`layout`	string	`"bar"`	Languages chart style — "bar", "stacked", "horizontal_list", "vertical_list", "grid", "donut", "donut_vertical" or "compact"
`max_langs`	number	`8`	Max languages to show in the chart (1–12)
`style`	string	`"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

Key	Stat
`stars`	Total Stars Earned
`commits`	Total Commits (year)
`prs`	Pull Requests
`issues`	Issues Opened
`streak`	Current Streak
`week`	Commits This Week
`trend`	Weekly Trend (+/-)
`avg`	Avg Commits Per Day
`active_day`	Most Active Day
`grade`	Activity Grade
`contributions`	Contributions This Year
`repos`	Public Repos
`followers`	Followers

Badge Styles

Pass style to /api/mini or /api/badge to switch the badge look.

?style=for-the-badge

Style	Preview	Description
`flat` Flat		Default shields.io look with subtle gradient and rounded corners.
`flat-square` Flat Square		Same as Flat, but with sharp square corners.
`for-the-badge` For The Badge		Large, bold, uppercase — built to stand out in a README.
`plastic` Plastic		Glossy plastic finish with a top-light, bottom-shadow gradient.
`minimal` Minimal		Just text on a transparent background — clean and unobtrusive.