GET/api/v1/pin

Repository Pin Card

Generate a repository pin card as SVG image.

Parameters

usernamerequired

string

GitHub username or organization

reporequired

string

Repository name

theme

stringdefault: default

Card theme

title_color

string

Title color (hex without #)

text_color

string

Text color (hex without #)

icon_color

string

Icon color (hex without #)

bg_color

string

Background color (hex without #)

border_color

string

Border color (hex without #)

hide_border

booleandefault: false

Hide card border

show_owner

booleandefault: false

Show repository owner in title

font

stringdefault: google-sans-flex

Font family for card text

icon_set

stringdefault: default

Icon library to use for icons

emoji_set

stringdefault: twitter

Emoji style for rendering emojis in descriptions

border_radius

numberdefault: 6range: 0-50

Card border radius in pixels

refresh

booleandefault: false

Force refresh the card (bypass cache)

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

Example

Request URL

/api/v1/pin?username=facebook&repo=react

Markdown (for README)

![Repository Pin Card](/api/v1/pin?username=facebook&repo=react)

HTML

<img src="/api/v1/pin?username=facebook&repo=react" alt="Repository Pin Card" />

Preview