GitHub ReadMe Stats

Overview

GitHub ReadMe Stats generates dynamic SVG cards for your GitHub profile README — stats, top languages, streak, and trophies. A beloved open-source tool used on millions of profile pages.

⚠️ Status (verified 2026-08): the public deployment at github-readme-stats.vercel.app returned HTTP 503 “DEPLOYMENT_PAUSED” — the hosted instance is currently paused. The project is open-source, so you can self-host it (Vercel/Netlify/Railway one-click) until the official instance returns.

How it works

An image URL embeds your GitHub username — browsers render the SVG:

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

With options:

![Top languages](https://github-readme-stats.vercel.app/api/top-langs/?username=octocat&layout=compact)
![Streak](https://github-readme-stats.vercel.app/api?username=octocat&theme=dark)

Authentication

None needed for public repos (anonymous); a token= param raises the rate limit (do not expose in public repos).

Rate Limits & Notes

• Anonymous: limited requests per hour; the README recommends caching.
• Themes (theme=dark, theme=radical…), layouts (layout=compact), and custom colors via title_color/bg_color.
• Self-hosting (repo has one-click deploy buttons) is the reliable path while the public instance is paused.

FAQ

Is GitHub ReadMe Stats still working? As of 2026-08 the public instance is paused (503 DEPLOYMENT_PAUSED) — verify or self-host.

Is it free? Yes — free and open-source; no key needed for public repos.

How do I self-host? Fork the repo and deploy via the one-click Vercel/Netlify/Railway buttons in the README.