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

Individual cards

PreviousMultiple cardsNextFeatured set groups

Last updated 3 months ago

Get card by slug.

get

This returns a card matching the provided slug.

Path parameters
slugstringRequired

The card's URL-friendly slug.

Example: crescent-glaive
Responses
200
The matching card.
application/json
404Error
application/json
get
GET /cards/{slug} 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"
}

Get card by edition slug.

get

This returns a card with an edition matching the provided edition slug.

Path parameters
edition_slugstringRequired

The edition's URL-friendly slug. This is usually in the format {card-slug}-{set-prefix}, but can be extended if additional context is required.

Example: crescent-glaive-amb
Responses
200
The matching card.
application/json
404Error
application/json
get
GET /cards/edition/{edition_slug} 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"
}

Get card by its set and collector number.

get

This returns a card matching the provided set prefix and collector number combination.

Path parameters
collector_numberstringRequired

The edition's collector number in the set it belongs to.

Example: 010
set_prefixstringRequired

The set's prefix as printed in the footer of its cards.

Example: AMB
Responses
200
The matching card.
application/json
404Error
application/json
get
GET /cards/{set_prefix}/{collector_number} 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"
}

Get a card edition's image.

get
Path parameters
filenamestringRequired

The filename to download.

Example: lorraine-wandering-warrior-doap.jpg
Query parameters
roundedbooleanOptional

Round the corners of the image. Note that whilst the request remains as .jpg the output file type will be .png instead.

Responses
200
Image file.
image/jpg
Responsestring ยท binary[]

Image file.

404Error
application/json
get
GET /cards/images/{filename} HTTP/1.1
Host: api.gatcg.com
Accept: */*
[
  "binary"
]
  • GETGet card by slug.
  • GETGet card by edition slug.
  • GETGet card by its set and collector number.
  • GETGet a card edition's image.