ygoprodeck.search

stable Advanced

Search Yu-Gi-Oh! cards by name fragment.

GET /v1/ygoprodeck/search

What you get#

A list of Ygoprodeck results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

Advanced · 5 credits 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
`q`	string	yes	(required)	Name fragment	max 100 chars; must match `[^\x00-\x1f]{2,100}`; trimmed, repeated spaces collapsed

Request#

curl "https://api.onekey.dev/v1/ygoprodeck/search?q=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
      }
    },
    {
      "entity": {
        "id": "38033121",
        "name": "Dark Magician Girl",
        "type": "Effect Monster",
        "url": "https://ygoprodeck.com/card/dark-magician-girl-3219"
      },
      "content": {
        "text": "Gains 300 ATK for every \"Dark Magician\" or \"Magician of Black Chaos\" in the GY."
      },
      "ext": {
        "race": "Spellcaster",
        "attribute": "DARK",
        "archetype": "Dark Magician",
        "atk": 2000,
        "def": 1700,
        "level": 6
      },
      "media": {
        "url": "https://images.ygoprodeck.com/images/cards/38033121.jpg",
        "thumbnailUrl": "https://images.ygoprodeck.com/images/cards_small/38033121.jpg"
      },
      "listing": {
        "price": 0.44
      }
    }
  ],
  "metadata": {
    "platform": "ygoprodeck",
    "endpoint": "search",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "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
`id`	`entity.id`	`toString`
`name`	`entity.name`	-
`desc`	`content.text`	-
`type`	`entity.type`	-
`race`	`ext.race`	-
`attribute`	`ext.attribute`	-
`archetype`	`ext.archetype`	-
`atk`	`ext.atk`	`toNumber`
`def`	`ext.def`	`toNumber`
`level`	`ext.level`	`toNumber`
`ygoprodeck_url`	`entity.url`	`safeUrl`
`card_images.0.image_url`	`media.url`	`safeUrl`
`card_images.0.image_url_small`	`media.thumbnailUrl`	`safeUrl`
`card_prices.0.tcgplayer_price`	`listing.price`	`toNumber`

Caching and freshness#

Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
Between 2 minutes and 15 minutes 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 1 hour more (marked stale).
A "not found" is remembered for 1 minute 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`	Unknown endpoint path.
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).