GitHub Contributions Image

Generate beautiful contribution charts from any GitHub profile

Generate Your Chart

GitHub Username

Time Range

Theme

Preview

Markdown

![GitHub Contributions](/api/v1/image?username=cyronlee&range=1y&theme=light)

HTML

<img src="/api/v1/image?username=cyronlee&range=1y&theme=light" alt="GitHub Contributions" />

Direct URL

/api/v1/image?username=cyronlee&range=1y&theme=light

API Documentation

Image API

Generate a PNG image of GitHub contribution chart.

Endpoint

GET /api/v1/image

Parameters

Name	Type	Description
`username`	string (required)	GitHub username
`range`	string (optional)	Time range: `{n}w` (weeks), `{n}m` (months), `{n}y` (years). e.g., `2w`, `6m`, `1y`
`theme`	string (optional)	Theme: `light` (default), `dark`

Example

/api/v1/image?username=cyronlee&range=1y&theme=light

Data API

Get raw contribution data in JSON format.

Endpoint

GET /api/v1/data

Parameters

Name	Type	Description
`username`	string (required)	GitHub username
`range`	string (optional)	Time range: `{n}w` (weeks), `{n}m` (months), `{n}y` (years). e.g., `2w`, `6m`, `1y`

Example

/api/v1/data?username=cyronlee&range=6m

Response

{
  "total": 492,
  "range": {
    "start": "2025-01-20",
    "end": "2026-01-20"
  },
  "contributions": [
    {
      "date": "2025-01-20",
      "count": 5,
      "level": 2
    }
  ]
}

Features

•Fast & Reliable: Powered by Vercel Edge Runtime with global CDN
•High Quality: 2x resolution for crisp Retina displays
•Smart Caching: 1 hour CDN cache with 24 hour stale-while-revalidate
•Flexible: Customizable time ranges and themes

Built with Next.js • Data from GitHub • Open Source on GitHub