API Documentation

Generate beautiful, customizable SVG cards for your GitHub profile. All endpoints return SVG images that can be embedded in markdown or HTML.

Base URL
/api/v1

All API endpoints are prefixed with this base URL. Cards are returned as SVG images with appropriate caching headers.

Caching

SVG cards are cached in Cloudflare R2 storage for optimal performance.

SVG Cache

Generated SVG cards are cached until manually refreshed using the refresh parameter

Force Refresh

Add refresh=true parameter to force regenerate the card with fresh data

Data Cache

GitHub API data is cached for 24 hours in KV storage to reduce API calls

Common Parameters

These parameters are available across all endpoints for customization.

themePre-built color themes (default, dark, radical, tokyonight, etc.)
fontFont family for card text (google-sans-flex, jetbrains-mono, etc.)
border_radiusCard corner radius in pixels (0-50)
refreshSet to true to bypass cache and regenerate the card
Quick Start

Add a stats card to your GitHub README:

![GitHub Stats](/api/v1?username=YOUR_USERNAME)