LogoLogo
  • Knowledge
    • Getting started
    • Frequently Asked Questions
  • Endpoints
    • Definitions
    • Multiple cards
    • Individual cards
    • Featured set groups
    • Images
    • API metadata
  • Links
    • Grand Archive API
    • OpenAPI spec
    • Swagger
    • Index - Card database
Powered by GitBook
On this page
Export as PDF
  1. Endpoints

Multiple cards

PreviousDefinitionsNextIndividual cards

Last updated 3 months ago

Find cards.

get

This returns cards matching the provided query parameters.

Query parameters
classstring[]Optional

Get cards with any class value included in this list.

class_logicstring · enumOptional

Use this to adjust how cards are targeted by the class query parameter. OR includes any card which includes one or more of the class values, whilst AND only matches cards that include all of the specified class values.

Default: ORPossible values:
collabbooleanOptional

Include or exclude editions which have collaborators.

collector_numberstringOptional

Get a card with an edition's collector_number that exactly matches this string.

configurationstring · enumOptional

Find cards using a specific configuration.

Example: flipPossible values:
edition_effectstringOptional

Get a card with an edition's effect_raw that is similar to this string.

edition_flavorstringOptional

Get a card with an edition's flavor that is similar to this string.

edition_last_updatestring · dateOptional

Get a card with an edition's last_update date greater than this value.

Example: 2023-03-30
edition_slugstringOptional

Get a card with an edition's slug that exactly matches this string.

effectstringOptional

Get a card with effect_raw or edition effect_raw that is similar to this string.

elementstring[]Optional

Get cards with any element value included in this list.

flavorstringOptional

Get a card with a flavor that is similar to this string.

illustratorstringOptional

Get a card with an edition's illustrator that exactly matches this string. "null" can be used to match cards with no illustrator.

languagestring[]Optional

Get a card with an edition's set's language that exactly matches this string.

last_updatestring · dateOptional

Get a card with a last_update date greater than this value.

Example: 2023-03-30
legality_formatstring · enumOptional

Used in parallel with legality_limit, specify which game format to target.

Possible values:
legality_limitnumberOptional

Used in parallel with legality_format, specify an exact card limit.

legality_statestring · enumOptional

Used in parallel with legality_format, specify whether a card is legal or restricted. This is ignored if legality_limit is specified.

Default: ANYPossible values:
namestringOptional

Get a card with a name that is similar to this string.

orderstring · enumOptional

Specify the order to return the matching results in.

Default: ASCPossible values:
pagenumber · min: 1Optional

Get a card with a flavor that is similar to this string.

Default: 1
page_sizenumber · min: 1 · max: 50Optional

Specify how many results to include per page.

Default: 50
prefixstring[]Optional

Get a cards with any edition's set's prefix included in this list.

raritynumberOptional

Get a card with an edition's rarity that exactly matches this number.

rulestringOptional

Get a card with a rule whose title or description contains this case-insensitive string.

rule_titlestringOptional

Get a card with a rule whose title exactly matches this case-insensitive string. "null" can be used to match cards with rules that have no title.

separate_editionsbooleanOptional

Split each result_edition into its own dedicated data entry. By default all editions shared by cards of the same name are grouped together, however it may be more desirable in some cases to split these editions into their own results.

slugstringOptional

Get a card with a slug that exactly matches this string.

statsstringOptional

Get a card whose numeric stats are contained within a semicolon-delimited list of values.

sortstring · enumOptional

Specify the primary card or edition field the results are sorted by.

Default: collector_numberPossible values:
subtypestring[]Optional

Get cards with any subtype value included in this list.

subtype_logicstring · enumOptional

Use this to adjust how cards are targeted by the subtype query parameter. OR includes any card which includes one or more of the subtype values, whilst AND only matches cards that include all of the specified subtype values.

Default: ORPossible values:
typestring[]Optional

Get cards with any type value included in this list.

type_logicstring · enumOptional

Use this to adjust how cards are targeted by the type query parameter. OR includes any card which includes one or more of the type values, whilst AND only matches cards that include all of the specified type values.

Default: ORPossible values:
Responses
200Success
application/json
get
GET /cards/search HTTP/1.1
Host: api.gatcg.com
Accept: */*
200Success
{
  "data": [
    {
      "classes": [
        "WARRIOR"
      ],
      "cost_memory": 1,
      "cost_reserve": null,
      "created_at": "2024-10-11T12:00:00+00:00",
      "durability": 3,
      "editions": [
        {
          "card_id": "abcde12345",
          "circulationTemplates": [
            {
              "kind": "FOIL",
              "population": 100,
              "population_operator": "=",
              "printing": false,
              "created_at": "2024-10-11T12:00:00+00:00",
              "edition_id": "abcde12345",
              "foil": false,
              "uuid": "abcde12345",
              "variants": [],
              "name": "AMB NF C 2"
            }
          ],
          "circulations": [],
          "collaborators": [],
          "collector_number": "010",
          "configuration": "default",
          "created_at": "2024-10-11T12:00:00+00:00",
          "effect": null,
          "effect_html": null,
          "effect_raw": null,
          "flavor": "The centerpiece of the Imperial Armory.",
          "illustrator": "Dragonart",
          "image": "text",
          "last_update": "2024-10-11T12:00:00+00:00",
          "orientation": null,
          "other_orientations": [],
          "rarity": 1,
          "slug": "crescent-glaive-amb",
          "set": {
            "created_at": "2024-10-11T12:00:00+00:00",
            "id": "abcde12345",
            "language": "EN",
            "last_update": "2024-10-11T12:00:00+00:00",
            "name": "Mortal Ambition",
            "prefix": "AMB",
            "release_date": "2024-10-11T00:00:00"
          },
          "thema_charm_foil": null,
          "thema_ferocity_foil": null,
          "thema_foil": null,
          "thema_grace_foil": null,
          "thema_mystique_foil": null,
          "thema_valor_foil": null,
          "thema_charm_nonfoil": null,
          "thema_ferocity_nonfoil": null,
          "thema_grace_nonfoil": null,
          "thema_mystique_nonfoil": null,
          "thema_nonfoil": null,
          "thema_valor_nonfoil": null,
          "uuid": "abcde12345"
        }
      ],
      "element": "WATER",
      "effect": "[Class Bonus] [Level 2+] CARDNAME gets +1 [POWER]. *(Apply this effect only if your champion's class matches this card's class and only if your champion is level 2 or higher.)*",
      "effect_raw": "[Class Bonus] [Level 2+] Crescent Glaive gets +1 POWER. (Apply this effect only if your champion's class matches this card's class and only if your champion is level 2 or higher.)",
      "flavor": "Convalescing waves cascade through the soul, revitalizing the body and mind from the depths.",
      "last_update": "2024-10-11T12:00:00+00:00",
      "legality": null,
      "level": null,
      "life": null,
      "name": "Crescent Glaive",
      "power": 1,
      "referenced_by": [],
      "references": [],
      "result_editions": [
        {
          "card_id": "abcde12345",
          "circulationTemplates": [
            {
              "kind": "FOIL",
              "population": 100,
              "population_operator": "=",
              "printing": false,
              "created_at": "2024-10-11T12:00:00+00:00",
              "edition_id": "abcde12345",
              "foil": false,
              "uuid": "abcde12345",
              "variants": [],
              "name": "AMB NF C 2"
            }
          ],
          "circulations": [],
          "collaborators": [],
          "collector_number": "010",
          "configuration": "default",
          "created_at": "2024-10-11T12:00:00+00:00",
          "effect": null,
          "effect_html": null,
          "effect_raw": null,
          "flavor": "The centerpiece of the Imperial Armory.",
          "illustrator": "Dragonart",
          "image": "text",
          "last_update": "2024-10-11T12:00:00+00:00",
          "orientation": null,
          "other_orientations": [],
          "rarity": 1,
          "slug": "crescent-glaive-amb",
          "set": {
            "created_at": "2024-10-11T12:00:00+00:00",
            "id": "abcde12345",
            "language": "EN",
            "last_update": "2024-10-11T12:00:00+00:00",
            "name": "Mortal Ambition",
            "prefix": "AMB",
            "release_date": "2024-10-11T00:00:00"
          },
          "thema_charm_foil": null,
          "thema_ferocity_foil": null,
          "thema_foil": null,
          "thema_grace_foil": null,
          "thema_mystique_foil": null,
          "thema_valor_foil": null,
          "thema_charm_nonfoil": null,
          "thema_ferocity_nonfoil": null,
          "thema_grace_nonfoil": null,
          "thema_mystique_nonfoil": null,
          "thema_nonfoil": null,
          "thema_valor_nonfoil": null,
          "uuid": "abcde12345"
        }
      ],
      "rule": [],
      "speed": null,
      "slug": "crescent-glaive",
      "subtypes": [
        "WARRIOR",
        "POLEARM"
      ],
      "types": [
        "REGALIA",
        "WEAPON"
      ],
      "uuid": "abcde12345"
    }
  ],
  "has_more": false,
  "order": "ASC",
  "page": 1,
  "page_size": 30,
  "paginated_cards_count": 1,
  "sort": "collector_number",
  "total_cards": 1,
  "total_pages": 1
}

Quick card search.

get

This returns a list of up to 10 cards which match the given query.

Query parameters
namestringRequired

A partial card name to search with.

Example: Glaive
Responses
200
A list of matching cards.
application/json
get
GET /cards/autocomplete HTTP/1.1
Host: api.gatcg.com
Accept: */*
200

A list of matching cards.

[
  {
    "classes": [
      "WARRIOR"
    ],
    "editions": [
      {
        "card_id": "abcde12345",
        "collector_number": "010",
        "effect": null,
        "effect_raw": null,
        "flavor": "The centerpiece of the Imperial Armory.",
        "illustrator": "Dragonart",
        "rarity": 1,
        "slug": "crescent-glaive-amb",
        "uuid": "abcde12345"
      }
    ],
    "name": "Crescent Glaive",
    "slug": "crescent-glaive",
    "subtypes": [
      "WARRIOR",
      "POLEARM"
    ],
    "types": [
      "REGALIA",
      "WEAPON"
    ],
    "uuid": "abcde12345"
  }
]

Get random cards.

get
Query parameters
amountnumber · min: 1 · max: 50Optional

Quantity of random cards to return.

Default: 8
Responses
200Success
application/json
404Error
application/json
get
GET /cards/random HTTP/1.1
Host: api.gatcg.com
Accept: */*

[
  {
    "classes": [
      "WARRIOR"
    ],
    "cost_memory": 1,
    "cost_reserve": null,
    "created_at": "2024-10-11T12:00:00+00:00",
    "durability": 3,
    "editions": [
      {
        "card_id": "abcde12345",
        "circulationTemplates": [
          {
            "kind": "FOIL",
            "population": 100,
            "population_operator": "=",
            "printing": false,
            "created_at": "2024-10-11T12:00:00+00:00",
            "edition_id": "abcde12345",
            "foil": false,
            "uuid": "abcde12345",
            "variants": [],
            "name": "AMB NF C 2"
          }
        ],
        "circulations": [],
        "collaborators": [],
        "collector_number": "010",
        "configuration": "default",
        "created_at": "2024-10-11T12:00:00+00:00",
        "effect": null,
        "effect_html": null,
        "effect_raw": null,
        "flavor": "The centerpiece of the Imperial Armory.",
        "illustrator": "Dragonart",
        "image": "text",
        "last_update": "2024-10-11T12:00:00+00:00",
        "orientation": null,
        "other_orientations": [],
        "rarity": 1,
        "slug": "crescent-glaive-amb",
        "set": {
          "created_at": "2024-10-11T12:00:00+00:00",
          "id": "abcde12345",
          "language": "EN",
          "last_update": "2024-10-11T12:00:00+00:00",
          "name": "Mortal Ambition",
          "prefix": "AMB",
          "release_date": "2024-10-11T00:00:00"
        },
        "thema_charm_foil": null,
        "thema_ferocity_foil": null,
        "thema_foil": null,
        "thema_grace_foil": null,
        "thema_mystique_foil": null,
        "thema_valor_foil": null,
        "thema_charm_nonfoil": null,
        "thema_ferocity_nonfoil": null,
        "thema_grace_nonfoil": null,
        "thema_mystique_nonfoil": null,
        "thema_nonfoil": null,
        "thema_valor_nonfoil": null,
        "uuid": "abcde12345"
      }
    ],
    "element": "WATER",
    "effect": "[Class Bonus] [Level 2+] CARDNAME gets +1 [POWER]. *(Apply this effect only if your champion's class matches this card's class and only if your champion is level 2 or higher.)*",
    "effect_raw": "[Class Bonus] [Level 2+] Crescent Glaive gets +1 POWER. (Apply this effect only if your champion's class matches this card's class and only if your champion is level 2 or higher.)",
    "flavor": "Convalescing waves cascade through the soul, revitalizing the body and mind from the depths.",
    "last_update": "2024-10-11T12:00:00+00:00",
    "legality": null,
    "level": null,
    "life": null,
    "name": "Crescent Glaive",
    "power": 1,
    "referenced_by": [],
    "references": [],
    "result_editions": [
      {
        "card_id": "abcde12345",
        "circulationTemplates": [
          {
            "kind": "FOIL",
            "population": 100,
            "population_operator": "=",
            "printing": false,
            "created_at": "2024-10-11T12:00:00+00:00",
            "edition_id": "abcde12345",
            "foil": false,
            "uuid": "abcde12345",
            "variants": [],
            "name": "AMB NF C 2"
          }
        ],
        "circulations": [],
        "collaborators": [],
        "collector_number": "010",
        "configuration": "default",
        "created_at": "2024-10-11T12:00:00+00:00",
        "effect": null,
        "effect_html": null,
        "effect_raw": null,
        "flavor": "The centerpiece of the Imperial Armory.",
        "illustrator": "Dragonart",
        "image": "text",
        "last_update": "2024-10-11T12:00:00+00:00",
        "orientation": null,
        "other_orientations": [],
        "rarity": 1,
        "slug": "crescent-glaive-amb",
        "set": {
          "created_at": "2024-10-11T12:00:00+00:00",
          "id": "abcde12345",
          "language": "EN",
          "last_update": "2024-10-11T12:00:00+00:00",
          "name": "Mortal Ambition",
          "prefix": "AMB",
          "release_date": "2024-10-11T00:00:00"
        },
        "thema_charm_foil": null,
        "thema_ferocity_foil": null,
        "thema_foil": null,
        "thema_grace_foil": null,
        "thema_mystique_foil": null,
        "thema_valor_foil": null,
        "thema_charm_nonfoil": null,
        "thema_ferocity_nonfoil": null,
        "thema_grace_nonfoil": null,
        "thema_mystique_nonfoil": null,
        "thema_nonfoil": null,
        "thema_valor_nonfoil": null,
        "uuid": "abcde12345"
      }
    ],
    "rule": [],
    "speed": null,
    "slug": "crescent-glaive",
    "subtypes": [
      "WARRIOR",
      "POLEARM"
    ],
    "types": [
      "REGALIA",
      "WEAPON"
    ],
    "uuid": "abcde12345"
  }
]
  • GETFind cards.
  • GETQuick card search.
  • GETGet random cards.