Welcome to GitHub Stats

GitHub Stats generates fast, beautiful SVG cards for your README. Use the API endpoints below to build custom cards in seconds.

Generate preview Get started

Get started

Stats Card

Show stars, commits, PRs, and more with a single endpoint.

Get started →

Top Languages

Highlight your most-used languages with clean breakdowns.

Get started →

Overview

A full profile snapshot with streaks and contribution charts.

Get started →

Reference

Explore all query parameters to customize the visuals.

View reference →

Quickstart

Pick a username, choose a theme, and paste the link into your README.

terminal

https://github.hexacloud.net.br/api?username=yourname&theme=tokyonight

Embed in README

markdown

![GitHub Stats](https://github.hexacloud.net.br/api?username=yourname&theme=tokyonight)

Stats Card

Endpoint: /api

/api?username=yourname&theme=dark&show_icons=true&show_rank=true

Top Langs

Endpoint: /api/top-langs

/api/top-langs?username=yourname&theme=nightowl&langs_count=6

Overview

Endpoint: /api/overview

/api/overview?username=yourname&theme=tokyonight&overview_width=1100

Parameters

usernameGitHub username (required)

themeTheme name (see list below)

show_iconstrue | false

show_ranktrue | false

animatetrue | false

include_forkstrue | false

include_reviewstrue | false

include_languagestrue | false

langs_count3 - 10

hideComma-separated fields

showOverrides hide

custom_titleCustom card title

bg_colorHex or gradient (hex1,hex2)

title_colorHex color

text_colorHex color

accent_colorHex color

muted_colorHex color

hide_bordertrue | false

border_radius6 - 30

overview_width900 - 1600

overview_height540 - 1000

overview_show_avatartrue | false

overview_show_languagestrue | false

overview_langs_count2 - 8

Variations

Copy and tweak these presets to build your own look.

Minimal stats

Clean layout with no rank or icons.

https://github.hexacloud.net.br/api?username=yourname&theme=dark&show_icons=false&show_rank=false&hide_border=true

Gradient background

Two-tone background with accent colors.

https://github.hexacloud.net.br/api?username=yourname&theme=tokyonight&bg_color=0d1117,161b22&title_color=42b5ff&accent_color=39f3a0&muted_color=9fb0c2

Top langs focus

Highlight more languages with a clean frame.

https://github.hexacloud.net.br/api/top-langs?username=yourname&theme=nightowl&langs_count=8&hide_border=true

Wide overview

Full-width profile overview for featured sections.

https://github.hexacloud.net.br/api/overview?username=yourname&theme=tokyonight&overview_width=1300&overview_height=740&overview_langs_count=6

Themes

All available themes shipped with GitHub Stats.

tokyonight

radical

dracula

dark

light

nord

gruvbox

monokai

synthwave

nightowl

cobalt

Caching

Responses are cached to keep the API fast. Use cache_seconds to control cache time.

/api?username=yourname&cache_seconds=900

Custom Colors

Override theme colors with hex values or gradients.

/api?username=yourname&bg_color=0d1117,161b22&title_color=58a6ff&text_color=c9d1d9

Errors

If a username is missing or invalid, the API returns an error card instead of breaking.

FAQ

Can I use this commercially?

Yes. The cards are rendered on demand and cached for performance.