# Digimon TCG API

> Look up Digimon Trading Card Game cards on digimoncard.io: search by name, rules text, colour, card type, attribute, Digi-Type, pack or digivolution cost, list what is in any booster set, and read each card's costs, DP, effects, artwork link and TCGplayer id. Covers all three Digimon card games. No account or API key required.

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

## Actions

### Find cards by name

Find every card whose name contains the text given: "agumon" brings back Agumon and every one of its dozens of printings and forms. The way to turn a name a person typed into card numbers. No API key required.

**Inputs**

- Name (`name`, text, required): The name, or part of one, to search for. For example "greymon" or "omnimon".
- Colour (`color`, text): Optional. Only cards of this colour. One of: `Black`, `Blue`, `Colorless`, `Green`, `Purple`, `Red`, `White`, `Yellow`.
- Card type (`card_type`, text): Optional. Only cards of this type: a Digimon, an Option, a Tamer or a Digi-Egg. One of: `Digimon`, `Option`, `Tamer`, `Digi-Egg`.
- Game (`series`, text): Optional. Which of the three Digimon card games to search. Leave blank for all of them; the 2020 Digimon Card Game is the one in print. One of: `Digimon Card Game` (Digimon Card Game (2020-)), `Digimon Digi-Battle Card Game` (Digimon Digi-Battle Card Game (1999-2001)), `Digimon Collectible Card Game` (Digimon Collectible Card Game (1998-2000)).
- Sort by (`sort_by`, text): Optional. How to order the cards. Leave blank for the database's own order. One of: `name`, `power` (DP (power)), `code` (Card number), `color` (Colour), `random`.
- Sort direction (`sort_direction`, text): Optional. Which way to order the cards. Only applies alongside Sort by. One of: `asc` (Ascending), `desc` (Descending).
- 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; paging costs no extra request. At least 0. Default: `0`.

**Outputs**

- `cards` (list): The cards whose name matched.
- `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": [
    {
      "alt_effect": null,
      "artist": null,
      "attribute": "Variable",
      "card_number": "BT4-016",
      "card_page_url": "https://digimoncard.io/card/aldamon-bt4-016",
      "color": "Red",
      "color2": null,
      "colors": [
        "Red"
      ],
      "date_added": "2024-05-27 15:14:30",
      "digi_type": "Wizard",
      "digi_type2": null,
      "digi_types": [
        "Wizard"
      ],
      "dp": 7000,
      "evolution_color": "Red",
      "evolution_cost": 3,
      "evolution_level": 4,
      "form": "Hybrid",
      "image_url": "https://images.digimoncard.io/images/cards/BT4-016.jpg",
      "level": 5,
      "main_effect": "<Security Attack +1> (This Digimon checks 1 additional security card).\n[Your Turn] While this Digimon's digivolution cards include a Digimon card with the [Hybrid] trait or a red Tamer card, it gets +4000 DP.",
      "name": "Aldamon",
      "play_cost": 8,
      "pretty_url": "aldamon-bt4-016",
      "rarity": "sr",
      "series": "Digimon Card Game",
      "source_effect": null,
      "stage": "Hybrid",
      "tcgplayer_id": 238186,
      "tcgplayer_name": "Aldamon",
      "type": "Digimon",
      "xros_requirement": null
    }
  ],
  "count": 1,
  "has_more": true,
  "next_offset": 1,
  "offset": 0,
  "total_count": 12
}
```

### Get a card

Look one card up by the number printed on it, such as BT4-016, chosen from a dropdown of every card. Returns the full record: costs, DP, both effects, artwork link and TCGplayer id. No API key required.

**Inputs**

- Card (`card_number`, text, required): The card to look up, chosen from the list of every card digimoncard.io holds. A number typed by hand works too, for example BT4-016.
- Game (`series`, text): Optional. Which of the three Digimon card games to search. Leave blank for all of them; the 2020 Digimon Card Game is the one in print. One of: `Digimon Card Game` (Digimon Card Game (2020-)), `Digimon Digi-Battle Card Game` (Digimon Digi-Battle Card Game (1999-2001)), `Digimon Collectible Card Game` (Digimon Collectible Card Game (1998-2000)).

**Outputs**

- `card` (object): The card.
- `count` (number): How many cards matched the number in total.
- `other_matches` (list): Any other cards whose number also matched, for a number that is a prefix of others. Usually empty.

**Example output**

```json
{
  "card": {
    "alt_effect": null,
    "artist": null,
    "attribute": "Variable",
    "card_number": "BT4-016",
    "card_page_url": "https://digimoncard.io/card/aldamon-bt4-016",
    "color": "Red",
    "color2": null,
    "colors": [
      "Red"
    ],
    "date_added": "2024-05-27 15:14:30",
    "digi_type": "Wizard",
    "digi_type2": null,
    "digi_types": [
      "Wizard"
    ],
    "dp": 7000,
    "evolution_color": "Red",
    "evolution_cost": 3,
    "evolution_level": 4,
    "form": "Hybrid",
    "image_url": "https://images.digimoncard.io/images/cards/BT4-016.jpg",
    "level": 5,
    "main_effect": "<Security Attack +1> (This Digimon checks 1 additional security card).\n[Your Turn] While this Digimon's digivolution cards include a Digimon card with the [Hybrid] trait or a red Tamer card, it gets +4000 DP.",
    "name": "Aldamon",
    "play_cost": 8,
    "pretty_url": "aldamon-bt4-016",
    "rarity": "sr",
    "series": "Digimon Card Game",
    "source_effect": null,
    "stage": "Hybrid",
    "tcgplayer_id": 238186,
    "tcgplayer_name": "Aldamon",
    "type": "Digimon",
    "xros_requirement": null
  },
  "count": 1,
  "other_matches": []
}
```

### Get a random card

Draw one card at random, with its costs, DP, effects and artwork link. Good for a card-of-the-day post or a quiz. No API key required.

**Inputs**

- Game (`series`, text): Optional. Which Digimon card game to draw from. Defaults to the 2020 Digimon Card Game. One of: `Digimon Card Game` (Digimon Card Game (2020-)), `Digimon Digi-Battle Card Game` (Digimon Digi-Battle Card Game (1999-2001)), `Digimon Collectible Card Game` (Digimon Collectible Card Game (1998-2000)). Default: `Digimon Card Game`.

**Outputs**

- `card` (object): The card.
- `series` (text): The game the card was drawn from.

**Example output**

```json
{
  "card": {
    "alt_effect": null,
    "artist": null,
    "attribute": "Variable",
    "card_number": "BT4-016",
    "card_page_url": "https://digimoncard.io/card/aldamon-bt4-016",
    "color": "Red",
    "color2": null,
    "colors": [
      "Red"
    ],
    "date_added": "2024-05-27 15:14:30",
    "digi_type": "Wizard",
    "digi_type2": null,
    "digi_types": [
      "Wizard"
    ],
    "dp": 7000,
    "evolution_color": "Red",
    "evolution_cost": 3,
    "evolution_level": 4,
    "form": "Hybrid",
    "image_url": "https://images.digimoncard.io/images/cards/BT4-016.jpg",
    "level": 5,
    "main_effect": "<Security Attack +1> (This Digimon checks 1 additional security card).\n[Your Turn] While this Digimon's digivolution cards include a Digimon card with the [Hybrid] trait or a red Tamer card, it gets +4000 DP.",
    "name": "Aldamon",
    "play_cost": 8,
    "pretty_url": "aldamon-bt4-016",
    "rarity": "sr",
    "series": "Digimon Card Game",
    "source_effect": null,
    "stage": "Hybrid",
    "tcgplayer_id": 238186,
    "tcgplayer_name": "Aldamon",
    "type": "Digimon",
    "xros_requirement": null
  },
  "series": "Digimon Card Game"
}
```

### List all cards

List every card's name and number in one go. This is the light read of the whole database: a name and a number per card rather than the full record, so it is the right first step before looking a few cards up in detail. No API key required.

**Inputs**

- Game (`series`, text): Optional. Which of the three Digimon card games to search. Leave blank for all of them; the 2020 Digimon Card Game is the one in print. One of: `Digimon Card Game` (Digimon Card Game (2020-)), `Digimon Digi-Battle Card Game` (Digimon Digi-Battle Card Game (1999-2001)), `Digimon Collectible Card Game` (Digimon Collectible Card Game (1998-2000)).
- Name or number contains (`name_contains`, text): Optional. Only cards whose name or number contains this text, for example "agumon" or "BT4-". Leave blank for every card.
- Sort by (`sort_by`, text): Optional. This endpoint can only order by name. Leave blank for the database's own order. One of: `name`.
- Sort direction (`sort_direction`, text): Optional. Which way to order the cards. Only applies alongside Sort by. One of: `asc` (Ascending), `desc` (Descending).
- 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; paging costs no extra request. At least 0. Default: `0`.

**Outputs**

- `cards` (list): Every card's name and number.
- `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": [
    {
      "card_number": "BT1-001",
      "name": "Yokomon"
    },
    {
      "card_number": "BT1-002",
      "name": "Bebydomon"
    },
    {
      "card_number": "BT1-003",
      "name": "Upamon"
    }
  ],
  "count": 3,
  "has_more": true,
  "next_offset": 3,
  "offset": 0,
  "total_count": 1584
}
```

### List cards by digivolution

List cards by what it costs to digivolve into them and what colour they digivolve from. Digivolution is how a Digimon deck curves out, so this is how to find the cheap red level 4 a line is missing. No API key required.

**Inputs**

- Digivolution cost (`evolution_cost`, number): Optional. Only cards that cost this much memory to digivolve into. Set this, the colour, or both. At least 0.
- Digivolves from colour (`evolution_color`, text): Optional. Only cards that digivolve from a Digimon of this colour. Set this, the cost, or both. One of: `Black`, `Blue`, `Colorless`, `Green`, `Purple`, `Red`, `White`, `Yellow`.
- Colour (`color`, text): Optional. Only cards of this colour. One of: `Black`, `Blue`, `Colorless`, `Green`, `Purple`, `Red`, `White`, `Yellow`.
- Game (`series`, text): Optional. Which of the three Digimon card games to search. Leave blank for all of them; the 2020 Digimon Card Game is the one in print. One of: `Digimon Card Game` (Digimon Card Game (2020-)), `Digimon Digi-Battle Card Game` (Digimon Digi-Battle Card Game (1999-2001)), `Digimon Collectible Card Game` (Digimon Collectible Card Game (1998-2000)).
- Sort by (`sort_by`, text): Optional. How to order the cards. Leave blank for the database's own order. One of: `name`, `power` (DP (power)), `code` (Card number), `color` (Colour), `random`.
- Sort direction (`sort_direction`, text): Optional. Which way to order the cards. Only applies alongside Sort by. One of: `asc` (Ascending), `desc` (Descending).
- 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; paging costs no extra request. At least 0. Default: `0`.

**Outputs**

- `cards` (list): The cards matching the digivolution filters.
- `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": [
    {
      "alt_effect": null,
      "artist": null,
      "attribute": "Variable",
      "card_number": "BT4-016",
      "card_page_url": "https://digimoncard.io/card/aldamon-bt4-016",
      "color": "Red",
      "color2": null,
      "colors": [
        "Red"
      ],
      "date_added": "2024-05-27 15:14:30",
      "digi_type": "Wizard",
      "digi_type2": null,
      "digi_types": [
        "Wizard"
      ],
      "dp": 7000,
      "evolution_color": "Red",
      "evolution_cost": 3,
      "evolution_level": 4,
      "form": "Hybrid",
      "image_url": "https://images.digimoncard.io/images/cards/BT4-016.jpg",
      "level": 5,
      "main_effect": "<Security Attack +1> (This Digimon checks 1 additional security card).\n[Your Turn] While this Digimon's digivolution cards include a Digimon card with the [Hybrid] trait or a red Tamer card, it gets +4000 DP.",
      "name": "Aldamon",
      "play_cost": 8,
      "pretty_url": "aldamon-bt4-016",
      "rarity": "sr",
      "series": "Digimon Card Game",
      "source_effect": null,
      "stage": "Hybrid",
      "tcgplayer_id": 238186,
      "tcgplayer_name": "Aldamon",
      "type": "Digimon",
      "xros_requirement": null
    }
  ],
  "count": 1,
  "has_more": true,
  "next_offset": 1,
  "offset": 0,
  "total_count": 12
}
```

### List cards in a pack

List every card printed in one booster set or starter deck, named the way digimoncard.io stores it ("BT-04: Booster Great Legend"). Use it to check what is in a box or to pull a whole set in one step. No API key required.

**Inputs**

- Pack (`pack`, text, required): The pack to list. The name has to match the one digimoncard.io stores, including the set code and the colon: "BT-04: Booster Great Legend".
- Colour (`color`, text): Optional. Only cards of this colour. One of: `Black`, `Blue`, `Colorless`, `Green`, `Purple`, `Red`, `White`, `Yellow`.
- Card type (`card_type`, text): Optional. Only cards of this type: a Digimon, an Option, a Tamer or a Digi-Egg. One of: `Digimon`, `Option`, `Tamer`, `Digi-Egg`.
- Sort by (`sort_by`, text): Optional. How to order the cards. Leave blank for the database's own order. One of: `name`, `power` (DP (power)), `code` (Card number), `color` (Colour), `random`.
- Sort direction (`sort_direction`, text): Optional. Which way to order the cards. Only applies alongside Sort by. One of: `asc` (Ascending), `desc` (Descending).
- 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; paging costs no extra request. At least 0. Default: `0`.

**Outputs**

- `cards` (list): The cards printed in the pack.
- `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": [
    {
      "alt_effect": null,
      "artist": null,
      "attribute": "Variable",
      "card_number": "BT4-016",
      "card_page_url": "https://digimoncard.io/card/aldamon-bt4-016",
      "color": "Red",
      "color2": null,
      "colors": [
        "Red"
      ],
      "date_added": "2024-05-27 15:14:30",
      "digi_type": "Wizard",
      "digi_type2": null,
      "digi_types": [
        "Wizard"
      ],
      "dp": 7000,
      "evolution_color": "Red",
      "evolution_cost": 3,
      "evolution_level": 4,
      "form": "Hybrid",
      "image_url": "https://images.digimoncard.io/images/cards/BT4-016.jpg",
      "level": 5,
      "main_effect": "<Security Attack +1> (This Digimon checks 1 additional security card).\n[Your Turn] While this Digimon's digivolution cards include a Digimon card with the [Hybrid] trait or a red Tamer card, it gets +4000 DP.",
      "name": "Aldamon",
      "play_cost": 8,
      "pretty_url": "aldamon-bt4-016",
      "rarity": "sr",
      "series": "Digimon Card Game",
      "source_effect": null,
      "stage": "Hybrid",
      "tcgplayer_id": 238186,
      "tcgplayer_name": "Aldamon",
      "type": "Digimon",
      "xros_requirement": null
    }
  ],
  "count": 1,
  "has_more": true,
  "next_offset": 1,
  "offset": 0,
  "total_count": 12
}
```

### List cards of a colour

List every card of one colour. Colour is what a Digimon deck is built around, so this is the first step in assembling one, narrow it to Tamers or Options to fill a slot. No API key required.

**Inputs**

- Colour (`color`, text, required): The colour to list. One of: `Black`, `Blue`, `Colorless`, `Green`, `Purple`, `Red`, `White`, `Yellow`.
- Card type (`card_type`, text): Optional. Only cards of this type: a Digimon, an Option, a Tamer or a Digi-Egg. One of: `Digimon`, `Option`, `Tamer`, `Digi-Egg`.
- Game (`series`, text): Optional. Which of the three Digimon card games to search. Leave blank for all of them; the 2020 Digimon Card Game is the one in print. One of: `Digimon Card Game` (Digimon Card Game (2020-)), `Digimon Digi-Battle Card Game` (Digimon Digi-Battle Card Game (1999-2001)), `Digimon Collectible Card Game` (Digimon Collectible Card Game (1998-2000)).
- Sort by (`sort_by`, text): Optional. How to order the cards. Leave blank for the database's own order. One of: `name`, `power` (DP (power)), `code` (Card number), `color` (Colour), `random`.
- Sort direction (`sort_direction`, text): Optional. Which way to order the cards. Only applies alongside Sort by. One of: `asc` (Ascending), `desc` (Descending).
- 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; paging costs no extra request. At least 0. Default: `0`.

**Outputs**

- `cards` (list): The cards of that colour.
- `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": [
    {
      "alt_effect": null,
      "artist": null,
      "attribute": "Variable",
      "card_number": "BT4-016",
      "card_page_url": "https://digimoncard.io/card/aldamon-bt4-016",
      "color": "Red",
      "color2": null,
      "colors": [
        "Red"
      ],
      "date_added": "2024-05-27 15:14:30",
      "digi_type": "Wizard",
      "digi_type2": null,
      "digi_types": [
        "Wizard"
      ],
      "dp": 7000,
      "evolution_color": "Red",
      "evolution_cost": 3,
      "evolution_level": 4,
      "form": "Hybrid",
      "image_url": "https://images.digimoncard.io/images/cards/BT4-016.jpg",
      "level": 5,
      "main_effect": "<Security Attack +1> (This Digimon checks 1 additional security card).\n[Your Turn] While this Digimon's digivolution cards include a Digimon card with the [Hybrid] trait or a red Tamer card, it gets +4000 DP.",
      "name": "Aldamon",
      "play_cost": 8,
      "pretty_url": "aldamon-bt4-016",
      "rarity": "sr",
      "series": "Digimon Card Game",
      "source_effect": null,
      "stage": "Hybrid",
      "tcgplayer_id": 238186,
      "tcgplayer_name": "Aldamon",
      "type": "Digimon",
      "xros_requirement": null
    }
  ],
  "count": 1,
  "has_more": true,
  "next_offset": 1,
  "offset": 0,
  "total_count": 12
}
```

### List cards of a Digi-Type

List every Digimon sharing one Digi-Type: the trait line under the artwork, such as Dragon, Wizard or Machine. Traits are what tribal decks are built on, so this is the quickest way to pull a theme. No API key required.

**Inputs**

- Digi-Type (`digi_type`, text, required): The Digi-Type to list, spelled as it is on the card.
- Colour (`color`, text): Optional. Only cards of this colour. One of: `Black`, `Blue`, `Colorless`, `Green`, `Purple`, `Red`, `White`, `Yellow`.
- Game (`series`, text): Optional. Which of the three Digimon card games to search. Leave blank for all of them; the 2020 Digimon Card Game is the one in print. One of: `Digimon Card Game` (Digimon Card Game (2020-)), `Digimon Digi-Battle Card Game` (Digimon Digi-Battle Card Game (1999-2001)), `Digimon Collectible Card Game` (Digimon Collectible Card Game (1998-2000)).
- Sort by (`sort_by`, text): Optional. How to order the cards. Leave blank for the database's own order. One of: `name`, `power` (DP (power)), `code` (Card number), `color` (Colour), `random`.
- Sort direction (`sort_direction`, text): Optional. Which way to order the cards. Only applies alongside Sort by. One of: `asc` (Ascending), `desc` (Descending).
- 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; paging costs no extra request. At least 0. Default: `0`.

**Outputs**

- `cards` (list): The cards with that Digi-Type.
- `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": [
    {
      "alt_effect": null,
      "artist": null,
      "attribute": "Variable",
      "card_number": "BT4-016",
      "card_page_url": "https://digimoncard.io/card/aldamon-bt4-016",
      "color": "Red",
      "color2": null,
      "colors": [
        "Red"
      ],
      "date_added": "2024-05-27 15:14:30",
      "digi_type": "Wizard",
      "digi_type2": null,
      "digi_types": [
        "Wizard"
      ],
      "dp": 7000,
      "evolution_color": "Red",
      "evolution_cost": 3,
      "evolution_level": 4,
      "form": "Hybrid",
      "image_url": "https://images.digimoncard.io/images/cards/BT4-016.jpg",
      "level": 5,
      "main_effect": "<Security Attack +1> (This Digimon checks 1 additional security card).\n[Your Turn] While this Digimon's digivolution cards include a Digimon card with the [Hybrid] trait or a red Tamer card, it gets +4000 DP.",
      "name": "Aldamon",
      "play_cost": 8,
      "pretty_url": "aldamon-bt4-016",
      "rarity": "sr",
      "series": "Digimon Card Game",
      "source_effect": null,
      "stage": "Hybrid",
      "tcgplayer_id": 238186,
      "tcgplayer_name": "Aldamon",
      "type": "Digimon",
      "xros_requirement": null
    }
  ],
  "count": 1,
  "has_more": true,
  "next_offset": 1,
  "offset": 0,
  "total_count": 12
}
```

### List cards of a type

List every card of one card type: the Digimon that battle, the Options played for an effect, the Tamers that sit in play or the Digi-Eggs that start underneath. Use it to fill one part of a deck. No API key required.

**Inputs**

- Card type (`card_type`, text, required): The card type to list. One of: `Digimon`, `Option`, `Tamer`, `Digi-Egg`.
- Colour (`color`, text): Optional. Only cards of this colour. One of: `Black`, `Blue`, `Colorless`, `Green`, `Purple`, `Red`, `White`, `Yellow`.
- Game (`series`, text): Optional. Which of the three Digimon card games to search. Leave blank for all of them; the 2020 Digimon Card Game is the one in print. One of: `Digimon Card Game` (Digimon Card Game (2020-)), `Digimon Digi-Battle Card Game` (Digimon Digi-Battle Card Game (1999-2001)), `Digimon Collectible Card Game` (Digimon Collectible Card Game (1998-2000)).
- Sort by (`sort_by`, text): Optional. How to order the cards. Leave blank for the database's own order. One of: `name`, `power` (DP (power)), `code` (Card number), `color` (Colour), `random`.
- Sort direction (`sort_direction`, text): Optional. Which way to order the cards. Only applies alongside Sort by. One of: `asc` (Ascending), `desc` (Descending).
- 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; paging costs no extra request. At least 0. Default: `0`.

**Outputs**

- `cards` (list): The cards of that type.
- `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": [
    {
      "alt_effect": null,
      "artist": null,
      "attribute": "Variable",
      "card_number": "BT4-016",
      "card_page_url": "https://digimoncard.io/card/aldamon-bt4-016",
      "color": "Red",
      "color2": null,
      "colors": [
        "Red"
      ],
      "date_added": "2024-05-27 15:14:30",
      "digi_type": "Wizard",
      "digi_type2": null,
      "digi_types": [
        "Wizard"
      ],
      "dp": 7000,
      "evolution_color": "Red",
      "evolution_cost": 3,
      "evolution_level": 4,
      "form": "Hybrid",
      "image_url": "https://images.digimoncard.io/images/cards/BT4-016.jpg",
      "level": 5,
      "main_effect": "<Security Attack +1> (This Digimon checks 1 additional security card).\n[Your Turn] While this Digimon's digivolution cards include a Digimon card with the [Hybrid] trait or a red Tamer card, it gets +4000 DP.",
      "name": "Aldamon",
      "play_cost": 8,
      "pretty_url": "aldamon-bt4-016",
      "rarity": "sr",
      "series": "Digimon Card Game",
      "source_effect": null,
      "stage": "Hybrid",
      "tcgplayer_id": 238186,
      "tcgplayer_name": "Aldamon",
      "type": "Digimon",
      "xros_requirement": null
    }
  ],
  "count": 1,
  "has_more": true,
  "next_offset": 1,
  "offset": 0,
  "total_count": 12
}
```

### List cards of an attribute

List every Digimon of one attribute: Vaccine, Virus, Data, Free or Variable. Several cards care what attribute they are facing, so this answers what a counter-card can actually hit. No API key required.

**Inputs**

- Attribute (`attribute`, text, required): The attribute to list, spelled as it is on the card.
- Colour (`color`, text): Optional. Only cards of this colour. One of: `Black`, `Blue`, `Colorless`, `Green`, `Purple`, `Red`, `White`, `Yellow`.
- Game (`series`, text): Optional. Which of the three Digimon card games to search. Leave blank for all of them; the 2020 Digimon Card Game is the one in print. One of: `Digimon Card Game` (Digimon Card Game (2020-)), `Digimon Digi-Battle Card Game` (Digimon Digi-Battle Card Game (1999-2001)), `Digimon Collectible Card Game` (Digimon Collectible Card Game (1998-2000)).
- Sort by (`sort_by`, text): Optional. How to order the cards. Leave blank for the database's own order. One of: `name`, `power` (DP (power)), `code` (Card number), `color` (Colour), `random`.
- Sort direction (`sort_direction`, text): Optional. Which way to order the cards. Only applies alongside Sort by. One of: `asc` (Ascending), `desc` (Descending).
- 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; paging costs no extra request. At least 0. Default: `0`.

**Outputs**

- `cards` (list): The cards with that attribute.
- `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": [
    {
      "alt_effect": null,
      "artist": null,
      "attribute": "Variable",
      "card_number": "BT4-016",
      "card_page_url": "https://digimoncard.io/card/aldamon-bt4-016",
      "color": "Red",
      "color2": null,
      "colors": [
        "Red"
      ],
      "date_added": "2024-05-27 15:14:30",
      "digi_type": "Wizard",
      "digi_type2": null,
      "digi_types": [
        "Wizard"
      ],
      "dp": 7000,
      "evolution_color": "Red",
      "evolution_cost": 3,
      "evolution_level": 4,
      "form": "Hybrid",
      "image_url": "https://images.digimoncard.io/images/cards/BT4-016.jpg",
      "level": 5,
      "main_effect": "<Security Attack +1> (This Digimon checks 1 additional security card).\n[Your Turn] While this Digimon's digivolution cards include a Digimon card with the [Hybrid] trait or a red Tamer card, it gets +4000 DP.",
      "name": "Aldamon",
      "play_cost": 8,
      "pretty_url": "aldamon-bt4-016",
      "rarity": "sr",
      "series": "Digimon Card Game",
      "source_effect": null,
      "stage": "Hybrid",
      "tcgplayer_id": 238186,
      "tcgplayer_name": "Aldamon",
      "type": "Digimon",
      "xros_requirement": null
    }
  ],
  "count": 1,
  "has_more": true,
  "next_offset": 1,
  "offset": 0,
  "total_count": 12
}
```

### Search cards

Search every Digimon card by name, rules text, colour, card type, attribute, Digi-Type, pack, card number, game or digivolution cost. Each card comes back with its costs, DP, effects, artwork link and TCGplayer id. No API key required.

**Inputs**

- Name contains (`name_contains`, text): Optional. Only cards whose name contains this text, for example "agumon".
- Rules text contains (`effect_contains`, text): Optional. Only cards whose rules text contains this text, for example "draw 1 card". Searches both the main effect and the inherited effect.
- Colour (`color`, text): Optional. Only cards of this colour. One of: `Black`, `Blue`, `Colorless`, `Green`, `Purple`, `Red`, `White`, `Yellow`.
- Card type (`card_type`, text): Optional. Only cards of this type: a Digimon, an Option, a Tamer or a Digi-Egg. One of: `Digimon`, `Option`, `Tamer`, `Digi-Egg`.
- Attribute (`attribute`, text): Optional. Only Digimon of this attribute, such as Vaccine, Virus, Data, Free or Variable.
- Digi-Type (`digi_type`, text): Optional. Only Digimon with this Digi-Type: the trait line under the artwork, such as Dragon, Wizard or Machine.
- Card number (`card_number`, text): Optional. Only cards whose number matches this, for example BT4-016.
- Pack (`pack`, text): Optional. Only cards printed in this pack. The name has to match the one digimoncard.io stores, including the set code and the colon.
- Game (`series`, text): Optional. Which of the three Digimon card games to search. Leave blank for all of them; the 2020 Digimon Card Game is the one in print. One of: `Digimon Card Game` (Digimon Card Game (2020-)), `Digimon Digi-Battle Card Game` (Digimon Digi-Battle Card Game (1999-2001)), `Digimon Collectible Card Game` (Digimon Collectible Card Game (1998-2000)).
- Digivolution cost (`evolution_cost`, number): Optional. Only cards that cost this much memory to digivolve into. At least 0.
- Digivolves from colour (`evolution_color`, text): Optional. Only cards that digivolve from a Digimon of this colour. One of: `Black`, `Blue`, `Colorless`, `Green`, `Purple`, `Red`, `White`, `Yellow`.
- Sort by (`sort_by`, text): Optional. How to order the cards. Leave blank for the database's own order. One of: `name`, `power` (DP (power)), `code` (Card number), `color` (Colour), `random`.
- Sort direction (`sort_direction`, text): Optional. Which way to order the cards. Only applies alongside Sort by. One of: `asc` (Ascending), `desc` (Descending).
- 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; paging costs no extra request. 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": [
    {
      "alt_effect": null,
      "artist": null,
      "attribute": "Variable",
      "card_number": "BT4-016",
      "card_page_url": "https://digimoncard.io/card/aldamon-bt4-016",
      "color": "Red",
      "color2": null,
      "colors": [
        "Red"
      ],
      "date_added": "2024-05-27 15:14:30",
      "digi_type": "Wizard",
      "digi_type2": null,
      "digi_types": [
        "Wizard"
      ],
      "dp": 7000,
      "evolution_color": "Red",
      "evolution_cost": 3,
      "evolution_level": 4,
      "form": "Hybrid",
      "image_url": "https://images.digimoncard.io/images/cards/BT4-016.jpg",
      "level": 5,
      "main_effect": "<Security Attack +1> (This Digimon checks 1 additional security card).\n[Your Turn] While this Digimon's digivolution cards include a Digimon card with the [Hybrid] trait or a red Tamer card, it gets +4000 DP.",
      "name": "Aldamon",
      "play_cost": 8,
      "pretty_url": "aldamon-bt4-016",
      "rarity": "sr",
      "series": "Digimon Card Game",
      "source_effect": null,
      "stage": "Hybrid",
      "tcgplayer_id": 238186,
      "tcgplayer_name": "Aldamon",
      "type": "Digimon",
      "xros_requirement": null
    }
  ],
  "count": 1,
  "has_more": true,
  "next_offset": 1,
  "offset": 0,
  "total_count": 12
}
```

### Search rules text

Find cards by what they do rather than what they are called, searching both the main and inherited effects: "draw 1 card", "<Blocker>", "delete 1 of your opponent's". The way to build around a mechanic. No API key required.

**Inputs**

- Rules text contains (`effect_contains`, text, required): The words to look for in the card's rules text. Keywords are written in angle brackets on the card, so search "<Blocker>" for the keyword itself.
- Colour (`color`, text): Optional. Only cards of this colour. One of: `Black`, `Blue`, `Colorless`, `Green`, `Purple`, `Red`, `White`, `Yellow`.
- Card type (`card_type`, text): Optional. Only cards of this type: a Digimon, an Option, a Tamer or a Digi-Egg. One of: `Digimon`, `Option`, `Tamer`, `Digi-Egg`.
- Game (`series`, text): Optional. Which of the three Digimon card games to search. Leave blank for all of them; the 2020 Digimon Card Game is the one in print. One of: `Digimon Card Game` (Digimon Card Game (2020-)), `Digimon Digi-Battle Card Game` (Digimon Digi-Battle Card Game (1999-2001)), `Digimon Collectible Card Game` (Digimon Collectible Card Game (1998-2000)).
- Sort by (`sort_by`, text): Optional. How to order the cards. Leave blank for the database's own order. One of: `name`, `power` (DP (power)), `code` (Card number), `color` (Colour), `random`.
- Sort direction (`sort_direction`, text): Optional. Which way to order the cards. Only applies alongside Sort by. One of: `asc` (Ascending), `desc` (Descending).
- 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; paging costs no extra request. At least 0. Default: `0`.

**Outputs**

- `cards` (list): The cards whose rules text matched.
- `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": [
    {
      "alt_effect": null,
      "artist": null,
      "attribute": "Variable",
      "card_number": "BT4-016",
      "card_page_url": "https://digimoncard.io/card/aldamon-bt4-016",
      "color": "Red",
      "color2": null,
      "colors": [
        "Red"
      ],
      "date_added": "2024-05-27 15:14:30",
      "digi_type": "Wizard",
      "digi_type2": null,
      "digi_types": [
        "Wizard"
      ],
      "dp": 7000,
      "evolution_color": "Red",
      "evolution_cost": 3,
      "evolution_level": 4,
      "form": "Hybrid",
      "image_url": "https://images.digimoncard.io/images/cards/BT4-016.jpg",
      "level": 5,
      "main_effect": "<Security Attack +1> (This Digimon checks 1 additional security card).\n[Your Turn] While this Digimon's digivolution cards include a Digimon card with the [Hybrid] trait or a red Tamer card, it gets +4000 DP.",
      "name": "Aldamon",
      "play_cost": 8,
      "pretty_url": "aldamon-bt4-016",
      "rarity": "sr",
      "series": "Digimon Card Game",
      "source_effect": null,
      "stage": "Hybrid",
      "tcgplayer_id": 238186,
      "tcgplayer_name": "Aldamon",
      "type": "Digimon",
      "xros_requirement": null
    }
  ],
  "count": 1,
  "has_more": true,
  "next_offset": 1,
  "offset": 0,
  "total_count": 12
}
```

### Summarize cards

Run the same search as Search cards but get counts instead of a card list: how a pack breaks down by colour, type, rarity and level, which Digi-Types a set leans on, and the play-cost range. Answers a question about a set without pulling every card through the workflow. No API key required.

**Inputs**

- Name contains (`name_contains`, text): Optional. Only count cards whose name contains this.
- Rules text contains (`effect_contains`, text): Optional. Only count cards whose rules text contains this.
- Colour (`color`, text): Optional. Only cards of this colour. One of: `Black`, `Blue`, `Colorless`, `Green`, `Purple`, `Red`, `White`, `Yellow`.
- Card type (`card_type`, text): Optional. Only cards of this type: a Digimon, an Option, a Tamer or a Digi-Egg. One of: `Digimon`, `Option`, `Tamer`, `Digi-Egg`.
- Attribute (`attribute`, text): Optional. Only Digimon of this attribute, such as Vaccine, Virus, Data, Free or Variable.
- Digi-Type (`digi_type`, text): Optional. Only Digimon with this Digi-Type: the trait line under the artwork, such as Dragon, Wizard or Machine.
- Pack (`pack`, text): Optional. Only cards printed in this pack. The name has to match the one digimoncard.io stores, including the set code and the colon.
- Game (`series`, text): Optional. Which of the three Digimon card games to search. Leave blank for all of them; the 2020 Digimon Card Game is the one in print. One of: `Digimon Card Game` (Digimon Card Game (2020-)), `Digimon Digi-Battle Card Game` (Digimon Digi-Battle Card Game (1999-2001)), `Digimon Collectible Card Game` (Digimon Collectible Card Game (1998-2000)).

**Outputs**

- `by_attribute` (list): Cards per attribute.
- `by_color` (list): Cards per colour. A two-coloured card is counted under each of its colours.
- `by_digi_type` (list): Cards per Digi-Type. A card with two is counted under each.
- `by_form` (list): Cards per form.
- `by_level` (list): Cards per level. Cards with no level are not counted.
- `by_rarity` (list): Cards per rarity code.
- `by_stage` (list): Cards per stage.
- `by_type` (list): Cards per card type: Digimon, Option, Tamer, Digi-Egg.
- `highest_play_cost` (number): The dearest play cost among the matching cards. Null when none of them has one.
- `lowest_play_cost` (number): The cheapest play cost among the matching cards. Null when none of them has one.
- `total_count` (number): How many cards matched the filters.

**Example output**

```json
{
  "by_attribute": [
    {
      "count": 30,
      "value": "Vaccine"
    },
    {
      "count": 26,
      "value": "Data"
    }
  ],
  "by_color": [
    {
      "count": 24,
      "value": "Red"
    },
    {
      "count": 22,
      "value": "Blue"
    }
  ],
  "by_digi_type": [
    {
      "count": 12,
      "value": "Dragon"
    },
    {
      "count": 8,
      "value": "Wizard"
    }
  ],
  "by_form": [
    {
      "count": 24,
      "value": "Rookie"
    }
  ],
  "by_level": [
    {
      "count": 26,
      "value": "4"
    },
    {
      "count": 24,
      "value": "3"
    }
  ],
  "by_rarity": [
    {
      "count": 44,
      "value": "c"
    },
    {
      "count": 30,
      "value": "u"
    }
  ],
  "by_stage": [
    {
      "count": 24,
      "value": "Rookie"
    }
  ],
  "by_type": [
    {
      "count": 78,
      "value": "Digimon"
    },
    {
      "count": 20,
      "value": "Option"
    }
  ],
  "highest_play_cost": 14,
  "lowest_play_cost": 1,
  "total_count": 116
}
```