GitHub ReadMe Stats

API

Dynamically generated GitHub profile statistics for ReadMe files

Overview

GitHub ReadMe Stats is an open-source tool that generates dynamic SVG images with GitHub profile statistics for embedding in ReadMe files. It offers REST-like GET endpoints (e.g., /api?username=your-username) to retrieve user stats (followers, repo count, stars) or top programming languages (/api/top-langs). Users can customize outputs via parameters like theme, hidden stats, and card size. Use cases include enhancing GitHub profiles with real-time metrics, showcasing contribution activity, and highlighting technical expertise. It requires no authentication for public use and is maintained by the community.

Example Integration (JavaScript)

script.js JS


fetch('https://github.com/anuraghazra/github-readme-stats')
  .then(res => res.json())
  .then(data => console.log(data))
  .catch(err => console.error(err));

Key Features

REST-like endpoints
SVG image output
Customizable themes
No authentication required
Supports user stats & top languages
Open source

Frequently Asked Questions

? Is GitHub ReadMe Stats free to use?

Yes, it is completely free and open-source for public use.

? Does it require an API Key?

No, authentication is not needed to access the public endpoints.

? What is the response format?

It returns SVG images that can be embedded directly in GitHub ReadMe files.

Top Alternatives

Shields.io Search Google

GitHub Profile ReadMe Generator Search Google

Tool Info

Pricing Free

Category Open Source Projects

Platform Public API

Pros

⊕ Easy to embed in ReadMe files
⊕ Highly customizable (themes, stats visibility)
⊕ Real-time data updates
⊕ Open source (modifiable)

Cons

⊖ Subject to Vercel's rate limits
⊖ No official SLA
⊖ Depends on external hosting uptime