Skip to content

Get an earned card's share picture​

GET
/cards/{code}/share/{asset}

A PNG of one earned card: og 1200×630, post 1080×1080, story 1080×1920 (a trailing .png is accepted). Served only when the card is readable by a stranger. When the card's own picture is not rendered yet, the badge's generic picture is served with X-Card-Render: pending and no-store. Supports If-None-Match (304). Public; a per-IP limit (120 per minute by default) applies in addition to the public browsing limit.

Parameters​

Path Parameters

code*

The card's short code.

Type
string
Required
asset*
Type
string
Required
Valid values
"og""post""story""og.png""post.png""story.png"

Query Parameters

lang
Type
string

Responses​

PNG image. Content-Language names the language it was drawn in.

image/png

Playground​

Server
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress