# YGOPRODeck

> Look up Yu-Gi-Oh! cards on YGOPRODeck: search all 14,000+ cards by name, type, attribute, ATK/DEF, archetype or set, read the ban lists, list what is in any set, and get each card's artwork and current prices from TCGplayer, Cardmarket, eBay, Amazon and CoolStuffInc. No account or API key required.

App · Gaming · 13 actions. Web page: https://docs.lodol.com/docs/integrations/ygoprodeck

## Actions

### Get a printing by set code

Look up one printing by the code on the card itself, such as SDY-046, and get the card it is, its rarity in that set and what that printing sells for. No API key required.

**Inputs**

- Set code (`set_code`, text, required): The code printed on the card, for example SDY-046. This is the card's own code, not the set's code.

**Outputs**

- `id` (number): The card's passcode.
- `name` (text): Card name.
- `set_code` (text): The code that was looked up.
- `set_name` (text): The set this printing is from.
- `set_price` (number): Price of this printing in USD. Null when YGOPRODeck has no price.
- `set_rarity` (text): Rarity of this printing.

**Example output**

```json
{
  "id": 54652250,
  "name": "Man-Eater Bug",
  "set_code": "SDY-046",
  "set_name": "Starter Deck: Yugi",
  "set_price": 2.25,
  "set_rarity": "Common"
}
```

### Get a random card

Draw one card at random from the whole database, with its text, artwork and prices. Good for a card-of-the-day post or a quiz. No API key required.

**Inputs**: None.

**Outputs**

- `card` (object): The card.

**Example output**

```json
{
  "card": {
    "archetype": null,
    "atk": 2100,
    "attribute": "WIND",
    "banlist": {
      "goat": "Unlimited",
      "ocg": "Unlimited",
      "tcg": "Unlimited"
    },
    "card_sets": [
      {
        "set_code": "MACR-EN081",
        "set_name": "Maximum Crisis",
        "set_price": 4.32,
        "set_rarity": "Secret Rare",
        "set_rarity_code": "(ScR)"
      }
    ],
    "def": 2000,
    "description": "2 Level 4 monsters\nOnce per turn (Quick Effect): You can detach 1 material from this card, then target 1 Spell/Trap on the field; destroy it.",
    "extra_details": {
      "beta_name": null,
      "downvotes": 5,
      "formats": [
        "Duel Links",
        "TCG",
        "OCG",
        "Master Duel"
      ],
      "genesys_ocg_points": null,
      "genesys_points": null,
      "has_effect": true,
      "konami_id": 13019,
      "master_duel_rarity": "Ultra Rare",
      "ocg_release_date": "2017-09-09",
      "tcg_release_date": "2017-05-04",
      "treated_as": null,
      "upvotes": 24,
      "views": 1843939,
      "views_this_week": 3213
    },
    "frame_type": "xyz",
    "human_readable_card_type": "Xyz Effect Monster",
    "id": 6983839,
    "image_url": "https://images.ygoprodeck.com/images/cards/6983839.jpg",
    "image_url_cropped": "https://images.ygoprodeck.com/images/cards_cropped/6983839.jpg",
    "image_url_small": "https://images.ygoprodeck.com/images/cards_small/6983839.jpg",
    "images": [
      {
        "id": 6983839,
        "image_url": "https://images.ygoprodeck.com/images/cards/6983839.jpg",
        "image_url_cropped": "https://images.ygoprodeck.com/images/cards_cropped/6983839.jpg",
        "image_url_small": "https://images.ygoprodeck.com/images/cards_small/6983839.jpg"
      }
    ],
    "level": 4,
    "link_markers": [],
    "link_value": null,
    "monster_description": null,
    "name": "Tornado Dragon",
    "pendulum_description": null,
    "prices": {
      "amazon_price": 1.39,
      "cardmarket_price": 0.06,
      "coolstuffinc_price": 0.25,
      "ebay_price": 0.99,
      "tcgplayer_price": 0.07
    },
    "race": "Wyrm",
    "scale": null,
    "type": "XYZ Monster",
    "type_line": [
      "Wyrm",
      "Xyz",
      "Effect"
    ],
    "ygoprodeck_url": "https://ygoprodeck.com/card/tornado-dragon-8538"
  }
}
```

### Get cards by ID

Look one or more cards up by the 8-digit passcode printed on the card, or by Konami's own card id from the official database. Best when a workflow already holds an id from a deck list, a scan or an earlier step. No API key required.

**Inputs**

- Passcodes (`passcodes`, list): The 8-digit passcodes printed in the card's bottom-left corner, for example 46986414. Leave blank if you are using Konami IDs instead.
- Konami IDs (`konami_ids`, list): Konami's own card ids, as used by the official database (not the passcode). Use these instead of passcodes, not alongside them.
- Language (`language`, text): Optional. Return card names and text in this language. Leave blank for English. Card images are only stored in English. One of: `fr` (French), `de` (German), `it` (Italian), `pt` (Portuguese).
- Include extra details (`include_extra_details`, true/false): Optional. Also return the card's release dates, Konami ID, the formats it is legal in, its Master Duel rarity and its view and vote counts. On by default for a direct lookup. Default: `true`.

**Outputs**

- `cards` (list): One entry per id that was found.
- `count` (number): How many cards were found.

**Example output**

```json
{
  "cards": [
    {
      "archetype": null,
      "atk": 2100,
      "attribute": "WIND",
      "banlist": {
        "goat": "Unlimited",
        "ocg": "Unlimited",
        "tcg": "Unlimited"
      },
      "card_sets": [
        {
          "set_code": "MACR-EN081",
          "set_name": "Maximum Crisis",
          "set_price": 4.32,
          "set_rarity": "Secret Rare",
          "set_rarity_code": "(ScR)"
        }
      ],
      "def": 2000,
      "description": "2 Level 4 monsters\nOnce per turn (Quick Effect): You can detach 1 material from this card, then target 1 Spell/Trap on the field; destroy it.",
      "extra_details": {
        "beta_name": null,
        "downvotes": 5,
        "formats": [
          "Duel Links",
          "TCG",
          "OCG",
          "Master Duel"
        ],
        "genesys_ocg_points": null,
        "genesys_points": null,
        "has_effect": true,
        "konami_id": 13019,
        "master_duel_rarity": "Ultra Rare",
        "ocg_release_date": "2017-09-09",
        "tcg_release_date": "2017-05-04",
        "treated_as": null,
        "upvotes": 24,
        "views": 1843939,
        "views_this_week": 3213
      },
      "frame_type": "xyz",
      "human_readable_card_type": "Xyz Effect Monster",
      "id": 6983839,
      "image_url": "https://images.ygoprodeck.com/images/cards/6983839.jpg",
      "image_url_cropped": "https://images.ygoprodeck.com/images/cards_cropped/6983839.jpg",
      "image_url_small": "https://images.ygoprodeck.com/images/cards_small/6983839.jpg",
      "images": [
        {
          "id": 6983839,
          "image_url": "https://images.ygoprodeck.com/images/cards/6983839.jpg",
          "image_url_cropped": "https://images.ygoprodeck.com/images/cards_cropped/6983839.jpg",
          "image_url_small": "https://images.ygoprodeck.com/images/cards_small/6983839.jpg"
        }
      ],
      "level": 4,
      "link_markers": [],
      "link_value": null,
      "monster_description": null,
      "name": "Tornado Dragon",
      "pendulum_description": null,
      "prices": {
        "amazon_price": 1.39,
        "cardmarket_price": 0.06,
        "coolstuffinc_price": 0.25,
        "ebay_price": 0.99,
        "tcgplayer_price": 0.07
      },
      "race": "Wyrm",
      "scale": null,
      "type": "XYZ Monster",
      "type_line": [
        "Wyrm",
        "Xyz",
        "Effect"
      ],
      "ygoprodeck_url": "https://ygoprodeck.com/card/tornado-dragon-8538"
    }
  ],
  "count": 1
}
```

### Get cards by name

Look one or more cards up by their exact names and get the full record: text, artwork, every printing with its rarity and price, ban list status and release dates. Use Search cards first if you only have part of a name. No API key required.

**Inputs**

- Card names (`names`, list, required): The exact card names to look up, for example Dark Magician. Spelling and punctuation must match the card exactly.
- Language (`language`, text): Optional. The language the names are written in, which is also the language the cards come back in. Leave blank for English: a French name is only found when French is chosen here. One of: `fr` (French), `de` (German), `it` (Italian), `pt` (Portuguese).
- Include extra details (`include_extra_details`, true/false): Optional. Also return the card's release dates, Konami ID, the formats it is legal in, its Master Duel rarity and its view and vote counts. On by default for a direct lookup. Default: `true`.

**Outputs**

- `cards` (list): One entry per name that was found.
- `count` (number): How many cards were found.

**Example output**

```json
{
  "cards": [
    {
      "archetype": null,
      "atk": 2100,
      "attribute": "WIND",
      "banlist": {
        "goat": "Unlimited",
        "ocg": "Unlimited",
        "tcg": "Unlimited"
      },
      "card_sets": [
        {
          "set_code": "MACR-EN081",
          "set_name": "Maximum Crisis",
          "set_price": 4.32,
          "set_rarity": "Secret Rare",
          "set_rarity_code": "(ScR)"
        }
      ],
      "def": 2000,
      "description": "2 Level 4 monsters\nOnce per turn (Quick Effect): You can detach 1 material from this card, then target 1 Spell/Trap on the field; destroy it.",
      "extra_details": {
        "beta_name": null,
        "downvotes": 5,
        "formats": [
          "Duel Links",
          "TCG",
          "OCG",
          "Master Duel"
        ],
        "genesys_ocg_points": null,
        "genesys_points": null,
        "has_effect": true,
        "konami_id": 13019,
        "master_duel_rarity": "Ultra Rare",
        "ocg_release_date": "2017-09-09",
        "tcg_release_date": "2017-05-04",
        "treated_as": null,
        "upvotes": 24,
        "views": 1843939,
        "views_this_week": 3213
      },
      "frame_type": "xyz",
      "human_readable_card_type": "Xyz Effect Monster",
      "id": 6983839,
      "image_url": "https://images.ygoprodeck.com/images/cards/6983839.jpg",
      "image_url_cropped": "https://images.ygoprodeck.com/images/cards_cropped/6983839.jpg",
      "image_url_small": "https://images.ygoprodeck.com/images/cards_small/6983839.jpg",
      "images": [
        {
          "id": 6983839,
          "image_url": "https://images.ygoprodeck.com/images/cards/6983839.jpg",
          "image_url_cropped": "https://images.ygoprodeck.com/images/cards_cropped/6983839.jpg",
          "image_url_small": "https://images.ygoprodeck.com/images/cards_small/6983839.jpg"
        }
      ],
      "level": 4,
      "link_markers": [],
      "link_value": null,
      "monster_description": null,
      "name": "Tornado Dragon",
      "pendulum_description": null,
      "prices": {
        "amazon_price": 1.39,
        "cardmarket_price": 0.06,
        "coolstuffinc_price": 0.25,
        "ebay_price": 0.99,
        "tcgplayer_price": 0.07
      },
      "race": "Wyrm",
      "scale": null,
      "type": "XYZ Monster",
      "type_line": [
        "Wyrm",
        "Xyz",
        "Effect"
      ],
      "ygoprodeck_url": "https://ygoprodeck.com/card/tornado-dragon-8538"
    }
  ],
  "count": 1
}
```

### Get database version

Read the card database's version number and when it last changed. The version moves whenever a card is added or edited, so a scheduled workflow can store it and only do work when new cards land. No API key required.

**Inputs**: None.

**Outputs**

- `database_version` (text): The database's version, e.g. 146.53. Compare it with the last one you stored to spot a change.
- `last_update` (text): When the database last changed, YYYY-MM-DD HH:MM:SS in UTC.

**Example output**

```json
{
  "database_version": "146.53",
  "last_update": "2026-08-13 04:02:05"
}
```

### List archetypes

List every card archetype YGOPRODeck tracks, A-Z, optionally narrowed by name. Feed one into List cards in an archetype to pull the whole theme. No API key required.

**Inputs**

- Name contains (`name_contains`, text): Optional. Only archetypes whose name contains this text, for example "eyes". Leave blank for every one.

**Outputs**

- `archetypes` (list): The matching archetype names, A-Z. List cards in an archetype takes one of these.
- `count` (number): How many archetypes were returned.

**Example output**

```json
{
  "archetypes": [
    "Blue-Eyes",
    "Dark Magician",
    "Prank-Kids"
  ],
  "count": 3
}
```

### List ban list cards

List every card restricted on the TCG, OCG or GOAT ban list, each with its Forbidden, Limited or Semi-Limited status. Use it to check a deck against the current list. No API key required.

**Inputs**

- Ban list (`banlist`, text, required): Which ban list to read. One of: `tcg`, `ocg`, `goat`.
- Format (`card_format`, text): Optional. Only cards playable in this format. Leave blank for every card. The ban list statuses returned are always the TCG, OCG and GOAT ones, whichever format is picked. One of: `tcg`, `ocg`, `master duel`, `duel links`, `speed duel`, `goat`, `ocg goat`, `edison`, `genesys`, `genesys ocg`, `common charity`.
- Sort by (`sort_by`, text): Optional. How to order the cards. Leave blank for the database's own order. One of: `atk`, `def`, `name` (Name (A-Z)), `level` (Level / Rank), `id` (Passcode), `new` (Recently added first), `relevance` (Best match).
- Language (`language`, text): Optional. Return card names and text in this language. Leave blank for English. Card images are only stored in English. One of: `fr` (French), `de` (German), `it` (Italian), `pt` (Portuguese).
- Include extra details (`include_extra_details`, true/false): Optional. Also return each card's release dates, Konami ID, the formats it is legal in, its Master Duel rarity and its view and vote counts. Off by default. Default: `false`.
- Cards per page (`limit`, number): Optional. How many cards to return, up to 1000. Defaults to 50. From 1 to 1000. Default: `50`.
- Skip (`offset`, number): Optional. How many cards to skip before returning results. Use the result's next_offset to walk through a long list. At least 0. Default: `0`.

**Outputs**

- `cards` (list): The restricted cards, with their ban list status.
- `count` (number): How many cards this page returned.
- `has_more` (true/false): Whether more cards are left after this page.
- `next_offset` (number): The offset that reads the next page. Null on the last page.
- `offset` (number): How many cards were skipped to reach this page.
- `total_count` (number): How many cards matched in total.

**Example output**

```json
{
  "cards": [
    {
      "archetype": null,
      "atk": 2100,
      "attribute": "WIND",
      "banlist": {
        "goat": "Unlimited",
        "ocg": "Unlimited",
        "tcg": "Unlimited"
      },
      "card_sets": [
        {
          "set_code": "MACR-EN081",
          "set_name": "Maximum Crisis",
          "set_price": 4.32,
          "set_rarity": "Secret Rare",
          "set_rarity_code": "(ScR)"
        }
      ],
      "def": 2000,
      "description": "2 Level 4 monsters\nOnce per turn (Quick Effect): You can detach 1 material from this card, then target 1 Spell/Trap on the field; destroy it.",
      "extra_details": {
        "beta_name": null,
        "downvotes": 5,
        "formats": [
          "Duel Links",
          "TCG",
          "OCG",
          "Master Duel"
        ],
        "genesys_ocg_points": null,
        "genesys_points": null,
        "has_effect": true,
        "konami_id": 13019,
        "master_duel_rarity": "Ultra Rare",
        "ocg_release_date": "2017-09-09",
        "tcg_release_date": "2017-05-04",
        "treated_as": null,
        "upvotes": 24,
        "views": 1843939,
        "views_this_week": 3213
      },
      "frame_type": "xyz",
      "human_readable_card_type": "Xyz Effect Monster",
      "id": 6983839,
      "image_url": "https://images.ygoprodeck.com/images/cards/6983839.jpg",
      "image_url_cropped": "https://images.ygoprodeck.com/images/cards_cropped/6983839.jpg",
      "image_url_small": "https://images.ygoprodeck.com/images/cards_small/6983839.jpg",
      "images": [
        {
          "id": 6983839,
          "image_url": "https://images.ygoprodeck.com/images/cards/6983839.jpg",
          "image_url_cropped": "https://images.ygoprodeck.com/images/cards_cropped/6983839.jpg",
          "image_url_small": "https://images.ygoprodeck.com/images/cards_small/6983839.jpg"
        }
      ],
      "level": 4,
      "link_markers": [],
      "link_value": null,
      "monster_description": null,
      "name": "Tornado Dragon",
      "pendulum_description": null,
      "prices": {
        "amazon_price": 1.39,
        "cardmarket_price": 0.06,
        "coolstuffinc_price": 0.25,
        "ebay_price": 0.99,
        "tcgplayer_price": 0.07
      },
      "race": "Wyrm",
      "scale": null,
      "type": "XYZ Monster",
      "type_line": [
        "Wyrm",
        "Xyz",
        "Effect"
      ],
      "ygoprodeck_url": "https://ygoprodeck.com/card/tornado-dragon-8538"
    }
  ],
  "count": 1,
  "has_more": true,
  "next_offset": 1,
  "offset": 0,
  "total_count": 137
}
```

### List card sets

List every Yu-Gi-Oh! set with its code, how many cards it holds, its release date and its box art. Filter by name to find one, then feed the set name into List cards in a set. No API key required.

**Inputs**

- Name or code contains (`name_contains`, text): Optional. Only sets whose name or code contains this text, for example "legend" or "LOB". Leave blank for every set.

**Outputs**

- `count` (number): How many sets were returned.
- `sets` (list): The matching sets, A-Z.

**Example output**

```json
{
  "count": 1,
  "sets": [
    {
      "number_of_cards": 144,
      "set_code": "MRD",
      "set_image": "https://images.ygoprodeck.com/images/sets/MRD.jpg",
      "set_name": "Metal Raiders",
      "tcg_release_date": "2002-06-26"
    }
  ]
}
```

### List cards by release date

List the cards released between two dates, using either TCG or OCG release dates. Point it at the last few weeks to catch new releases, or at a year in the past to see what a format looked like. No API key required.

**Inputs**

- Released on or after (`released_from`, date): Optional. Only cards released on or after this date.
- Released on or before (`released_to`, date): Optional. Only cards released on or before this date.
- Release dates to use (`date_region`, text): Optional. Which region's release dates the date filters compare against. Defaults to TCG. One of: `tcg` (TCG release dates), `ocg` (OCG release dates). Default: `tcg`.
- Sort by (`sort_by`, text): Optional. How to order the cards. Leave blank for the database's own order. One of: `atk`, `def`, `name` (Name (A-Z)), `level` (Level / Rank), `id` (Passcode), `new` (Recently added first), `relevance` (Best match).
- Language (`language`, text): Optional. Return card names and text in this language. Leave blank for English. Card images are only stored in English. One of: `fr` (French), `de` (German), `it` (Italian), `pt` (Portuguese).
- Include extra details (`include_extra_details`, true/false): Optional. Also return each card's release dates, Konami ID, the formats it is legal in, its Master Duel rarity and its view and vote counts. Off by default. Default: `false`.
- Cards per page (`limit`, number): Optional. How many cards to return, up to 1000. Defaults to 50. From 1 to 1000. Default: `50`.
- Skip (`offset`, number): Optional. How many cards to skip before returning results. Use the result's next_offset to walk through a long list. At least 0. Default: `0`.

**Outputs**

- `cards` (list): The cards released in the window.
- `count` (number): How many cards this page returned.
- `has_more` (true/false): Whether more cards are left after this page.
- `next_offset` (number): The offset that reads the next page. Null on the last page.
- `offset` (number): How many cards were skipped to reach this page.
- `total_count` (number): How many cards matched in total.

**Example output**

```json
{
  "cards": [
    {
      "archetype": null,
      "atk": 2100,
      "attribute": "WIND",
      "banlist": {
        "goat": "Unlimited",
        "ocg": "Unlimited",
        "tcg": "Unlimited"
      },
      "card_sets": [
        {
          "set_code": "MACR-EN081",
          "set_name": "Maximum Crisis",
          "set_price": 4.32,
          "set_rarity": "Secret Rare",
          "set_rarity_code": "(ScR)"
        }
      ],
      "def": 2000,
      "description": "2 Level 4 monsters\nOnce per turn (Quick Effect): You can detach 1 material from this card, then target 1 Spell/Trap on the field; destroy it.",
      "extra_details": {
        "beta_name": null,
        "downvotes": 5,
        "formats": [
          "Duel Links",
          "TCG",
          "OCG",
          "Master Duel"
        ],
        "genesys_ocg_points": null,
        "genesys_points": null,
        "has_effect": true,
        "konami_id": 13019,
        "master_duel_rarity": "Ultra Rare",
        "ocg_release_date": "2017-09-09",
        "tcg_release_date": "2017-05-04",
        "treated_as": null,
        "upvotes": 24,
        "views": 1843939,
        "views_this_week": 3213
      },
      "frame_type": "xyz",
      "human_readable_card_type": "Xyz Effect Monster",
      "id": 6983839,
      "image_url": "https://images.ygoprodeck.com/images/cards/6983839.jpg",
      "image_url_cropped": "https://images.ygoprodeck.com/images/cards_cropped/6983839.jpg",
      "image_url_small": "https://images.ygoprodeck.com/images/cards_small/6983839.jpg",
      "images": [
        {
          "id": 6983839,
          "image_url": "https://images.ygoprodeck.com/images/cards/6983839.jpg",
          "image_url_cropped": "https://images.ygoprodeck.com/images/cards_cropped/6983839.jpg",
          "image_url_small": "https://images.ygoprodeck.com/images/cards_small/6983839.jpg"
        }
      ],
      "level": 4,
      "link_markers": [],
      "link_value": null,
      "monster_description": null,
      "name": "Tornado Dragon",
      "pendulum_description": null,
      "prices": {
        "amazon_price": 1.39,
        "cardmarket_price": 0.06,
        "coolstuffinc_price": 0.25,
        "ebay_price": 0.99,
        "tcgplayer_price": 0.07
      },
      "race": "Wyrm",
      "scale": null,
      "type": "XYZ Monster",
      "type_line": [
        "Wyrm",
        "Xyz",
        "Effect"
      ],
      "ygoprodeck_url": "https://ygoprodeck.com/card/tornado-dragon-8538"
    }
  ],
  "count": 1,
  "has_more": true,
  "next_offset": 1,
  "offset": 0,
  "total_count": 137
}
```

### List cards in a set

List every card printed in one set, chosen from a dropdown of all 1,000+ Yu-Gi-Oh! sets, with the rarity and price of that set's printing. Use it to price a box or check what is in a pack. No API key required.

**Inputs**

- Card set (`card_set`, text, required): The set to list, chosen from the list of every set YGOPRODeck knows.
- Sort by (`sort_by`, text): Optional. How to order the cards. Leave blank for the database's own order. One of: `atk`, `def`, `name` (Name (A-Z)), `level` (Level / Rank), `id` (Passcode), `new` (Recently added first), `relevance` (Best match).
- Language (`language`, text): Optional. Return card names and text in this language. Leave blank for English. Card images are only stored in English. One of: `fr` (French), `de` (German), `it` (Italian), `pt` (Portuguese).
- Include extra details (`include_extra_details`, true/false): Optional. Also return each card's release dates, Konami ID, the formats it is legal in, its Master Duel rarity and its view and vote counts. Off by default. Default: `false`.
- Cards per page (`limit`, number): Optional. How many cards to return, up to 1000. Defaults to 50. From 1 to 1000. Default: `50`.
- Skip (`offset`, number): Optional. How many cards to skip before returning results. Use the result's next_offset to walk through a long list. At least 0. Default: `0`.

**Outputs**

- `cards` (list): The cards printed in the set.
- `count` (number): How many cards this page returned.
- `has_more` (true/false): Whether more cards are left after this page.
- `next_offset` (number): The offset that reads the next page. Null on the last page.
- `offset` (number): How many cards were skipped to reach this page.
- `total_count` (number): How many cards matched in total.

**Example output**

```json
{
  "cards": [
    {
      "archetype": null,
      "atk": 2100,
      "attribute": "WIND",
      "banlist": {
        "goat": "Unlimited",
        "ocg": "Unlimited",
        "tcg": "Unlimited"
      },
      "card_sets": [
        {
          "set_code": "MACR-EN081",
          "set_name": "Maximum Crisis",
          "set_price": 4.32,
          "set_rarity": "Secret Rare",
          "set_rarity_code": "(ScR)"
        }
      ],
      "def": 2000,
      "description": "2 Level 4 monsters\nOnce per turn (Quick Effect): You can detach 1 material from this card, then target 1 Spell/Trap on the field; destroy it.",
      "extra_details": {
        "beta_name": null,
        "downvotes": 5,
        "formats": [
          "Duel Links",
          "TCG",
          "OCG",
          "Master Duel"
        ],
        "genesys_ocg_points": null,
        "genesys_points": null,
        "has_effect": true,
        "konami_id": 13019,
        "master_duel_rarity": "Ultra Rare",
        "ocg_release_date": "2017-09-09",
        "tcg_release_date": "2017-05-04",
        "treated_as": null,
        "upvotes": 24,
        "views": 1843939,
        "views_this_week": 3213
      },
      "frame_type": "xyz",
      "human_readable_card_type": "Xyz Effect Monster",
      "id": 6983839,
      "image_url": "https://images.ygoprodeck.com/images/cards/6983839.jpg",
      "image_url_cropped": "https://images.ygoprodeck.com/images/cards_cropped/6983839.jpg",
      "image_url_small": "https://images.ygoprodeck.com/images/cards_small/6983839.jpg",
      "images": [
        {
          "id": 6983839,
          "image_url": "https://images.ygoprodeck.com/images/cards/6983839.jpg",
          "image_url_cropped": "https://images.ygoprodeck.com/images/cards_cropped/6983839.jpg",
          "image_url_small": "https://images.ygoprodeck.com/images/cards_small/6983839.jpg"
        }
      ],
      "level": 4,
      "link_markers": [],
      "link_value": null,
      "monster_description": null,
      "name": "Tornado Dragon",
      "pendulum_description": null,
      "prices": {
        "amazon_price": 1.39,
        "cardmarket_price": 0.06,
        "coolstuffinc_price": 0.25,
        "ebay_price": 0.99,
        "tcgplayer_price": 0.07
      },
      "race": "Wyrm",
      "scale": null,
      "type": "XYZ Monster",
      "type_line": [
        "Wyrm",
        "Xyz",
        "Effect"
      ],
      "ygoprodeck_url": "https://ygoprodeck.com/card/tornado-dragon-8538"
    }
  ],
  "count": 1,
  "has_more": true,
  "next_offset": 1,
  "offset": 0,
  "total_count": 137
}
```

### List cards in an archetype

List every card in one archetype (Blue-Eyes, Prank-Kids, Sky Striker and the rest), chosen from a dropdown of all of them. The quickest way to pull a whole deck theme in one step. No API key required.

**Inputs**

- Archetype (`archetype`, text, required): The archetype to list, chosen from the list of every archetype YGOPRODeck knows.
- Sort by (`sort_by`, text): Optional. How to order the cards. Leave blank for the database's own order. One of: `atk`, `def`, `name` (Name (A-Z)), `level` (Level / Rank), `id` (Passcode), `new` (Recently added first), `relevance` (Best match).
- Language (`language`, text): Optional. Return card names and text in this language. Leave blank for English. Card images are only stored in English. One of: `fr` (French), `de` (German), `it` (Italian), `pt` (Portuguese).
- Include extra details (`include_extra_details`, true/false): Optional. Also return each card's release dates, Konami ID, the formats it is legal in, its Master Duel rarity and its view and vote counts. Off by default. Default: `false`.
- Cards per page (`limit`, number): Optional. How many cards to return, up to 1000. Defaults to 50. From 1 to 1000. Default: `50`.
- Skip (`offset`, number): Optional. How many cards to skip before returning results. Use the result's next_offset to walk through a long list. At least 0. Default: `0`.

**Outputs**

- `cards` (list): The cards in the archetype.
- `count` (number): How many cards this page returned.
- `has_more` (true/false): Whether more cards are left after this page.
- `next_offset` (number): The offset that reads the next page. Null on the last page.
- `offset` (number): How many cards were skipped to reach this page.
- `total_count` (number): How many cards matched in total.

**Example output**

```json
{
  "cards": [
    {
      "archetype": null,
      "atk": 2100,
      "attribute": "WIND",
      "banlist": {
        "goat": "Unlimited",
        "ocg": "Unlimited",
        "tcg": "Unlimited"
      },
      "card_sets": [
        {
          "set_code": "MACR-EN081",
          "set_name": "Maximum Crisis",
          "set_price": 4.32,
          "set_rarity": "Secret Rare",
          "set_rarity_code": "(ScR)"
        }
      ],
      "def": 2000,
      "description": "2 Level 4 monsters\nOnce per turn (Quick Effect): You can detach 1 material from this card, then target 1 Spell/Trap on the field; destroy it.",
      "extra_details": {
        "beta_name": null,
        "downvotes": 5,
        "formats": [
          "Duel Links",
          "TCG",
          "OCG",
          "Master Duel"
        ],
        "genesys_ocg_points": null,
        "genesys_points": null,
        "has_effect": true,
        "konami_id": 13019,
        "master_duel_rarity": "Ultra Rare",
        "ocg_release_date": "2017-09-09",
        "tcg_release_date": "2017-05-04",
        "treated_as": null,
        "upvotes": 24,
        "views": 1843939,
        "views_this_week": 3213
      },
      "frame_type": "xyz",
      "human_readable_card_type": "Xyz Effect Monster",
      "id": 6983839,
      "image_url": "https://images.ygoprodeck.com/images/cards/6983839.jpg",
      "image_url_cropped": "https://images.ygoprodeck.com/images/cards_cropped/6983839.jpg",
      "image_url_small": "https://images.ygoprodeck.com/images/cards_small/6983839.jpg",
      "images": [
        {
          "id": 6983839,
          "image_url": "https://images.ygoprodeck.com/images/cards/6983839.jpg",
          "image_url_cropped": "https://images.ygoprodeck.com/images/cards_cropped/6983839.jpg",
          "image_url_small": "https://images.ygoprodeck.com/images/cards_small/6983839.jpg"
        }
      ],
      "level": 4,
      "link_markers": [],
      "link_value": null,
      "monster_description": null,
      "name": "Tornado Dragon",
      "pendulum_description": null,
      "prices": {
        "amazon_price": 1.39,
        "cardmarket_price": 0.06,
        "coolstuffinc_price": 0.25,
        "ebay_price": 0.99,
        "tcgplayer_price": 0.07
      },
      "race": "Wyrm",
      "scale": null,
      "type": "XYZ Monster",
      "type_line": [
        "Wyrm",
        "Xyz",
        "Effect"
      ],
      "ygoprodeck_url": "https://ygoprodeck.com/card/tornado-dragon-8538"
    }
  ],
  "count": 1,
  "has_more": true,
  "next_offset": 1,
  "offset": 0,
  "total_count": 137
}
```

### List staple cards

List the cards YGOPRODeck marks as staples (the ones that fit in almost any deck), optionally narrowed to one format. A ready-made shopping list for a new player. No API key required.

**Inputs**

- Format (`card_format`, text): Optional. Only cards playable in this format. Leave blank for every card. The ban list statuses returned are always the TCG, OCG and GOAT ones, whichever format is picked. One of: `tcg`, `ocg`, `master duel`, `duel links`, `speed duel`, `goat`, `ocg goat`, `edison`, `genesys`, `genesys ocg`, `common charity`.
- Sort by (`sort_by`, text): Optional. How to order the cards. Leave blank for the database's own order. One of: `atk`, `def`, `name` (Name (A-Z)), `level` (Level / Rank), `id` (Passcode), `new` (Recently added first), `relevance` (Best match).
- Language (`language`, text): Optional. Return card names and text in this language. Leave blank for English. Card images are only stored in English. One of: `fr` (French), `de` (German), `it` (Italian), `pt` (Portuguese).
- Include extra details (`include_extra_details`, true/false): Optional. Also return each card's release dates, Konami ID, the formats it is legal in, its Master Duel rarity and its view and vote counts. Off by default. Default: `false`.
- Cards per page (`limit`, number): Optional. How many cards to return, up to 1000. Defaults to 50. From 1 to 1000. Default: `50`.
- Skip (`offset`, number): Optional. How many cards to skip before returning results. Use the result's next_offset to walk through a long list. At least 0. Default: `0`.

**Outputs**

- `cards` (list): The staple cards.
- `count` (number): How many cards this page returned.
- `has_more` (true/false): Whether more cards are left after this page.
- `next_offset` (number): The offset that reads the next page. Null on the last page.
- `offset` (number): How many cards were skipped to reach this page.
- `total_count` (number): How many cards matched in total.

**Example output**

```json
{
  "cards": [
    {
      "archetype": null,
      "atk": 2100,
      "attribute": "WIND",
      "banlist": {
        "goat": "Unlimited",
        "ocg": "Unlimited",
        "tcg": "Unlimited"
      },
      "card_sets": [
        {
          "set_code": "MACR-EN081",
          "set_name": "Maximum Crisis",
          "set_price": 4.32,
          "set_rarity": "Secret Rare",
          "set_rarity_code": "(ScR)"
        }
      ],
      "def": 2000,
      "description": "2 Level 4 monsters\nOnce per turn (Quick Effect): You can detach 1 material from this card, then target 1 Spell/Trap on the field; destroy it.",
      "extra_details": {
        "beta_name": null,
        "downvotes": 5,
        "formats": [
          "Duel Links",
          "TCG",
          "OCG",
          "Master Duel"
        ],
        "genesys_ocg_points": null,
        "genesys_points": null,
        "has_effect": true,
        "konami_id": 13019,
        "master_duel_rarity": "Ultra Rare",
        "ocg_release_date": "2017-09-09",
        "tcg_release_date": "2017-05-04",
        "treated_as": null,
        "upvotes": 24,
        "views": 1843939,
        "views_this_week": 3213
      },
      "frame_type": "xyz",
      "human_readable_card_type": "Xyz Effect Monster",
      "id": 6983839,
      "image_url": "https://images.ygoprodeck.com/images/cards/6983839.jpg",
      "image_url_cropped": "https://images.ygoprodeck.com/images/cards_cropped/6983839.jpg",
      "image_url_small": "https://images.ygoprodeck.com/images/cards_small/6983839.jpg",
      "images": [
        {
          "id": 6983839,
          "image_url": "https://images.ygoprodeck.com/images/cards/6983839.jpg",
          "image_url_cropped": "https://images.ygoprodeck.com/images/cards_cropped/6983839.jpg",
          "image_url_small": "https://images.ygoprodeck.com/images/cards_small/6983839.jpg"
        }
      ],
      "level": 4,
      "link_markers": [],
      "link_value": null,
      "monster_description": null,
      "name": "Tornado Dragon",
      "pendulum_description": null,
      "prices": {
        "amazon_price": 1.39,
        "cardmarket_price": 0.06,
        "coolstuffinc_price": 0.25,
        "ebay_price": 0.99,
        "tcgplayer_price": 0.07
      },
      "race": "Wyrm",
      "scale": null,
      "type": "XYZ Monster",
      "type_line": [
        "Wyrm",
        "Xyz",
        "Effect"
      ],
      "ygoprodeck_url": "https://ygoprodeck.com/card/tornado-dragon-8538"
    }
  ],
  "count": 1,
  "has_more": true,
  "next_offset": 1,
  "offset": 0,
  "total_count": 137
}
```

### Search cards

Search every Yu-Gi-Oh! card by name, card type, monster type, attribute, ATK, DEF, Level, Link rating, Pendulum Scale, set, archetype, ban list, format or release date. Each card comes back with its text, artwork, printings and current prices. No API key required.

**Inputs**

- Name contains (`name_contains`, text): Optional. Only cards whose name contains this text, for example "magician".
- Card type (`card_types`, list): Optional. Only cards of these types. All types are included when nothing is chosen. One or more of: `Normal Monster`, `Effect Monster`, `Flip Effect Monster`, `Flip Tuner Effect Monster`, `Gemini Monster`, `Normal Tuner Monster`, `Ritual Monster`, `Ritual Effect Monster`, `Spirit Monster`, `Toon Monster`, and 19 more.
- Monster / Spell / Trap type (`races`, list): Optional. The card's Type: Spellcaster, Warrior and the like for monsters, or Equip, Field and Counter for Spells and Traps. One or more of: `Aqua` (Aqua (Monster)), `Beast` (Beast (Monster)), `Beast-Warrior` (Beast-Warrior (Monster)), `Creator God` (Creator God (Monster)), `Cyberse` (Cyberse (Monster)), `Dinosaur` (Dinosaur (Monster)), `Divine-Beast` (Divine-Beast (Monster)), `Dragon` (Dragon (Monster)), `Fairy` (Fairy (Monster)), `Fiend` (Fiend (Monster)), and 23 more.
- Attribute (`attributes`, list): Optional. Only monsters of these attributes. One or more of: `DARK`, `DIVINE`, `EARTH`, `FIRE`, `LIGHT`, `WATER`, `WIND`.
- ATK (`atk`, number): Optional. Filter on ATK. Set the comparison beside it to search a range instead of an exact value. At least 0.
- ATK comparison (`atk_comparison`, text): Optional. How to compare the ATK value. Defaults to an exact match. One of: `eq` (Exactly), `gte` (At least), `lte` (At most), `gt` (More than), `lt` (Less than). Default: `eq`.
- DEF (`defense`, number): Optional. Filter on DEF. Set the comparison beside it to search a range instead of an exact value. At least 0.
- DEF comparison (`defense_comparison`, text): Optional. How to compare the DEF value. Defaults to an exact match. One of: `eq` (Exactly), `gte` (At least), `lte` (At most), `gt` (More than), `lt` (Less than). Default: `eq`.
- Level / Rank (`level`, number): Optional. Filter on Level, or Rank for Xyz monsters. Set the comparison beside it to search a range. From 0 to 13.
- Level / Rank comparison (`level_comparison`, text): Optional. How to compare the Level or Rank. Defaults to an exact match. One of: `eq` (Exactly), `gte` (At least), `lte` (At most), `gt` (More than), `lt` (Less than). Default: `eq`.
- Link rating (`link_value`, number): Optional. Only Link Monsters with this Link rating. From 1 to 6.
- Link arrows (`link_markers`, list): Optional. Only Link Monsters that point in every one of these directions. One or more of: `Top-Left`, `Top`, `Top-Right`, `Left`, `Right`, `Bottom-Left`, `Bottom`, `Bottom-Right`.
- Pendulum Scale (`pendulum_scale`, number): Optional. Only Pendulum cards with this Scale. From 0 to 13.
- Card set (`card_set`, text): Optional. Only cards printed in this set. Choose one from the list: the set name has to match exactly.
- Archetype (`archetype`, text): Optional. Only cards in this archetype. Choose one from the list: the name has to match exactly.
- Ban list (`banlist`, text): Optional. Only cards restricted on this ban list (Forbidden, Limited or Semi-Limited). One of: `tcg`, `ocg`, `goat`.
- Format (`card_format`, text): Optional. Only cards playable in this format. Leave blank for every card. The ban list statuses returned are always the TCG, OCG and GOAT ones, whichever format is picked. One of: `tcg`, `ocg`, `master duel`, `duel links`, `speed duel`, `goat`, `ocg goat`, `edison`, `genesys`, `genesys ocg`, `common charity`.
- Staples only (`staples_only`, true/false): Optional. Only the cards YGOPRODeck marks as staples (the ones that fit in almost any deck). Off by default. Default: `false`.
- Has an effect (`has_effect`, text): Optional. Narrow to cards that do or don't have a real effect. Leave blank for both. One of: `true` (Only cards with an effect), `false` (Only cards without an effect).
- Released on or after (`released_from`, date): Optional. Only cards released on or after this date.
- Released on or before (`released_to`, date): Optional. Only cards released on or before this date.
- Release dates to use (`date_region`, text): Optional. Which region's release dates the date filters compare against. Defaults to TCG. One of: `tcg` (TCG release dates), `ocg` (OCG release dates). Default: `tcg`.
- Sort by (`sort_by`, text): Optional. How to order the cards. Leave blank for the database's own order. One of: `atk`, `def`, `name` (Name (A-Z)), `level` (Level / Rank), `id` (Passcode), `new` (Recently added first), `relevance` (Best match).
- Language (`language`, text): Optional. Return card names and text in this language. Leave blank for English. Card images are only stored in English. One of: `fr` (French), `de` (German), `it` (Italian), `pt` (Portuguese).
- Include extra details (`include_extra_details`, true/false): Optional. Also return each card's release dates, Konami ID, the formats it is legal in, its Master Duel rarity and its view and vote counts. Off by default. Default: `false`.
- Cards per page (`limit`, number): Optional. How many cards to return, up to 1000. Defaults to 50. From 1 to 1000. Default: `50`.
- Skip (`offset`, number): Optional. How many cards to skip before returning results. Use the result's next_offset to walk through a long list. At least 0. Default: `0`.

**Outputs**

- `cards` (list): The matching cards, in the requested order.
- `count` (number): How many cards this page returned.
- `has_more` (true/false): Whether more cards are left after this page.
- `next_offset` (number): The offset that reads the next page. Null on the last page.
- `offset` (number): How many cards were skipped to reach this page.
- `total_count` (number): How many cards matched in total.

**Example output**

```json
{
  "cards": [
    {
      "archetype": null,
      "atk": 2100,
      "attribute": "WIND",
      "banlist": {
        "goat": "Unlimited",
        "ocg": "Unlimited",
        "tcg": "Unlimited"
      },
      "card_sets": [
        {
          "set_code": "MACR-EN081",
          "set_name": "Maximum Crisis",
          "set_price": 4.32,
          "set_rarity": "Secret Rare",
          "set_rarity_code": "(ScR)"
        }
      ],
      "def": 2000,
      "description": "2 Level 4 monsters\nOnce per turn (Quick Effect): You can detach 1 material from this card, then target 1 Spell/Trap on the field; destroy it.",
      "extra_details": {
        "beta_name": null,
        "downvotes": 5,
        "formats": [
          "Duel Links",
          "TCG",
          "OCG",
          "Master Duel"
        ],
        "genesys_ocg_points": null,
        "genesys_points": null,
        "has_effect": true,
        "konami_id": 13019,
        "master_duel_rarity": "Ultra Rare",
        "ocg_release_date": "2017-09-09",
        "tcg_release_date": "2017-05-04",
        "treated_as": null,
        "upvotes": 24,
        "views": 1843939,
        "views_this_week": 3213
      },
      "frame_type": "xyz",
      "human_readable_card_type": "Xyz Effect Monster",
      "id": 6983839,
      "image_url": "https://images.ygoprodeck.com/images/cards/6983839.jpg",
      "image_url_cropped": "https://images.ygoprodeck.com/images/cards_cropped/6983839.jpg",
      "image_url_small": "https://images.ygoprodeck.com/images/cards_small/6983839.jpg",
      "images": [
        {
          "id": 6983839,
          "image_url": "https://images.ygoprodeck.com/images/cards/6983839.jpg",
          "image_url_cropped": "https://images.ygoprodeck.com/images/cards_cropped/6983839.jpg",
          "image_url_small": "https://images.ygoprodeck.com/images/cards_small/6983839.jpg"
        }
      ],
      "level": 4,
      "link_markers": [],
      "link_value": null,
      "monster_description": null,
      "name": "Tornado Dragon",
      "pendulum_description": null,
      "prices": {
        "amazon_price": 1.39,
        "cardmarket_price": 0.06,
        "coolstuffinc_price": 0.25,
        "ebay_price": 0.99,
        "tcgplayer_price": 0.07
      },
      "race": "Wyrm",
      "scale": null,
      "type": "XYZ Monster",
      "type_line": [
        "Wyrm",
        "Xyz",
        "Effect"
      ],
      "ygoprodeck_url": "https://ygoprodeck.com/card/tornado-dragon-8538"
    }
  ],
  "count": 1,
  "has_more": true,
  "next_offset": 1,
  "offset": 0,
  "total_count": 137
}
```
