GitHub Readme Stats

Get dynamically generated GitHub stats on your READMEs!

Tip

Due to the many card types supported by this project and its powerful features, here is a simple introduction to the GitHub status card. For other card types, please refer to the official documentation.

Parameters

Click to show/close parameters

Name	Type	Required	Default	Description	More Description
username	string			GitHub username
title_color	string		2F80ED	Card's title color	Supported: HEX, e.g. FF0000.
text_color	string		434D58	Body text color	Supported: HEX, e.g. FF0000.
icon_color	string		4C71F2	Icons color if available	Supported: HEX, e.g. FF0000.
border_color	string		E4E2E2	Card's border color	Supported: HEX, e.g. FF0000. does not apply when hide_border is enabled.
hide_border	boolean		false	Hides the card's border
theme	string			Name of the theme	Supported: dark radical merko gruvbox tokyonight onedark cobalt synthwave highcontrast dracula transparent.
cache_seconds	number		21600	Sets the cache header manually	Unit: seconds, range: 21600 to 86400.
locale	string		en	Sets the language in the card	Language reference: locales.
border_radius	number		4.5	Corner rounding on the card
hide	string			Hides the specified items from stats	Data types are separated by ,.
show	string			Shows additional items on stats card	Data types are separated by ,.
show_icons	boolean		true	To enable icons
bg_color	string			Card's background color	Background color supports gradients, format: deg,color1,color2,color3,....

https://github-readme-stats.vercel.app/api{?username,title_color,text_color,icon_color,border_color,hide_border,theme,cache_seconds,locale,border_radius,hide,show,show_icons,bg_color}

Examples

<!-- anuraghazra -->
![GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)

<!-- anuraghazra -->
![GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&locale=cn&theme=dark&hide_border=true)