API Documentation
Generate beautiful, customizable SVG cards for your GitHub profile. All endpoints return SVG images that can be embedded in markdown or HTML.
/api/v1All API endpoints are prefixed with this base URL. Cards are returned as SVG images with appropriate caching headers.
SVG cards are cached in Cloudflare R2 storage for optimal performance.
SVG Cache
Generated SVG cards are stored in R2 and reused until manually refreshed using the refresh parameter
HTTP Cache
Browsers and Cloudflare edge cache SVG responses for 48 hours, with background revalidation
Force Refresh
Add refresh=true to bypass the R2 cache; the refreshed response is not stored in browser or edge caches
Data Cache
GitHub API data is cached for 24 hours in KV storage to reduce API calls
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 cardAvailable Endpoints
/api/v1Generate a GitHub stats card as SVG image showing stars, commits, PRs, issues, and rank.
/api/v1/top-langsGenerate a card showing most used programming languages as SVG image.
/api/v1/pinGenerate a repository pin card as SVG image.
/api/v1/gistGenerate a GitHub gist card as SVG image.
Add a stats card to your GitHub README:
