ygoprodeck.card

stable Standard

Fetch a Yu-Gi-Oh! card by exact name.

GET /v1/ygoprodeck/card

What you get#

One Ygoprodeck record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

What it costs#

Standard · 1 credit for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`name`	string	yes	(required)	Exact card name	max 100 chars; must match `[^\x00-\x1f]{2,100}`; trimmed, repeated spaces collapsed

Request#

curl "https://api.onekey.dev/v1/ygoprodeck/card?name=Dark%20Magician" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Ygoprodeck response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": {
    "entity": {
      "id": "46986414",
      "name": "Dark Magician",
      "type": "Normal Monster",
      "url": "https://ygoprodeck.com/card/dark-magician-4003"
    },
    "content": {
      "text": "''The ultimate wizard in terms of attack and defense.''"
    },
    "ext": {
      "race": "Spellcaster",
      "attribute": "DARK",
      "archetype": "Dark Magician",
      "atk": 2500,
      "def": 2100,
      "level": 7
    },
    "media": {
      "url": "https://images.ygoprodeck.com/images/cards/46986414.jpg",
      "thumbnailUrl": "https://images.ygoprodeck.com/images/cards_small/46986414.jpg"
    },
    "listing": {
      "price": 0.36
    }
  },
  "metadata": {
    "platform": "ygoprodeck",
    "endpoint": "card",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`data.0.id`	`entity.id`	`toString`
`data.0.name`	`entity.name`	-
`data.0.desc`	`content.text`	-
`data.0.type`	`entity.type`	-
`data.0.race`	`ext.race`	-
`data.0.attribute`	`ext.attribute`	-
`data.0.archetype`	`ext.archetype`	-
`data.0.atk`	`ext.atk`	`toNumber`
`data.0.def`	`ext.def`	`toNumber`
`data.0.level`	`ext.level`	`toNumber`
`data.0.ygoprodeck_url`	`entity.url`	`safeUrl`
`data.0.card_images.0.image_url`	`media.url`	`safeUrl`
`data.0.card_images.0.image_url_small`	`media.thumbnailUrl`	`safeUrl`
`data.0.card_prices.0.tcgplayer_price`	`listing.price`	`toNumber`

Caching and freshness#

Fresh for about 1 hour. Repeat calls in that window are served from cache and are free.
Between 1 hour and 1 day the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 2 days more (marked stale).
A "not found" is remembered for 5 minutes and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	That record does not exist. Free; do not retry.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).