{ "info": { "title": "Grand Archive API", "version": "1.1.0", "description": "" }, "openapi": "3.0.3", "paths": { "/cards/{set_prefix}/{collector_number}": { "get": { "operationId": "GetCardBySetCollectorNumberAPISpec_get_/{set_prefix}/{collector_number}", "tags": [ "Individual cards" ], "summary": "Get card by its set and collector number.", "description": "This returns a card matching the provided set prefix and collector number combination.", "parameters": [ { "description": "The edition's collector number in the set it belongs to.", "name": "collector_number", "in": "path", "required": true, "schema": { "example": "010", "type": "string" } }, { "description": "The set's prefix as printed in the footer of its cards.", "name": "set_prefix", "in": "path", "required": true, "schema": { "example": "AMB", "type": "string" } } ], "responses": { "200": { "description": "The matching card.", "content": { "application/json": { "schema": { "description": "The matching card.", "type": "object", "properties": { "classes": { "description": "The card's classes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR" ], "type": "array", "items": { "type": "string" } }, "cost_memory": { "$ref": "#/components/schemas/CardCostMemory" }, "cost_reserve": { "$ref": "#/components/schemas/CardCostReserve" }, "cost": { "description": "The card's cost.", "type": "object", "properties": { "type": { "description": "The cost type.", "example": "memory", "enum": [ "memory", "none", "reserve" ], "type": "string" }, "value": { "description": "The cost value.\nThis is a number represented as a string, or a dynamic cost like `\"X\"`.\nThis is only `null` if the cost type is `\"none\"`.", "example": "1", "type": "string", "nullable": true } }, "additionalProperties": false, "required": [ "type", "value" ] }, "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "durability": { "$ref": "#/components/schemas/CardStatDurability" }, "editions": { "description": "A list of all editions this card is a parent of.", "type": "array", "items": { "description": "The Edition type describes a specific release of its parent Card.", "type": "object", "properties": { "card_id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "circulationTemplates": { "description": "Templated prints of this edition which are shared with other editions of this or any other card.", "type": "array", "items": { "$ref": "#/components/schemas/CirculationTemplate" } }, "circulations": { "description": "Non-templated prints of this edition which are not shared with other editions of any other card.", "example": [], "type": "array", "items": { "$ref": "#/components/schemas/Circulation" } }, "collaborators": { "description": "Collaborators that worked on the edition's artwork alongside the edition's illustrator.", "example": [], "type": "array", "items": { "type": "string" } }, "collector_number": { "description": "The edition's collector number in the set it belongs to.", "example": "010", "type": "string" }, "configuration": { "$ref": "#/components/schemas/EditionConfiguration" }, "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "effect": { "$ref": "#/components/schemas/EditionEffect" }, "effect_html": { "$ref": "#/components/schemas/EditionEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/EditionEffectRaw" }, "flavor": { "$ref": "#/components/schemas/EditionFlavor" }, "illustrator": { "$ref": "#/components/schemas/EditionIllustrator" }, "image": { "description": "An API image path (`/cards/images/example.jpg` implies `https://api.gatcg.com/cards/images/example.jpg`).", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "orientation": { "$ref": "#/components/schemas/EditionOrientation" }, "other_orientations": { "description": "Other orientations related to this edition.", "example": [], "type": "array", "items": { "description": "Other orientations that relate to this one. This will return the back face for editions with an `orientation` set to `\"front\"`, and vice versa.", "type": "object", "properties": { "classes": { "description": "The card's classes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR" ], "type": "array", "items": { "type": "string" } }, "cost": { "description": "The card's cost.", "type": "object", "properties": { "type": { "description": "The cost type.", "example": "memory", "enum": [ "memory", "none", "reserve" ], "type": "string" }, "value": { "description": "The cost value.\nThis is a number represented as a string, or a dynamic cost like `\"X\"`.\nThis is only `null` if the cost type is `\"none\"`.", "example": "1", "type": "string", "nullable": true } }, "additionalProperties": false, "required": [ "type", "value" ] }, "cost_memory": { "$ref": "#/components/schemas/CardCostMemory" }, "cost_reserve": { "$ref": "#/components/schemas/CardCostReserve" }, "created_at": { "type": "string", "format": "date-time" }, "durability": { "$ref": "#/components/schemas/CardStatDurability" }, "edition": { "type": "object", "properties": { "card_id": { "type": "string" }, "collaborators": { "type": "array", "items": { "type": "string" } }, "collector_number": { "type": "string" }, "configuration": { "$ref": "#/components/schemas/EditionConfiguration" }, "created_at": { "type": "string", "format": "date-time" }, "effect": { "$ref": "#/components/schemas/EditionEffect" }, "effect_html": { "$ref": "#/components/schemas/EditionEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/EditionEffectRaw" }, "flavor": { "$ref": "#/components/schemas/EditionFlavor" }, "illustrator": { "$ref": "#/components/schemas/EditionIllustrator" }, "image": { "type": "string" }, "last_update": { "type": "string", "format": "date-time" }, "orientation": { "$ref": "#/components/schemas/EditionOrientation" }, "rarity": { "type": "number" }, "set": { "type": "object", "properties": { "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "language": { "description": "The language used by the dataset.", "example": "EN", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "name": { "description": "The name of the set.", "example": "Mortal Ambition", "type": "string" }, "prefix": { "description": "The set's prefix as printed in the footer of its cards.", "example": "AMB", "type": "string" }, "release_date": { "description": "When the set was publicly-released.", "example": "2024-10-11T00:00:00", "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "created_at", "id", "language", "last_update", "name", "prefix", "release_date" ] }, "slug": { "type": "string" }, "thema_charm_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_grace_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_valor_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_charm_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_grace_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_nonfoil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_valor_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil_dynamic": { "type": "boolean" }, "thema_nonfoil_dynamic": { "type": "boolean" }, "uuid": { "type": "string" } }, "additionalProperties": false, "required": [ "card_id", "collaborators", "collector_number", "configuration", "created_at", "effect", "effect_html", "effect_raw", "flavor", "illustrator", "image", "last_update", "orientation", "rarity", "set", "slug", "thema_charm_foil", "thema_charm_nonfoil", "thema_ferocity_foil", "thema_ferocity_nonfoil", "thema_foil", "thema_foil_dynamic", "thema_grace_foil", "thema_grace_nonfoil", "thema_mystique_foil", "thema_mystique_nonfoil", "thema_nonfoil", "thema_nonfoil_dynamic", "thema_valor_foil", "thema_valor_nonfoil", "uuid" ] }, "edition_id": { "type": "string" }, "effect": { "$ref": "#/components/schemas/CardEffectTemplate" }, "effect_html": { "$ref": "#/components/schemas/CardEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/CardEffectRaw" }, "element": { "type": "string" }, "elements": { "type": "array", "items": { "type": "string" } }, "flavor": { "$ref": "#/components/schemas/CardFlavor" }, "last_update": { "type": "string", "format": "date-time" }, "level": { "$ref": "#/components/schemas/CardStatLevel" }, "life": { "$ref": "#/components/schemas/CardStatLife" }, "name": { "type": "string" }, "power": { "$ref": "#/components/schemas/CardStatPower" }, "slug": { "type": "string" }, "speed": { "$ref": "#/components/schemas/CardStatSpeed" }, "subtypes": { "description": "The card's subtypes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR", "POLEARM" ], "type": "array", "items": { "type": "string" } }, "types": { "description": "The card's types. The possible values are revealed by the `option/search` endpoint.", "example": [ "REGALIA", "WEAPON" ], "type": "array", "items": { "type": "string" } }, "uuid": { "type": "string" } }, "additionalProperties": false, "required": [ "classes", "cost", "cost_memory", "cost_reserve", "created_at", "durability", "edition", "edition_id", "effect", "effect_html", "effect_raw", "element", "elements", "flavor", "last_update", "level", "life", "name", "power", "slug", "speed", "subtypes", "types", "uuid" ] } }, "rarity": { "description": "The edition's rarity. The possible values are revealed by the `option/search` endpoint.", "example": 1, "type": "number" }, "slug": { "description": "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", "type": "string" }, "set": { "type": "object", "properties": { "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "language": { "description": "The language used by the dataset.", "example": "EN", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "name": { "description": "The name of the set.", "example": "Mortal Ambition", "type": "string" }, "prefix": { "description": "The set's prefix as printed in the footer of its cards.", "example": "AMB", "type": "string" }, "release_date": { "description": "When the set was publicly-released.", "example": "2024-10-11T00:00:00", "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "created_at", "id", "language", "last_update", "name", "prefix", "release_date" ] }, "thema_charm_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_grace_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_valor_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_charm_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_grace_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_nonfoil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_valor_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil_dynamic": { "description": "Determines if the Thema scores for the edition are dynamic.\nDynamic Thema scores update daily and are primarily used for added randomization in Path of Silver events.", "example": false, "type": "boolean" }, "thema_nonfoil_dynamic": { "description": "Determines if the Thema scores for the edition are dynamic.\nDynamic Thema scores update daily and are primarily used for added randomization in Path of Silver events.", "example": false, "type": "boolean" }, "uuid": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" } }, "additionalProperties": false, "required": [ "card_id", "circulationTemplates", "circulations", "collaborators", "collector_number", "configuration", "created_at", "effect", "effect_html", "effect_raw", "flavor", "illustrator", "image", "last_update", "orientation", "other_orientations", "rarity", "set", "slug", "thema_charm_foil", "thema_charm_nonfoil", "thema_ferocity_foil", "thema_ferocity_nonfoil", "thema_foil", "thema_foil_dynamic", "thema_grace_foil", "thema_grace_nonfoil", "thema_mystique_foil", "thema_mystique_nonfoil", "thema_nonfoil", "thema_nonfoil_dynamic", "thema_valor_foil", "thema_valor_nonfoil", "uuid" ] } }, "element": { "description": "The card's element. The possible values are revealed by the `option/search` endpoint.", "example": "WATER", "type": "string", "deprecated": true }, "elements": { "description": "The card's element(s). The possible values are revealed by the `option/search` endpoint.", "example": [ "WATER" ], "type": "array", "items": { "type": "string" } }, "effect": { "$ref": "#/components/schemas/CardEffectTemplate" }, "effect_html": { "$ref": "#/components/schemas/CardEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/CardEffectRaw" }, "flavor": { "$ref": "#/components/schemas/CardFlavor" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "legality": { "$ref": "#/components/schemas/CardLegality" }, "level": { "$ref": "#/components/schemas/CardStatLevel" }, "life": { "$ref": "#/components/schemas/CardStatLife" }, "name": { "description": "The card's name.", "example": "Crescent Glaive", "type": "string" }, "power": { "$ref": "#/components/schemas/CardStatPower" }, "referenced_by": { "description": "References made to this card by other cards.", "example": [], "type": "array", "items": { "type": "object", "properties": { "direction": { "type": "string", "enum": [ "FROM" ] }, "kind": { "$ref": "#/components/schemas/CardReferenceKind" }, "name": { "description": "The card's name.", "example": "Crescent Glaive", "type": "string" }, "slug": { "description": "The card's URL-friendly slug.", "example": "crescent-glaive", "type": "string" } }, "additionalProperties": false, "required": [ "direction", "kind", "name", "slug" ] } }, "references": { "description": "References this card makes to other cards.", "example": [], "type": "array", "items": { "type": "object", "properties": { "direction": { "type": "string", "enum": [ "TO" ] }, "kind": { "$ref": "#/components/schemas/CardReferenceKind" }, "name": { "description": "The card's name.", "example": "Crescent Glaive", "type": "string" }, "slug": { "description": "The card's URL-friendly slug.", "example": "crescent-glaive", "type": "string" } }, "additionalProperties": false, "required": [ "direction", "kind", "name", "slug" ] } }, "result_editions": { "description": "A list of all editions this card is a parent of which match the given query.", "type": "array", "items": { "description": "The Edition type describes a specific release of its parent Card.", "type": "object", "properties": { "card_id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "circulationTemplates": { "description": "Templated prints of this edition which are shared with other editions of this or any other card.", "type": "array", "items": { "$ref": "#/components/schemas/CirculationTemplate" } }, "circulations": { "description": "Non-templated prints of this edition which are not shared with other editions of any other card.", "example": [], "type": "array", "items": { "$ref": "#/components/schemas/Circulation" } }, "collaborators": { "description": "Collaborators that worked on the edition's artwork alongside the edition's illustrator.", "example": [], "type": "array", "items": { "type": "string" } }, "collector_number": { "description": "The edition's collector number in the set it belongs to.", "example": "010", "type": "string" }, "configuration": { "$ref": "#/components/schemas/EditionConfiguration" }, "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "effect": { "$ref": "#/components/schemas/EditionEffect" }, "effect_html": { "$ref": "#/components/schemas/EditionEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/EditionEffectRaw" }, "flavor": { "$ref": "#/components/schemas/EditionFlavor" }, "illustrator": { "$ref": "#/components/schemas/EditionIllustrator" }, "image": { "description": "An API image path (`/cards/images/example.jpg` implies `https://api.gatcg.com/cards/images/example.jpg`).", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "orientation": { "$ref": "#/components/schemas/EditionOrientation" }, "other_orientations": { "description": "Other orientations related to this edition.", "example": [], "type": "array", "items": { "description": "Other orientations that relate to this one. This will return the back face for editions with an `orientation` set to `\"front\"`, and vice versa.", "type": "object", "properties": { "classes": { "description": "The card's classes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR" ], "type": "array", "items": { "type": "string" } }, "cost": { "description": "The card's cost.", "type": "object", "properties": { "type": { "description": "The cost type.", "example": "memory", "enum": [ "memory", "none", "reserve" ], "type": "string" }, "value": { "description": "The cost value.\nThis is a number represented as a string, or a dynamic cost like `\"X\"`.\nThis is only `null` if the cost type is `\"none\"`.", "example": "1", "type": "string", "nullable": true } }, "additionalProperties": false, "required": [ "type", "value" ] }, "cost_memory": { "$ref": "#/components/schemas/CardCostMemory" }, "cost_reserve": { "$ref": "#/components/schemas/CardCostReserve" }, "created_at": { "type": "string", "format": "date-time" }, "durability": { "$ref": "#/components/schemas/CardStatDurability" }, "edition": { "type": "object", "properties": { "card_id": { "type": "string" }, "collaborators": { "type": "array", "items": { "type": "string" } }, "collector_number": { "type": "string" }, "configuration": { "$ref": "#/components/schemas/EditionConfiguration" }, "created_at": { "type": "string", "format": "date-time" }, "effect": { "$ref": "#/components/schemas/EditionEffect" }, "effect_html": { "$ref": "#/components/schemas/EditionEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/EditionEffectRaw" }, "flavor": { "$ref": "#/components/schemas/EditionFlavor" }, "illustrator": { "$ref": "#/components/schemas/EditionIllustrator" }, "image": { "type": "string" }, "last_update": { "type": "string", "format": "date-time" }, "orientation": { "$ref": "#/components/schemas/EditionOrientation" }, "rarity": { "type": "number" }, "set": { "type": "object", "properties": { "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "language": { "description": "The language used by the dataset.", "example": "EN", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "name": { "description": "The name of the set.", "example": "Mortal Ambition", "type": "string" }, "prefix": { "description": "The set's prefix as printed in the footer of its cards.", "example": "AMB", "type": "string" }, "release_date": { "description": "When the set was publicly-released.", "example": "2024-10-11T00:00:00", "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "created_at", "id", "language", "last_update", "name", "prefix", "release_date" ] }, "slug": { "type": "string" }, "thema_charm_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_grace_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_valor_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_charm_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_grace_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_nonfoil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_valor_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil_dynamic": { "type": "boolean" }, "thema_nonfoil_dynamic": { "type": "boolean" }, "uuid": { "type": "string" } }, "additionalProperties": false, "required": [ "card_id", "collaborators", "collector_number", "configuration", "created_at", "effect", "effect_html", "effect_raw", "flavor", "illustrator", "image", "last_update", "orientation", "rarity", "set", "slug", "thema_charm_foil", "thema_charm_nonfoil", "thema_ferocity_foil", "thema_ferocity_nonfoil", "thema_foil", "thema_foil_dynamic", "thema_grace_foil", "thema_grace_nonfoil", "thema_mystique_foil", "thema_mystique_nonfoil", "thema_nonfoil", "thema_nonfoil_dynamic", "thema_valor_foil", "thema_valor_nonfoil", "uuid" ] }, "edition_id": { "type": "string" }, "effect": { "$ref": "#/components/schemas/CardEffectTemplate" }, "effect_html": { "$ref": "#/components/schemas/CardEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/CardEffectRaw" }, "element": { "type": "string" }, "elements": { "type": "array", "items": { "type": "string" } }, "flavor": { "$ref": "#/components/schemas/CardFlavor" }, "last_update": { "type": "string", "format": "date-time" }, "level": { "$ref": "#/components/schemas/CardStatLevel" }, "life": { "$ref": "#/components/schemas/CardStatLife" }, "name": { "type": "string" }, "power": { "$ref": "#/components/schemas/CardStatPower" }, "slug": { "type": "string" }, "speed": { "$ref": "#/components/schemas/CardStatSpeed" }, "subtypes": { "description": "The card's subtypes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR", "POLEARM" ], "type": "array", "items": { "type": "string" } }, "types": { "description": "The card's types. The possible values are revealed by the `option/search` endpoint.", "example": [ "REGALIA", "WEAPON" ], "type": "array", "items": { "type": "string" } }, "uuid": { "type": "string" } }, "additionalProperties": false, "required": [ "classes", "cost", "cost_memory", "cost_reserve", "created_at", "durability", "edition", "edition_id", "effect", "effect_html", "effect_raw", "element", "elements", "flavor", "last_update", "level", "life", "name", "power", "slug", "speed", "subtypes", "types", "uuid" ] } }, "rarity": { "description": "The edition's rarity. The possible values are revealed by the `option/search` endpoint.", "example": 1, "type": "number" }, "slug": { "description": "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", "type": "string" }, "set": { "type": "object", "properties": { "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "language": { "description": "The language used by the dataset.", "example": "EN", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "name": { "description": "The name of the set.", "example": "Mortal Ambition", "type": "string" }, "prefix": { "description": "The set's prefix as printed in the footer of its cards.", "example": "AMB", "type": "string" }, "release_date": { "description": "When the set was publicly-released.", "example": "2024-10-11T00:00:00", "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "created_at", "id", "language", "last_update", "name", "prefix", "release_date" ] }, "thema_charm_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_grace_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_valor_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_charm_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_grace_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_nonfoil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_valor_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil_dynamic": { "description": "Determines if the Thema scores for the edition are dynamic.\nDynamic Thema scores update daily and are primarily used for added randomization in Path of Silver events.", "example": false, "type": "boolean" }, "thema_nonfoil_dynamic": { "description": "Determines if the Thema scores for the edition are dynamic.\nDynamic Thema scores update daily and are primarily used for added randomization in Path of Silver events.", "example": false, "type": "boolean" }, "uuid": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" } }, "additionalProperties": false, "required": [ "card_id", "circulationTemplates", "circulations", "collaborators", "collector_number", "configuration", "created_at", "effect", "effect_html", "effect_raw", "flavor", "illustrator", "image", "last_update", "orientation", "other_orientations", "rarity", "set", "slug", "thema_charm_foil", "thema_charm_nonfoil", "thema_ferocity_foil", "thema_ferocity_nonfoil", "thema_foil", "thema_foil_dynamic", "thema_grace_foil", "thema_grace_nonfoil", "thema_mystique_foil", "thema_mystique_nonfoil", "thema_nonfoil", "thema_nonfoil_dynamic", "thema_valor_foil", "thema_valor_nonfoil", "uuid" ] } }, "rule": { "description": "Additional rules and erratas the card is subject to.", "example": [], "type": "array", "items": { "type": "object", "properties": { "date_added": { "type": "string" }, "description": { "type": "string" }, "title": { "type": "string" } }, "additionalProperties": false, "required": [ "date_added", "description", "title" ] } }, "speed": { "$ref": "#/components/schemas/CardStatSpeed" }, "slug": { "description": "The card's URL-friendly slug.", "example": "crescent-glaive", "type": "string" }, "subtypes": { "description": "The card's subtypes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR", "POLEARM" ], "type": "array", "items": { "type": "string" } }, "types": { "description": "The card's types. The possible values are revealed by the `option/search` endpoint.", "example": [ "REGALIA", "WEAPON" ], "type": "array", "items": { "type": "string" } }, "uuid": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" } }, "additionalProperties": false, "required": [ "classes", "cost", "cost_memory", "cost_reserve", "created_at", "durability", "editions", "effect", "effect_html", "effect_raw", "element", "elements", "flavor", "last_update", "legality", "level", "life", "name", "power", "referenced_by", "references", "result_editions", "rule", "slug", "speed", "subtypes", "types", "uuid" ] } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "description": "Error message.", "type": "string" } }, "additionalProperties": false, "required": [ "error" ] } } } } } } }, "/cards/{slug}": { "get": { "operationId": "GetCardBySlugAPISpec_get_/{slug}", "tags": [ "Individual cards" ], "summary": "Get card by slug.", "description": "This returns a card matching the provided slug.", "parameters": [ { "description": "The card's URL-friendly slug.", "name": "slug", "in": "path", "required": true, "schema": { "example": "crescent-glaive", "type": "string" } } ], "responses": { "200": { "description": "The matching card.", "content": { "application/json": { "schema": { "description": "The matching card.", "type": "object", "properties": { "classes": { "description": "The card's classes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR" ], "type": "array", "items": { "type": "string" } }, "cost_memory": { "$ref": "#/components/schemas/CardCostMemory" }, "cost_reserve": { "$ref": "#/components/schemas/CardCostReserve" }, "cost": { "description": "The card's cost.", "type": "object", "properties": { "type": { "description": "The cost type.", "example": "memory", "enum": [ "memory", "none", "reserve" ], "type": "string" }, "value": { "description": "The cost value.\nThis is a number represented as a string, or a dynamic cost like `\"X\"`.\nThis is only `null` if the cost type is `\"none\"`.", "example": "1", "type": "string", "nullable": true } }, "additionalProperties": false, "required": [ "type", "value" ] }, "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "durability": { "$ref": "#/components/schemas/CardStatDurability" }, "editions": { "description": "A list of all editions this card is a parent of.", "type": "array", "items": { "description": "The Edition type describes a specific release of its parent Card.", "type": "object", "properties": { "card_id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "circulationTemplates": { "description": "Templated prints of this edition which are shared with other editions of this or any other card.", "type": "array", "items": { "$ref": "#/components/schemas/CirculationTemplate" } }, "circulations": { "description": "Non-templated prints of this edition which are not shared with other editions of any other card.", "example": [], "type": "array", "items": { "$ref": "#/components/schemas/Circulation" } }, "collaborators": { "description": "Collaborators that worked on the edition's artwork alongside the edition's illustrator.", "example": [], "type": "array", "items": { "type": "string" } }, "collector_number": { "description": "The edition's collector number in the set it belongs to.", "example": "010", "type": "string" }, "configuration": { "$ref": "#/components/schemas/EditionConfiguration" }, "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "effect": { "$ref": "#/components/schemas/EditionEffect" }, "effect_html": { "$ref": "#/components/schemas/EditionEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/EditionEffectRaw" }, "flavor": { "$ref": "#/components/schemas/EditionFlavor" }, "illustrator": { "$ref": "#/components/schemas/EditionIllustrator" }, "image": { "description": "An API image path (`/cards/images/example.jpg` implies `https://api.gatcg.com/cards/images/example.jpg`).", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "orientation": { "$ref": "#/components/schemas/EditionOrientation" }, "other_orientations": { "description": "Other orientations related to this edition.", "example": [], "type": "array", "items": { "description": "Other orientations that relate to this one. This will return the back face for editions with an `orientation` set to `\"front\"`, and vice versa.", "type": "object", "properties": { "classes": { "description": "The card's classes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR" ], "type": "array", "items": { "type": "string" } }, "cost": { "description": "The card's cost.", "type": "object", "properties": { "type": { "description": "The cost type.", "example": "memory", "enum": [ "memory", "none", "reserve" ], "type": "string" }, "value": { "description": "The cost value.\nThis is a number represented as a string, or a dynamic cost like `\"X\"`.\nThis is only `null` if the cost type is `\"none\"`.", "example": "1", "type": "string", "nullable": true } }, "additionalProperties": false, "required": [ "type", "value" ] }, "cost_memory": { "$ref": "#/components/schemas/CardCostMemory" }, "cost_reserve": { "$ref": "#/components/schemas/CardCostReserve" }, "created_at": { "type": "string", "format": "date-time" }, "durability": { "$ref": "#/components/schemas/CardStatDurability" }, "edition": { "type": "object", "properties": { "card_id": { "type": "string" }, "collaborators": { "type": "array", "items": { "type": "string" } }, "collector_number": { "type": "string" }, "configuration": { "$ref": "#/components/schemas/EditionConfiguration" }, "created_at": { "type": "string", "format": "date-time" }, "effect": { "$ref": "#/components/schemas/EditionEffect" }, "effect_html": { "$ref": "#/components/schemas/EditionEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/EditionEffectRaw" }, "flavor": { "$ref": "#/components/schemas/EditionFlavor" }, "illustrator": { "$ref": "#/components/schemas/EditionIllustrator" }, "image": { "type": "string" }, "last_update": { "type": "string", "format": "date-time" }, "orientation": { "$ref": "#/components/schemas/EditionOrientation" }, "rarity": { "type": "number" }, "set": { "type": "object", "properties": { "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "language": { "description": "The language used by the dataset.", "example": "EN", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "name": { "description": "The name of the set.", "example": "Mortal Ambition", "type": "string" }, "prefix": { "description": "The set's prefix as printed in the footer of its cards.", "example": "AMB", "type": "string" }, "release_date": { "description": "When the set was publicly-released.", "example": "2024-10-11T00:00:00", "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "created_at", "id", "language", "last_update", "name", "prefix", "release_date" ] }, "slug": { "type": "string" }, "thema_charm_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_grace_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_valor_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_charm_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_grace_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_nonfoil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_valor_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil_dynamic": { "type": "boolean" }, "thema_nonfoil_dynamic": { "type": "boolean" }, "uuid": { "type": "string" } }, "additionalProperties": false, "required": [ "card_id", "collaborators", "collector_number", "configuration", "created_at", "effect", "effect_html", "effect_raw", "flavor", "illustrator", "image", "last_update", "orientation", "rarity", "set", "slug", "thema_charm_foil", "thema_charm_nonfoil", "thema_ferocity_foil", "thema_ferocity_nonfoil", "thema_foil", "thema_foil_dynamic", "thema_grace_foil", "thema_grace_nonfoil", "thema_mystique_foil", "thema_mystique_nonfoil", "thema_nonfoil", "thema_nonfoil_dynamic", "thema_valor_foil", "thema_valor_nonfoil", "uuid" ] }, "edition_id": { "type": "string" }, "effect": { "$ref": "#/components/schemas/CardEffectTemplate" }, "effect_html": { "$ref": "#/components/schemas/CardEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/CardEffectRaw" }, "element": { "type": "string" }, "elements": { "type": "array", "items": { "type": "string" } }, "flavor": { "$ref": "#/components/schemas/CardFlavor" }, "last_update": { "type": "string", "format": "date-time" }, "level": { "$ref": "#/components/schemas/CardStatLevel" }, "life": { "$ref": "#/components/schemas/CardStatLife" }, "name": { "type": "string" }, "power": { "$ref": "#/components/schemas/CardStatPower" }, "slug": { "type": "string" }, "speed": { "$ref": "#/components/schemas/CardStatSpeed" }, "subtypes": { "description": "The card's subtypes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR", "POLEARM" ], "type": "array", "items": { "type": "string" } }, "types": { "description": "The card's types. The possible values are revealed by the `option/search` endpoint.", "example": [ "REGALIA", "WEAPON" ], "type": "array", "items": { "type": "string" } }, "uuid": { "type": "string" } }, "additionalProperties": false, "required": [ "classes", "cost", "cost_memory", "cost_reserve", "created_at", "durability", "edition", "edition_id", "effect", "effect_html", "effect_raw", "element", "elements", "flavor", "last_update", "level", "life", "name", "power", "slug", "speed", "subtypes", "types", "uuid" ] } }, "rarity": { "description": "The edition's rarity. The possible values are revealed by the `option/search` endpoint.", "example": 1, "type": "number" }, "slug": { "description": "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", "type": "string" }, "set": { "type": "object", "properties": { "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "language": { "description": "The language used by the dataset.", "example": "EN", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "name": { "description": "The name of the set.", "example": "Mortal Ambition", "type": "string" }, "prefix": { "description": "The set's prefix as printed in the footer of its cards.", "example": "AMB", "type": "string" }, "release_date": { "description": "When the set was publicly-released.", "example": "2024-10-11T00:00:00", "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "created_at", "id", "language", "last_update", "name", "prefix", "release_date" ] }, "thema_charm_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_grace_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_valor_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_charm_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_grace_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_nonfoil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_valor_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil_dynamic": { "description": "Determines if the Thema scores for the edition are dynamic.\nDynamic Thema scores update daily and are primarily used for added randomization in Path of Silver events.", "example": false, "type": "boolean" }, "thema_nonfoil_dynamic": { "description": "Determines if the Thema scores for the edition are dynamic.\nDynamic Thema scores update daily and are primarily used for added randomization in Path of Silver events.", "example": false, "type": "boolean" }, "uuid": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" } }, "additionalProperties": false, "required": [ "card_id", "circulationTemplates", "circulations", "collaborators", "collector_number", "configuration", "created_at", "effect", "effect_html", "effect_raw", "flavor", "illustrator", "image", "last_update", "orientation", "other_orientations", "rarity", "set", "slug", "thema_charm_foil", "thema_charm_nonfoil", "thema_ferocity_foil", "thema_ferocity_nonfoil", "thema_foil", "thema_foil_dynamic", "thema_grace_foil", "thema_grace_nonfoil", "thema_mystique_foil", "thema_mystique_nonfoil", "thema_nonfoil", "thema_nonfoil_dynamic", "thema_valor_foil", "thema_valor_nonfoil", "uuid" ] } }, "element": { "description": "The card's element. The possible values are revealed by the `option/search` endpoint.", "example": "WATER", "type": "string", "deprecated": true }, "elements": { "description": "The card's element(s). The possible values are revealed by the `option/search` endpoint.", "example": [ "WATER" ], "type": "array", "items": { "type": "string" } }, "effect": { "$ref": "#/components/schemas/CardEffectTemplate" }, "effect_html": { "$ref": "#/components/schemas/CardEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/CardEffectRaw" }, "flavor": { "$ref": "#/components/schemas/CardFlavor" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "legality": { "$ref": "#/components/schemas/CardLegality" }, "level": { "$ref": "#/components/schemas/CardStatLevel" }, "life": { "$ref": "#/components/schemas/CardStatLife" }, "name": { "description": "The card's name.", "example": "Crescent Glaive", "type": "string" }, "power": { "$ref": "#/components/schemas/CardStatPower" }, "referenced_by": { "description": "References made to this card by other cards.", "example": [], "type": "array", "items": { "type": "object", "properties": { "direction": { "type": "string", "enum": [ "FROM" ] }, "kind": { "$ref": "#/components/schemas/CardReferenceKind" }, "name": { "description": "The card's name.", "example": "Crescent Glaive", "type": "string" }, "slug": { "description": "The card's URL-friendly slug.", "example": "crescent-glaive", "type": "string" } }, "additionalProperties": false, "required": [ "direction", "kind", "name", "slug" ] } }, "references": { "description": "References this card makes to other cards.", "example": [], "type": "array", "items": { "type": "object", "properties": { "direction": { "type": "string", "enum": [ "TO" ] }, "kind": { "$ref": "#/components/schemas/CardReferenceKind" }, "name": { "description": "The card's name.", "example": "Crescent Glaive", "type": "string" }, "slug": { "description": "The card's URL-friendly slug.", "example": "crescent-glaive", "type": "string" } }, "additionalProperties": false, "required": [ "direction", "kind", "name", "slug" ] } }, "result_editions": { "description": "A list of all editions this card is a parent of which match the given query.", "type": "array", "items": { "description": "The Edition type describes a specific release of its parent Card.", "type": "object", "properties": { "card_id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "circulationTemplates": { "description": "Templated prints of this edition which are shared with other editions of this or any other card.", "type": "array", "items": { "$ref": "#/components/schemas/CirculationTemplate" } }, "circulations": { "description": "Non-templated prints of this edition which are not shared with other editions of any other card.", "example": [], "type": "array", "items": { "$ref": "#/components/schemas/Circulation" } }, "collaborators": { "description": "Collaborators that worked on the edition's artwork alongside the edition's illustrator.", "example": [], "type": "array", "items": { "type": "string" } }, "collector_number": { "description": "The edition's collector number in the set it belongs to.", "example": "010", "type": "string" }, "configuration": { "$ref": "#/components/schemas/EditionConfiguration" }, "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "effect": { "$ref": "#/components/schemas/EditionEffect" }, "effect_html": { "$ref": "#/components/schemas/EditionEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/EditionEffectRaw" }, "flavor": { "$ref": "#/components/schemas/EditionFlavor" }, "illustrator": { "$ref": "#/components/schemas/EditionIllustrator" }, "image": { "description": "An API image path (`/cards/images/example.jpg` implies `https://api.gatcg.com/cards/images/example.jpg`).", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "orientation": { "$ref": "#/components/schemas/EditionOrientation" }, "other_orientations": { "description": "Other orientations related to this edition.", "example": [], "type": "array", "items": { "description": "Other orientations that relate to this one. This will return the back face for editions with an `orientation` set to `\"front\"`, and vice versa.", "type": "object", "properties": { "classes": { "description": "The card's classes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR" ], "type": "array", "items": { "type": "string" } }, "cost": { "description": "The card's cost.", "type": "object", "properties": { "type": { "description": "The cost type.", "example": "memory", "enum": [ "memory", "none", "reserve" ], "type": "string" }, "value": { "description": "The cost value.\nThis is a number represented as a string, or a dynamic cost like `\"X\"`.\nThis is only `null` if the cost type is `\"none\"`.", "example": "1", "type": "string", "nullable": true } }, "additionalProperties": false, "required": [ "type", "value" ] }, "cost_memory": { "$ref": "#/components/schemas/CardCostMemory" }, "cost_reserve": { "$ref": "#/components/schemas/CardCostReserve" }, "created_at": { "type": "string", "format": "date-time" }, "durability": { "$ref": "#/components/schemas/CardStatDurability" }, "edition": { "type": "object", "properties": { "card_id": { "type": "string" }, "collaborators": { "type": "array", "items": { "type": "string" } }, "collector_number": { "type": "string" }, "configuration": { "$ref": "#/components/schemas/EditionConfiguration" }, "created_at": { "type": "string", "format": "date-time" }, "effect": { "$ref": "#/components/schemas/EditionEffect" }, "effect_html": { "$ref": "#/components/schemas/EditionEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/EditionEffectRaw" }, "flavor": { "$ref": "#/components/schemas/EditionFlavor" }, "illustrator": { "$ref": "#/components/schemas/EditionIllustrator" }, "image": { "type": "string" }, "last_update": { "type": "string", "format": "date-time" }, "orientation": { "$ref": "#/components/schemas/EditionOrientation" }, "rarity": { "type": "number" }, "set": { "type": "object", "properties": { "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "language": { "description": "The language used by the dataset.", "example": "EN", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "name": { "description": "The name of the set.", "example": "Mortal Ambition", "type": "string" }, "prefix": { "description": "The set's prefix as printed in the footer of its cards.", "example": "AMB", "type": "string" }, "release_date": { "description": "When the set was publicly-released.", "example": "2024-10-11T00:00:00", "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "created_at", "id", "language", "last_update", "name", "prefix", "release_date" ] }, "slug": { "type": "string" }, "thema_charm_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_grace_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_valor_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_charm_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_grace_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_nonfoil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_valor_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil_dynamic": { "type": "boolean" }, "thema_nonfoil_dynamic": { "type": "boolean" }, "uuid": { "type": "string" } }, "additionalProperties": false, "required": [ "card_id", "collaborators", "collector_number", "configuration", "created_at", "effect", "effect_html", "effect_raw", "flavor", "illustrator", "image", "last_update", "orientation", "rarity", "set", "slug", "thema_charm_foil", "thema_charm_nonfoil", "thema_ferocity_foil", "thema_ferocity_nonfoil", "thema_foil", "thema_foil_dynamic", "thema_grace_foil", "thema_grace_nonfoil", "thema_mystique_foil", "thema_mystique_nonfoil", "thema_nonfoil", "thema_nonfoil_dynamic", "thema_valor_foil", "thema_valor_nonfoil", "uuid" ] }, "edition_id": { "type": "string" }, "effect": { "$ref": "#/components/schemas/CardEffectTemplate" }, "effect_html": { "$ref": "#/components/schemas/CardEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/CardEffectRaw" }, "element": { "type": "string" }, "elements": { "type": "array", "items": { "type": "string" } }, "flavor": { "$ref": "#/components/schemas/CardFlavor" }, "last_update": { "type": "string", "format": "date-time" }, "level": { "$ref": "#/components/schemas/CardStatLevel" }, "life": { "$ref": "#/components/schemas/CardStatLife" }, "name": { "type": "string" }, "power": { "$ref": "#/components/schemas/CardStatPower" }, "slug": { "type": "string" }, "speed": { "$ref": "#/components/schemas/CardStatSpeed" }, "subtypes": { "description": "The card's subtypes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR", "POLEARM" ], "type": "array", "items": { "type": "string" } }, "types": { "description": "The card's types. The possible values are revealed by the `option/search` endpoint.", "example": [ "REGALIA", "WEAPON" ], "type": "array", "items": { "type": "string" } }, "uuid": { "type": "string" } }, "additionalProperties": false, "required": [ "classes", "cost", "cost_memory", "cost_reserve", "created_at", "durability", "edition", "edition_id", "effect", "effect_html", "effect_raw", "element", "elements", "flavor", "last_update", "level", "life", "name", "power", "slug", "speed", "subtypes", "types", "uuid" ] } }, "rarity": { "description": "The edition's rarity. The possible values are revealed by the `option/search` endpoint.", "example": 1, "type": "number" }, "slug": { "description": "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", "type": "string" }, "set": { "type": "object", "properties": { "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "language": { "description": "The language used by the dataset.", "example": "EN", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "name": { "description": "The name of the set.", "example": "Mortal Ambition", "type": "string" }, "prefix": { "description": "The set's prefix as printed in the footer of its cards.", "example": "AMB", "type": "string" }, "release_date": { "description": "When the set was publicly-released.", "example": "2024-10-11T00:00:00", "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "created_at", "id", "language", "last_update", "name", "prefix", "release_date" ] }, "thema_charm_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_grace_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_valor_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_charm_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_grace_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_nonfoil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_valor_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil_dynamic": { "description": "Determines if the Thema scores for the edition are dynamic.\nDynamic Thema scores update daily and are primarily used for added randomization in Path of Silver events.", "example": false, "type": "boolean" }, "thema_nonfoil_dynamic": { "description": "Determines if the Thema scores for the edition are dynamic.\nDynamic Thema scores update daily and are primarily used for added randomization in Path of Silver events.", "example": false, "type": "boolean" }, "uuid": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" } }, "additionalProperties": false, "required": [ "card_id", "circulationTemplates", "circulations", "collaborators", "collector_number", "configuration", "created_at", "effect", "effect_html", "effect_raw", "flavor", "illustrator", "image", "last_update", "orientation", "other_orientations", "rarity", "set", "slug", "thema_charm_foil", "thema_charm_nonfoil", "thema_ferocity_foil", "thema_ferocity_nonfoil", "thema_foil", "thema_foil_dynamic", "thema_grace_foil", "thema_grace_nonfoil", "thema_mystique_foil", "thema_mystique_nonfoil", "thema_nonfoil", "thema_nonfoil_dynamic", "thema_valor_foil", "thema_valor_nonfoil", "uuid" ] } }, "rule": { "description": "Additional rules and erratas the card is subject to.", "example": [], "type": "array", "items": { "type": "object", "properties": { "date_added": { "type": "string" }, "description": { "type": "string" }, "title": { "type": "string" } }, "additionalProperties": false, "required": [ "date_added", "description", "title" ] } }, "speed": { "$ref": "#/components/schemas/CardStatSpeed" }, "slug": { "description": "The card's URL-friendly slug.", "example": "crescent-glaive", "type": "string" }, "subtypes": { "description": "The card's subtypes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR", "POLEARM" ], "type": "array", "items": { "type": "string" } }, "types": { "description": "The card's types. The possible values are revealed by the `option/search` endpoint.", "example": [ "REGALIA", "WEAPON" ], "type": "array", "items": { "type": "string" } }, "uuid": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" } }, "additionalProperties": false, "required": [ "classes", "cost", "cost_memory", "cost_reserve", "created_at", "durability", "editions", "effect", "effect_html", "effect_raw", "element", "elements", "flavor", "last_update", "legality", "level", "life", "name", "power", "referenced_by", "references", "result_editions", "rule", "slug", "speed", "subtypes", "types", "uuid" ] } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "description": "Error message.", "type": "string" } }, "additionalProperties": false, "required": [ "error" ] } } } } } } }, "/cards/all": { "get": { "operationId": "GetAllCardsAPISpec_get_/cards/all", "tags": [ "Multiple cards" ], "summary": "Get a list of all card names and their associated slugs.", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "name": { "description": "The card's name.", "example": "Crescent Glaive", "type": "string" }, "slug": { "description": "The card's URL-friendly slug.", "example": "crescent-glaive", "type": "string" }, "uuid": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" } }, "additionalProperties": false, "required": [ "name", "slug", "uuid" ] } } } } } } } }, "/cards/autocomplete": { "get": { "operationId": "AutocompleteAPISpec_get_/autocomplete", "tags": [ "Multiple cards" ], "summary": "Quick card search.", "description": "This returns a list of up to 10 cards which match the given query.", "parameters": [ { "description": "A partial card name to search with.", "name": "name", "in": "query", "required": true, "schema": { "example": "Glaive", "type": "string" } } ], "responses": { "200": { "description": "A list of matching cards.", "content": { "application/json": { "schema": { "description": "A list of matching cards.", "type": "array", "items": { "type": "object", "properties": { "classes": { "description": "The card's classes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR" ], "type": "array", "items": { "type": "string" } }, "editions": { "type": "array", "items": { "description": "A simplified Edition response.", "type": "object", "properties": { "card_id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "collector_number": { "description": "The edition's collector number in the set it belongs to.", "example": "010", "type": "string" }, "effect": { "$ref": "#/components/schemas/EditionEffect" }, "effect_raw": { "$ref": "#/components/schemas/EditionEffectRaw" }, "flavor": { "$ref": "#/components/schemas/EditionFlavor" }, "illustrator": { "$ref": "#/components/schemas/EditionIllustrator" }, "rarity": { "description": "The edition's rarity. The possible values are revealed by the `option/search` endpoint.", "example": 1, "type": "number" }, "slug": { "description": "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", "type": "string" }, "uuid": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" } }, "additionalProperties": false, "required": [ "card_id", "collector_number", "effect", "effect_raw", "flavor", "illustrator", "rarity", "slug", "uuid" ] } }, "name": { "description": "The card's name.", "example": "Crescent Glaive", "type": "string" }, "slug": { "description": "The card's URL-friendly slug.", "example": "crescent-glaive", "type": "string" }, "subtypes": { "description": "The card's subtypes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR", "POLEARM" ], "type": "array", "items": { "type": "string" } }, "types": { "description": "The card's types. The possible values are revealed by the `option/search` endpoint.", "example": [ "REGALIA", "WEAPON" ], "type": "array", "items": { "type": "string" } }, "uuid": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" } }, "additionalProperties": false, "required": [ "classes", "editions", "name", "slug", "subtypes", "types", "uuid" ] } } } } } } } }, "/cards/edition/{edition_uuid}/dynamic-thema": { "get": { "operationId": "GetEditionDynamicThemaHistoryAPISpec_get_/edition/{edition_uuid}/dynamic-thema", "tags": [ "Thema scores" ], "summary": "Dynamic Thema history.", "description": "This returns up to 1 year worth of dynamic thema score history for a given edition and circulation kind.", "parameters": [ { "description": "A 10-character alphanumeric UUID.", "name": "edition_uuid", "in": "path", "required": true, "schema": { "example": "abcde12345", "type": "string" } }, { "name": "kind", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CirculationKind" } }, { "description": "The start date for the dynamic thema score history.\nIf provided alongside a `to` date, the range must be no greater than 1 year.\nIf no `to` date is provided, the `to` date will be defaulted to 1 year after the specified `from` date.\nDefaults to 1 year before the current date if not provided.", "name": "from", "in": "query", "required": false, "schema": { "format": "date", "type": "string", "example": "2023-03-30" } }, { "description": "The end date for the dynamic thema score history.\nIf provided alongside a `from` date, the range must be no greater than 1 year.\nIf no `from` date is provided, the `from` date will be defaulted to 1 year before the specified `to` date.\nDefaults to the current date if not provided.", "name": "to", "in": "query", "required": false, "schema": { "format": "date", "type": "string", "example": "2023-03-30" } } ], "responses": { "200": { "description": "A list of dynamic thema score history for the specified edition and circulation kind.", "content": { "application/json": { "schema": { "description": "A list of dynamic thema score history for the specified edition and circulation kind.", "type": "array", "items": { "type": "object", "properties": { "uuid": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "kind": { "$ref": "#/components/schemas/CirculationKind" }, "thema_total": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_charm": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_grace": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_valor": { "$ref": "#/components/schemas/EditionThemaScore" }, "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "rank": { "description": "The overall rank of the edition's total thema scores on the given created at date in relation to other editions with dynamic thema scores.", "example": 16, "type": "number" }, "rank_change": { "description": "The change in the edition's overall rank compared to its previous rank in the dataset.\nA positive number represents a rise in rank, whilst a negative number represents a fall in rank.", "example": -2, "type": "number" }, "change": { "description": "The percent change in the edition's total thema score compared to its previous total thema score in the dataset.\nA positive number represents an increase in total thema score, whilst a negative number represents a decrease in total thema score.", "example": 0.13, "type": "number" } }, "additionalProperties": false, "required": [ "change", "created_at", "kind", "rank", "rank_change", "thema_charm", "thema_ferocity", "thema_grace", "thema_mystique", "thema_total", "thema_valor", "uuid" ] } } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "description": "Error message.", "type": "string" } }, "additionalProperties": false, "required": [ "error" ] } } } } } } }, "/cards/edition/{edition_slug_or_uuid}": { "get": { "operationId": "GetCardByEditionSlugAPISpec_get_/edition/{edition_slug_or_uuid}", "tags": [ "Individual cards" ], "summary": "Get card by edition slug or edition UUID.", "description": "This returns a card with an edition matching the provided edition slug or UUID.", "parameters": [ { "name": "edition_slug_or_uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The matching card.", "content": { "application/json": { "schema": { "description": "The matching card.", "type": "object", "properties": { "classes": { "description": "The card's classes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR" ], "type": "array", "items": { "type": "string" } }, "cost_memory": { "$ref": "#/components/schemas/CardCostMemory" }, "cost_reserve": { "$ref": "#/components/schemas/CardCostReserve" }, "cost": { "description": "The card's cost.", "type": "object", "properties": { "type": { "description": "The cost type.", "example": "memory", "enum": [ "memory", "none", "reserve" ], "type": "string" }, "value": { "description": "The cost value.\nThis is a number represented as a string, or a dynamic cost like `\"X\"`.\nThis is only `null` if the cost type is `\"none\"`.", "example": "1", "type": "string", "nullable": true } }, "additionalProperties": false, "required": [ "type", "value" ] }, "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "durability": { "$ref": "#/components/schemas/CardStatDurability" }, "editions": { "description": "A list of all editions this card is a parent of.", "type": "array", "items": { "description": "The Edition type describes a specific release of its parent Card.", "type": "object", "properties": { "card_id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "circulationTemplates": { "description": "Templated prints of this edition which are shared with other editions of this or any other card.", "type": "array", "items": { "$ref": "#/components/schemas/CirculationTemplate" } }, "circulations": { "description": "Non-templated prints of this edition which are not shared with other editions of any other card.", "example": [], "type": "array", "items": { "$ref": "#/components/schemas/Circulation" } }, "collaborators": { "description": "Collaborators that worked on the edition's artwork alongside the edition's illustrator.", "example": [], "type": "array", "items": { "type": "string" } }, "collector_number": { "description": "The edition's collector number in the set it belongs to.", "example": "010", "type": "string" }, "configuration": { "$ref": "#/components/schemas/EditionConfiguration" }, "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "effect": { "$ref": "#/components/schemas/EditionEffect" }, "effect_html": { "$ref": "#/components/schemas/EditionEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/EditionEffectRaw" }, "flavor": { "$ref": "#/components/schemas/EditionFlavor" }, "illustrator": { "$ref": "#/components/schemas/EditionIllustrator" }, "image": { "description": "An API image path (`/cards/images/example.jpg` implies `https://api.gatcg.com/cards/images/example.jpg`).", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "orientation": { "$ref": "#/components/schemas/EditionOrientation" }, "other_orientations": { "description": "Other orientations related to this edition.", "example": [], "type": "array", "items": { "description": "Other orientations that relate to this one. This will return the back face for editions with an `orientation` set to `\"front\"`, and vice versa.", "type": "object", "properties": { "classes": { "description": "The card's classes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR" ], "type": "array", "items": { "type": "string" } }, "cost": { "description": "The card's cost.", "type": "object", "properties": { "type": { "description": "The cost type.", "example": "memory", "enum": [ "memory", "none", "reserve" ], "type": "string" }, "value": { "description": "The cost value.\nThis is a number represented as a string, or a dynamic cost like `\"X\"`.\nThis is only `null` if the cost type is `\"none\"`.", "example": "1", "type": "string", "nullable": true } }, "additionalProperties": false, "required": [ "type", "value" ] }, "cost_memory": { "$ref": "#/components/schemas/CardCostMemory" }, "cost_reserve": { "$ref": "#/components/schemas/CardCostReserve" }, "created_at": { "type": "string", "format": "date-time" }, "durability": { "$ref": "#/components/schemas/CardStatDurability" }, "edition": { "type": "object", "properties": { "card_id": { "type": "string" }, "collaborators": { "type": "array", "items": { "type": "string" } }, "collector_number": { "type": "string" }, "configuration": { "$ref": "#/components/schemas/EditionConfiguration" }, "created_at": { "type": "string", "format": "date-time" }, "effect": { "$ref": "#/components/schemas/EditionEffect" }, "effect_html": { "$ref": "#/components/schemas/EditionEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/EditionEffectRaw" }, "flavor": { "$ref": "#/components/schemas/EditionFlavor" }, "illustrator": { "$ref": "#/components/schemas/EditionIllustrator" }, "image": { "type": "string" }, "last_update": { "type": "string", "format": "date-time" }, "orientation": { "$ref": "#/components/schemas/EditionOrientation" }, "rarity": { "type": "number" }, "set": { "type": "object", "properties": { "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "language": { "description": "The language used by the dataset.", "example": "EN", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "name": { "description": "The name of the set.", "example": "Mortal Ambition", "type": "string" }, "prefix": { "description": "The set's prefix as printed in the footer of its cards.", "example": "AMB", "type": "string" }, "release_date": { "description": "When the set was publicly-released.", "example": "2024-10-11T00:00:00", "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "created_at", "id", "language", "last_update", "name", "prefix", "release_date" ] }, "slug": { "type": "string" }, "thema_charm_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_grace_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_valor_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_charm_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_grace_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_nonfoil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_valor_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil_dynamic": { "type": "boolean" }, "thema_nonfoil_dynamic": { "type": "boolean" }, "uuid": { "type": "string" } }, "additionalProperties": false, "required": [ "card_id", "collaborators", "collector_number", "configuration", "created_at", "effect", "effect_html", "effect_raw", "flavor", "illustrator", "image", "last_update", "orientation", "rarity", "set", "slug", "thema_charm_foil", "thema_charm_nonfoil", "thema_ferocity_foil", "thema_ferocity_nonfoil", "thema_foil", "thema_foil_dynamic", "thema_grace_foil", "thema_grace_nonfoil", "thema_mystique_foil", "thema_mystique_nonfoil", "thema_nonfoil", "thema_nonfoil_dynamic", "thema_valor_foil", "thema_valor_nonfoil", "uuid" ] }, "edition_id": { "type": "string" }, "effect": { "$ref": "#/components/schemas/CardEffectTemplate" }, "effect_html": { "$ref": "#/components/schemas/CardEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/CardEffectRaw" }, "element": { "type": "string" }, "elements": { "type": "array", "items": { "type": "string" } }, "flavor": { "$ref": "#/components/schemas/CardFlavor" }, "last_update": { "type": "string", "format": "date-time" }, "level": { "$ref": "#/components/schemas/CardStatLevel" }, "life": { "$ref": "#/components/schemas/CardStatLife" }, "name": { "type": "string" }, "power": { "$ref": "#/components/schemas/CardStatPower" }, "slug": { "type": "string" }, "speed": { "$ref": "#/components/schemas/CardStatSpeed" }, "subtypes": { "description": "The card's subtypes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR", "POLEARM" ], "type": "array", "items": { "type": "string" } }, "types": { "description": "The card's types. The possible values are revealed by the `option/search` endpoint.", "example": [ "REGALIA", "WEAPON" ], "type": "array", "items": { "type": "string" } }, "uuid": { "type": "string" } }, "additionalProperties": false, "required": [ "classes", "cost", "cost_memory", "cost_reserve", "created_at", "durability", "edition", "edition_id", "effect", "effect_html", "effect_raw", "element", "elements", "flavor", "last_update", "level", "life", "name", "power", "slug", "speed", "subtypes", "types", "uuid" ] } }, "rarity": { "description": "The edition's rarity. The possible values are revealed by the `option/search` endpoint.", "example": 1, "type": "number" }, "slug": { "description": "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", "type": "string" }, "set": { "type": "object", "properties": { "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "language": { "description": "The language used by the dataset.", "example": "EN", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "name": { "description": "The name of the set.", "example": "Mortal Ambition", "type": "string" }, "prefix": { "description": "The set's prefix as printed in the footer of its cards.", "example": "AMB", "type": "string" }, "release_date": { "description": "When the set was publicly-released.", "example": "2024-10-11T00:00:00", "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "created_at", "id", "language", "last_update", "name", "prefix", "release_date" ] }, "thema_charm_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_grace_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_valor_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_charm_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_grace_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_nonfoil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_valor_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil_dynamic": { "description": "Determines if the Thema scores for the edition are dynamic.\nDynamic Thema scores update daily and are primarily used for added randomization in Path of Silver events.", "example": false, "type": "boolean" }, "thema_nonfoil_dynamic": { "description": "Determines if the Thema scores for the edition are dynamic.\nDynamic Thema scores update daily and are primarily used for added randomization in Path of Silver events.", "example": false, "type": "boolean" }, "uuid": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" } }, "additionalProperties": false, "required": [ "card_id", "circulationTemplates", "circulations", "collaborators", "collector_number", "configuration", "created_at", "effect", "effect_html", "effect_raw", "flavor", "illustrator", "image", "last_update", "orientation", "other_orientations", "rarity", "set", "slug", "thema_charm_foil", "thema_charm_nonfoil", "thema_ferocity_foil", "thema_ferocity_nonfoil", "thema_foil", "thema_foil_dynamic", "thema_grace_foil", "thema_grace_nonfoil", "thema_mystique_foil", "thema_mystique_nonfoil", "thema_nonfoil", "thema_nonfoil_dynamic", "thema_valor_foil", "thema_valor_nonfoil", "uuid" ] } }, "element": { "description": "The card's element. The possible values are revealed by the `option/search` endpoint.", "example": "WATER", "type": "string", "deprecated": true }, "elements": { "description": "The card's element(s). The possible values are revealed by the `option/search` endpoint.", "example": [ "WATER" ], "type": "array", "items": { "type": "string" } }, "effect": { "$ref": "#/components/schemas/CardEffectTemplate" }, "effect_html": { "$ref": "#/components/schemas/CardEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/CardEffectRaw" }, "flavor": { "$ref": "#/components/schemas/CardFlavor" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "legality": { "$ref": "#/components/schemas/CardLegality" }, "level": { "$ref": "#/components/schemas/CardStatLevel" }, "life": { "$ref": "#/components/schemas/CardStatLife" }, "name": { "description": "The card's name.", "example": "Crescent Glaive", "type": "string" }, "power": { "$ref": "#/components/schemas/CardStatPower" }, "referenced_by": { "description": "References made to this card by other cards.", "example": [], "type": "array", "items": { "type": "object", "properties": { "direction": { "type": "string", "enum": [ "FROM" ] }, "kind": { "$ref": "#/components/schemas/CardReferenceKind" }, "name": { "description": "The card's name.", "example": "Crescent Glaive", "type": "string" }, "slug": { "description": "The card's URL-friendly slug.", "example": "crescent-glaive", "type": "string" } }, "additionalProperties": false, "required": [ "direction", "kind", "name", "slug" ] } }, "references": { "description": "References this card makes to other cards.", "example": [], "type": "array", "items": { "type": "object", "properties": { "direction": { "type": "string", "enum": [ "TO" ] }, "kind": { "$ref": "#/components/schemas/CardReferenceKind" }, "name": { "description": "The card's name.", "example": "Crescent Glaive", "type": "string" }, "slug": { "description": "The card's URL-friendly slug.", "example": "crescent-glaive", "type": "string" } }, "additionalProperties": false, "required": [ "direction", "kind", "name", "slug" ] } }, "result_editions": { "description": "A list of all editions this card is a parent of which match the given query.", "type": "array", "items": { "description": "The Edition type describes a specific release of its parent Card.", "type": "object", "properties": { "card_id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "circulationTemplates": { "description": "Templated prints of this edition which are shared with other editions of this or any other card.", "type": "array", "items": { "$ref": "#/components/schemas/CirculationTemplate" } }, "circulations": { "description": "Non-templated prints of this edition which are not shared with other editions of any other card.", "example": [], "type": "array", "items": { "$ref": "#/components/schemas/Circulation" } }, "collaborators": { "description": "Collaborators that worked on the edition's artwork alongside the edition's illustrator.", "example": [], "type": "array", "items": { "type": "string" } }, "collector_number": { "description": "The edition's collector number in the set it belongs to.", "example": "010", "type": "string" }, "configuration": { "$ref": "#/components/schemas/EditionConfiguration" }, "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "effect": { "$ref": "#/components/schemas/EditionEffect" }, "effect_html": { "$ref": "#/components/schemas/EditionEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/EditionEffectRaw" }, "flavor": { "$ref": "#/components/schemas/EditionFlavor" }, "illustrator": { "$ref": "#/components/schemas/EditionIllustrator" }, "image": { "description": "An API image path (`/cards/images/example.jpg` implies `https://api.gatcg.com/cards/images/example.jpg`).", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "orientation": { "$ref": "#/components/schemas/EditionOrientation" }, "other_orientations": { "description": "Other orientations related to this edition.", "example": [], "type": "array", "items": { "description": "Other orientations that relate to this one. This will return the back face for editions with an `orientation` set to `\"front\"`, and vice versa.", "type": "object", "properties": { "classes": { "description": "The card's classes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR" ], "type": "array", "items": { "type": "string" } }, "cost": { "description": "The card's cost.", "type": "object", "properties": { "type": { "description": "The cost type.", "example": "memory", "enum": [ "memory", "none", "reserve" ], "type": "string" }, "value": { "description": "The cost value.\nThis is a number represented as a string, or a dynamic cost like `\"X\"`.\nThis is only `null` if the cost type is `\"none\"`.", "example": "1", "type": "string", "nullable": true } }, "additionalProperties": false, "required": [ "type", "value" ] }, "cost_memory": { "$ref": "#/components/schemas/CardCostMemory" }, "cost_reserve": { "$ref": "#/components/schemas/CardCostReserve" }, "created_at": { "type": "string", "format": "date-time" }, "durability": { "$ref": "#/components/schemas/CardStatDurability" }, "edition": { "type": "object", "properties": { "card_id": { "type": "string" }, "collaborators": { "type": "array", "items": { "type": "string" } }, "collector_number": { "type": "string" }, "configuration": { "$ref": "#/components/schemas/EditionConfiguration" }, "created_at": { "type": "string", "format": "date-time" }, "effect": { "$ref": "#/components/schemas/EditionEffect" }, "effect_html": { "$ref": "#/components/schemas/EditionEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/EditionEffectRaw" }, "flavor": { "$ref": "#/components/schemas/EditionFlavor" }, "illustrator": { "$ref": "#/components/schemas/EditionIllustrator" }, "image": { "type": "string" }, "last_update": { "type": "string", "format": "date-time" }, "orientation": { "$ref": "#/components/schemas/EditionOrientation" }, "rarity": { "type": "number" }, "set": { "type": "object", "properties": { "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "language": { "description": "The language used by the dataset.", "example": "EN", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "name": { "description": "The name of the set.", "example": "Mortal Ambition", "type": "string" }, "prefix": { "description": "The set's prefix as printed in the footer of its cards.", "example": "AMB", "type": "string" }, "release_date": { "description": "When the set was publicly-released.", "example": "2024-10-11T00:00:00", "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "created_at", "id", "language", "last_update", "name", "prefix", "release_date" ] }, "slug": { "type": "string" }, "thema_charm_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_grace_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_valor_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_charm_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_grace_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_nonfoil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_valor_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil_dynamic": { "type": "boolean" }, "thema_nonfoil_dynamic": { "type": "boolean" }, "uuid": { "type": "string" } }, "additionalProperties": false, "required": [ "card_id", "collaborators", "collector_number", "configuration", "created_at", "effect", "effect_html", "effect_raw", "flavor", "illustrator", "image", "last_update", "orientation", "rarity", "set", "slug", "thema_charm_foil", "thema_charm_nonfoil", "thema_ferocity_foil", "thema_ferocity_nonfoil", "thema_foil", "thema_foil_dynamic", "thema_grace_foil", "thema_grace_nonfoil", "thema_mystique_foil", "thema_mystique_nonfoil", "thema_nonfoil", "thema_nonfoil_dynamic", "thema_valor_foil", "thema_valor_nonfoil", "uuid" ] }, "edition_id": { "type": "string" }, "effect": { "$ref": "#/components/schemas/CardEffectTemplate" }, "effect_html": { "$ref": "#/components/schemas/CardEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/CardEffectRaw" }, "element": { "type": "string" }, "elements": { "type": "array", "items": { "type": "string" } }, "flavor": { "$ref": "#/components/schemas/CardFlavor" }, "last_update": { "type": "string", "format": "date-time" }, "level": { "$ref": "#/components/schemas/CardStatLevel" }, "life": { "$ref": "#/components/schemas/CardStatLife" }, "name": { "type": "string" }, "power": { "$ref": "#/components/schemas/CardStatPower" }, "slug": { "type": "string" }, "speed": { "$ref": "#/components/schemas/CardStatSpeed" }, "subtypes": { "description": "The card's subtypes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR", "POLEARM" ], "type": "array", "items": { "type": "string" } }, "types": { "description": "The card's types. The possible values are revealed by the `option/search` endpoint.", "example": [ "REGALIA", "WEAPON" ], "type": "array", "items": { "type": "string" } }, "uuid": { "type": "string" } }, "additionalProperties": false, "required": [ "classes", "cost", "cost_memory", "cost_reserve", "created_at", "durability", "edition", "edition_id", "effect", "effect_html", "effect_raw", "element", "elements", "flavor", "last_update", "level", "life", "name", "power", "slug", "speed", "subtypes", "types", "uuid" ] } }, "rarity": { "description": "The edition's rarity. The possible values are revealed by the `option/search` endpoint.", "example": 1, "type": "number" }, "slug": { "description": "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", "type": "string" }, "set": { "type": "object", "properties": { "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "language": { "description": "The language used by the dataset.", "example": "EN", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "name": { "description": "The name of the set.", "example": "Mortal Ambition", "type": "string" }, "prefix": { "description": "The set's prefix as printed in the footer of its cards.", "example": "AMB", "type": "string" }, "release_date": { "description": "When the set was publicly-released.", "example": "2024-10-11T00:00:00", "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "created_at", "id", "language", "last_update", "name", "prefix", "release_date" ] }, "thema_charm_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_grace_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_valor_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_charm_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_grace_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_nonfoil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_valor_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil_dynamic": { "description": "Determines if the Thema scores for the edition are dynamic.\nDynamic Thema scores update daily and are primarily used for added randomization in Path of Silver events.", "example": false, "type": "boolean" }, "thema_nonfoil_dynamic": { "description": "Determines if the Thema scores for the edition are dynamic.\nDynamic Thema scores update daily and are primarily used for added randomization in Path of Silver events.", "example": false, "type": "boolean" }, "uuid": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" } }, "additionalProperties": false, "required": [ "card_id", "circulationTemplates", "circulations", "collaborators", "collector_number", "configuration", "created_at", "effect", "effect_html", "effect_raw", "flavor", "illustrator", "image", "last_update", "orientation", "other_orientations", "rarity", "set", "slug", "thema_charm_foil", "thema_charm_nonfoil", "thema_ferocity_foil", "thema_ferocity_nonfoil", "thema_foil", "thema_foil_dynamic", "thema_grace_foil", "thema_grace_nonfoil", "thema_mystique_foil", "thema_mystique_nonfoil", "thema_nonfoil", "thema_nonfoil_dynamic", "thema_valor_foil", "thema_valor_nonfoil", "uuid" ] } }, "rule": { "description": "Additional rules and erratas the card is subject to.", "example": [], "type": "array", "items": { "type": "object", "properties": { "date_added": { "type": "string" }, "description": { "type": "string" }, "title": { "type": "string" } }, "additionalProperties": false, "required": [ "date_added", "description", "title" ] } }, "speed": { "$ref": "#/components/schemas/CardStatSpeed" }, "slug": { "description": "The card's URL-friendly slug.", "example": "crescent-glaive", "type": "string" }, "subtypes": { "description": "The card's subtypes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR", "POLEARM" ], "type": "array", "items": { "type": "string" } }, "types": { "description": "The card's types. The possible values are revealed by the `option/search` endpoint.", "example": [ "REGALIA", "WEAPON" ], "type": "array", "items": { "type": "string" } }, "uuid": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" } }, "additionalProperties": false, "required": [ "classes", "cost", "cost_memory", "cost_reserve", "created_at", "durability", "editions", "effect", "effect_html", "effect_raw", "element", "elements", "flavor", "last_update", "legality", "level", "life", "name", "power", "referenced_by", "references", "result_editions", "rule", "slug", "speed", "subtypes", "types", "uuid" ] } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "description": "Error message.", "type": "string" } }, "additionalProperties": false, "required": [ "error" ] } } } } } } }, "/cards/edition/dynamic-thema-ranks": { "get": { "operationId": "GetEditionsWithRankedDynamicThemaScoresAPISpec_get_/edition/dynamic-thema-ranks", "tags": [ "Thema scores" ], "summary": "Dynamic Thema rankings.", "description": "This returns the latest dynamic thema rankings for editions which have dynamic thema scores enabled.", "parameters": [ { "description": "A 10-character alphanumeric UUID.", "name": "uuid", "in": "query", "required": false, "schema": { "example": "abcde12345", "type": "string" } }, { "name": "kind", "in": "query", "required": false, "schema": { "enum": [ "FOIL", "NONFOIL" ], "type": "string" } } ], "responses": { "200": { "description": "A list of ranked dynamic thema score editions.", "content": { "application/json": { "schema": { "description": "A list of ranked dynamic thema score editions.", "type": "array", "items": { "type": "object", "properties": { "score": { "$ref": "#/components/schemas/Omit_EditionThemaRanked__kind___uuid___created_at__" }, "kind": { "$ref": "#/components/schemas/CirculationKind" }, "classes": { "description": "The card's classes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR" ], "type": "array", "items": { "type": "string" } }, "cost": { "description": "The card's cost.", "type": "object", "properties": { "type": { "description": "The cost type.", "example": "memory", "enum": [ "memory", "none", "reserve" ], "type": "string" }, "value": { "description": "The cost value.\nThis is a number represented as a string, or a dynamic cost like `\"X\"`.\nThis is only `null` if the cost type is `\"none\"`.", "example": "1", "type": "string", "nullable": true } }, "additionalProperties": false, "required": [ "type", "value" ] }, "cost_memory": { "$ref": "#/components/schemas/CardCostMemory" }, "cost_reserve": { "$ref": "#/components/schemas/CardCostReserve" }, "created_at": { "type": "string", "format": "date-time" }, "durability": { "$ref": "#/components/schemas/CardStatDurability" }, "effect": { "$ref": "#/components/schemas/CardEffectTemplate" }, "effect_raw": { "$ref": "#/components/schemas/CardEffectRaw" }, "element": { "type": "string" }, "elements": { "type": "array", "items": { "type": "string" } }, "flavor": { "$ref": "#/components/schemas/CardFlavor" }, "last_update": { "type": "string", "format": "date-time" }, "level": { "$ref": "#/components/schemas/CardStatLevel" }, "life": { "$ref": "#/components/schemas/CardStatLife" }, "name": { "type": "string" }, "power": { "$ref": "#/components/schemas/CardStatPower" }, "slug": { "type": "string" }, "speed": { "$ref": "#/components/schemas/CardStatSpeed" }, "subtypes": { "description": "The card's subtypes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR", "POLEARM" ], "type": "array", "items": { "type": "string" } }, "types": { "description": "The card's types. The possible values are revealed by the `option/search` endpoint.", "example": [ "REGALIA", "WEAPON" ], "type": "array", "items": { "type": "string" } }, "uuid": { "type": "string" }, "edition": { "type": "object", "properties": { "card_id": { "type": "string" }, "collaborators": { "type": "array", "items": { "type": "string" } }, "collector_number": { "type": "string" }, "configuration": { "$ref": "#/components/schemas/EditionConfiguration" }, "created_at": { "type": "string", "format": "date-time" }, "effect": { "$ref": "#/components/schemas/EditionEffect" }, "effect_raw": { "$ref": "#/components/schemas/EditionEffectRaw" }, "flavor": { "$ref": "#/components/schemas/EditionFlavor" }, "illustrator": { "$ref": "#/components/schemas/EditionIllustrator" }, "image": { "type": "string" }, "last_update": { "type": "string", "format": "date-time" }, "orientation": { "$ref": "#/components/schemas/EditionOrientation" }, "rarity": { "type": "number" }, "set": { "type": "object", "properties": { "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "language": { "description": "The language used by the dataset.", "example": "EN", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "name": { "description": "The name of the set.", "example": "Mortal Ambition", "type": "string" }, "prefix": { "description": "The set's prefix as printed in the footer of its cards.", "example": "AMB", "type": "string" }, "release_date": { "description": "When the set was publicly-released.", "example": "2024-10-11T00:00:00", "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "created_at", "id", "language", "last_update", "name", "prefix", "release_date" ] }, "slug": { "type": "string" }, "thema_foil_dynamic": { "type": "boolean" }, "thema_nonfoil_dynamic": { "type": "boolean" }, "uuid": { "type": "string" } }, "additionalProperties": false, "required": [ "card_id", "collaborators", "collector_number", "configuration", "created_at", "effect", "effect_raw", "flavor", "illustrator", "image", "last_update", "orientation", "rarity", "set", "slug", "thema_foil_dynamic", "thema_nonfoil_dynamic", "uuid" ] } }, "additionalProperties": false, "required": [ "classes", "cost", "cost_memory", "cost_reserve", "created_at", "durability", "edition", "effect", "effect_raw", "element", "elements", "flavor", "kind", "last_update", "level", "life", "name", "power", "score", "slug", "speed", "subtypes", "types", "uuid" ] } } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "description": "Error message.", "type": "string" } }, "additionalProperties": false, "required": [ "error" ] } } } } } } }, "/cards/images/{filename}": { "get": { "operationId": "GetCardImageAPISpec_get_/cards/images/{filename}", "tags": [ "Individual cards", "Images" ], "summary": "Get a card edition's image.", "parameters": [ { "description": "The filename to download.", "name": "filename", "in": "path", "required": true, "schema": { "example": "lorraine-wandering-warrior-doap.jpg", "type": "string" } }, { "description": "Round the corners of the image. Note that whilst the request remains as `.jpg` the output file type will be `.png` instead.", "name": "rounded", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Image file.", "content": { "application/json": { "schema": { "items": { "type": "string", "format": "binary" }, "description": "Image file.", "type": "array" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "description": "Error message.", "type": "string" } }, "additionalProperties": false, "required": [ "error" ] } } } } } } }, "/cards/random": { "get": { "operationId": "GetRandomCardsAPISpec_get_/cards/random", "tags": [ "Multiple cards" ], "summary": "Get random cards.", "parameters": [ { "description": "Quantity of random cards to return.", "name": "amount", "in": "query", "required": false, "schema": { "default": 8, "minimum": 1, "maximum": 50, "type": "number" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "description": "The Card type describes a uniquely-named card, with child Edition types denoting different releases.", "type": "object", "properties": { "classes": { "description": "The card's classes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR" ], "type": "array", "items": { "type": "string" } }, "cost_memory": { "$ref": "#/components/schemas/CardCostMemory" }, "cost_reserve": { "$ref": "#/components/schemas/CardCostReserve" }, "cost": { "description": "The card's cost.", "type": "object", "properties": { "type": { "description": "The cost type.", "example": "memory", "enum": [ "memory", "none", "reserve" ], "type": "string" }, "value": { "description": "The cost value.\nThis is a number represented as a string, or a dynamic cost like `\"X\"`.\nThis is only `null` if the cost type is `\"none\"`.", "example": "1", "type": "string", "nullable": true } }, "additionalProperties": false, "required": [ "type", "value" ] }, "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "durability": { "$ref": "#/components/schemas/CardStatDurability" }, "editions": { "description": "A list of all editions this card is a parent of.", "type": "array", "items": { "description": "The Edition type describes a specific release of its parent Card.", "type": "object", "properties": { "card_id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "circulationTemplates": { "description": "Templated prints of this edition which are shared with other editions of this or any other card.", "type": "array", "items": { "$ref": "#/components/schemas/CirculationTemplate" } }, "circulations": { "description": "Non-templated prints of this edition which are not shared with other editions of any other card.", "example": [], "type": "array", "items": { "$ref": "#/components/schemas/Circulation" } }, "collaborators": { "description": "Collaborators that worked on the edition's artwork alongside the edition's illustrator.", "example": [], "type": "array", "items": { "type": "string" } }, "collector_number": { "description": "The edition's collector number in the set it belongs to.", "example": "010", "type": "string" }, "configuration": { "$ref": "#/components/schemas/EditionConfiguration" }, "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "effect": { "$ref": "#/components/schemas/EditionEffect" }, "effect_html": { "$ref": "#/components/schemas/EditionEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/EditionEffectRaw" }, "flavor": { "$ref": "#/components/schemas/EditionFlavor" }, "illustrator": { "$ref": "#/components/schemas/EditionIllustrator" }, "image": { "description": "An API image path (`/cards/images/example.jpg` implies `https://api.gatcg.com/cards/images/example.jpg`).", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "orientation": { "$ref": "#/components/schemas/EditionOrientation" }, "other_orientations": { "description": "Other orientations related to this edition.", "example": [], "type": "array", "items": { "description": "Other orientations that relate to this one. This will return the back face for editions with an `orientation` set to `\"front\"`, and vice versa.", "type": "object", "properties": { "classes": { "description": "The card's classes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR" ], "type": "array", "items": { "type": "string" } }, "cost": { "description": "The card's cost.", "type": "object", "properties": { "type": { "description": "The cost type.", "example": "memory", "enum": [ "memory", "none", "reserve" ], "type": "string" }, "value": { "description": "The cost value.\nThis is a number represented as a string, or a dynamic cost like `\"X\"`.\nThis is only `null` if the cost type is `\"none\"`.", "example": "1", "type": "string", "nullable": true } }, "additionalProperties": false, "required": [ "type", "value" ] }, "cost_memory": { "$ref": "#/components/schemas/CardCostMemory" }, "cost_reserve": { "$ref": "#/components/schemas/CardCostReserve" }, "created_at": { "type": "string", "format": "date-time" }, "durability": { "$ref": "#/components/schemas/CardStatDurability" }, "edition": { "type": "object", "properties": { "card_id": { "type": "string" }, "collaborators": { "type": "array", "items": { "type": "string" } }, "collector_number": { "type": "string" }, "configuration": { "$ref": "#/components/schemas/EditionConfiguration" }, "created_at": { "type": "string", "format": "date-time" }, "effect": { "$ref": "#/components/schemas/EditionEffect" }, "effect_html": { "$ref": "#/components/schemas/EditionEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/EditionEffectRaw" }, "flavor": { "$ref": "#/components/schemas/EditionFlavor" }, "illustrator": { "$ref": "#/components/schemas/EditionIllustrator" }, "image": { "type": "string" }, "last_update": { "type": "string", "format": "date-time" }, "orientation": { "$ref": "#/components/schemas/EditionOrientation" }, "rarity": { "type": "number" }, "set": { "type": "object", "properties": { "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "language": { "description": "The language used by the dataset.", "example": "EN", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "name": { "description": "The name of the set.", "example": "Mortal Ambition", "type": "string" }, "prefix": { "description": "The set's prefix as printed in the footer of its cards.", "example": "AMB", "type": "string" }, "release_date": { "description": "When the set was publicly-released.", "example": "2024-10-11T00:00:00", "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "created_at", "id", "language", "last_update", "name", "prefix", "release_date" ] }, "slug": { "type": "string" }, "thema_charm_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_grace_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_valor_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_charm_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_grace_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_nonfoil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_valor_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil_dynamic": { "type": "boolean" }, "thema_nonfoil_dynamic": { "type": "boolean" }, "uuid": { "type": "string" } }, "additionalProperties": false, "required": [ "card_id", "collaborators", "collector_number", "configuration", "created_at", "effect", "effect_html", "effect_raw", "flavor", "illustrator", "image", "last_update", "orientation", "rarity", "set", "slug", "thema_charm_foil", "thema_charm_nonfoil", "thema_ferocity_foil", "thema_ferocity_nonfoil", "thema_foil", "thema_foil_dynamic", "thema_grace_foil", "thema_grace_nonfoil", "thema_mystique_foil", "thema_mystique_nonfoil", "thema_nonfoil", "thema_nonfoil_dynamic", "thema_valor_foil", "thema_valor_nonfoil", "uuid" ] }, "edition_id": { "type": "string" }, "effect": { "$ref": "#/components/schemas/CardEffectTemplate" }, "effect_html": { "$ref": "#/components/schemas/CardEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/CardEffectRaw" }, "element": { "type": "string" }, "elements": { "type": "array", "items": { "type": "string" } }, "flavor": { "$ref": "#/components/schemas/CardFlavor" }, "last_update": { "type": "string", "format": "date-time" }, "level": { "$ref": "#/components/schemas/CardStatLevel" }, "life": { "$ref": "#/components/schemas/CardStatLife" }, "name": { "type": "string" }, "power": { "$ref": "#/components/schemas/CardStatPower" }, "slug": { "type": "string" }, "speed": { "$ref": "#/components/schemas/CardStatSpeed" }, "subtypes": { "description": "The card's subtypes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR", "POLEARM" ], "type": "array", "items": { "type": "string" } }, "types": { "description": "The card's types. The possible values are revealed by the `option/search` endpoint.", "example": [ "REGALIA", "WEAPON" ], "type": "array", "items": { "type": "string" } }, "uuid": { "type": "string" } }, "additionalProperties": false, "required": [ "classes", "cost", "cost_memory", "cost_reserve", "created_at", "durability", "edition", "edition_id", "effect", "effect_html", "effect_raw", "element", "elements", "flavor", "last_update", "level", "life", "name", "power", "slug", "speed", "subtypes", "types", "uuid" ] } }, "rarity": { "description": "The edition's rarity. The possible values are revealed by the `option/search` endpoint.", "example": 1, "type": "number" }, "slug": { "description": "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", "type": "string" }, "set": { "type": "object", "properties": { "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "language": { "description": "The language used by the dataset.", "example": "EN", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "name": { "description": "The name of the set.", "example": "Mortal Ambition", "type": "string" }, "prefix": { "description": "The set's prefix as printed in the footer of its cards.", "example": "AMB", "type": "string" }, "release_date": { "description": "When the set was publicly-released.", "example": "2024-10-11T00:00:00", "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "created_at", "id", "language", "last_update", "name", "prefix", "release_date" ] }, "thema_charm_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_grace_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_valor_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_charm_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_grace_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_nonfoil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_valor_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil_dynamic": { "description": "Determines if the Thema scores for the edition are dynamic.\nDynamic Thema scores update daily and are primarily used for added randomization in Path of Silver events.", "example": false, "type": "boolean" }, "thema_nonfoil_dynamic": { "description": "Determines if the Thema scores for the edition are dynamic.\nDynamic Thema scores update daily and are primarily used for added randomization in Path of Silver events.", "example": false, "type": "boolean" }, "uuid": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" } }, "additionalProperties": false, "required": [ "card_id", "circulationTemplates", "circulations", "collaborators", "collector_number", "configuration", "created_at", "effect", "effect_html", "effect_raw", "flavor", "illustrator", "image", "last_update", "orientation", "other_orientations", "rarity", "set", "slug", "thema_charm_foil", "thema_charm_nonfoil", "thema_ferocity_foil", "thema_ferocity_nonfoil", "thema_foil", "thema_foil_dynamic", "thema_grace_foil", "thema_grace_nonfoil", "thema_mystique_foil", "thema_mystique_nonfoil", "thema_nonfoil", "thema_nonfoil_dynamic", "thema_valor_foil", "thema_valor_nonfoil", "uuid" ] } }, "element": { "description": "The card's element. The possible values are revealed by the `option/search` endpoint.", "example": "WATER", "type": "string", "deprecated": true }, "elements": { "description": "The card's element(s). The possible values are revealed by the `option/search` endpoint.", "example": [ "WATER" ], "type": "array", "items": { "type": "string" } }, "effect": { "$ref": "#/components/schemas/CardEffectTemplate" }, "effect_html": { "$ref": "#/components/schemas/CardEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/CardEffectRaw" }, "flavor": { "$ref": "#/components/schemas/CardFlavor" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "legality": { "$ref": "#/components/schemas/CardLegality" }, "level": { "$ref": "#/components/schemas/CardStatLevel" }, "life": { "$ref": "#/components/schemas/CardStatLife" }, "name": { "description": "The card's name.", "example": "Crescent Glaive", "type": "string" }, "power": { "$ref": "#/components/schemas/CardStatPower" }, "referenced_by": { "description": "References made to this card by other cards.", "example": [], "type": "array", "items": { "type": "object", "properties": { "direction": { "type": "string", "enum": [ "FROM" ] }, "kind": { "$ref": "#/components/schemas/CardReferenceKind" }, "name": { "description": "The card's name.", "example": "Crescent Glaive", "type": "string" }, "slug": { "description": "The card's URL-friendly slug.", "example": "crescent-glaive", "type": "string" } }, "additionalProperties": false, "required": [ "direction", "kind", "name", "slug" ] } }, "references": { "description": "References this card makes to other cards.", "example": [], "type": "array", "items": { "type": "object", "properties": { "direction": { "type": "string", "enum": [ "TO" ] }, "kind": { "$ref": "#/components/schemas/CardReferenceKind" }, "name": { "description": "The card's name.", "example": "Crescent Glaive", "type": "string" }, "slug": { "description": "The card's URL-friendly slug.", "example": "crescent-glaive", "type": "string" } }, "additionalProperties": false, "required": [ "direction", "kind", "name", "slug" ] } }, "result_editions": { "description": "A list of all editions this card is a parent of which match the given query.", "type": "array", "items": { "description": "The Edition type describes a specific release of its parent Card.", "type": "object", "properties": { "card_id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "circulationTemplates": { "description": "Templated prints of this edition which are shared with other editions of this or any other card.", "type": "array", "items": { "$ref": "#/components/schemas/CirculationTemplate" } }, "circulations": { "description": "Non-templated prints of this edition which are not shared with other editions of any other card.", "example": [], "type": "array", "items": { "$ref": "#/components/schemas/Circulation" } }, "collaborators": { "description": "Collaborators that worked on the edition's artwork alongside the edition's illustrator.", "example": [], "type": "array", "items": { "type": "string" } }, "collector_number": { "description": "The edition's collector number in the set it belongs to.", "example": "010", "type": "string" }, "configuration": { "$ref": "#/components/schemas/EditionConfiguration" }, "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "effect": { "$ref": "#/components/schemas/EditionEffect" }, "effect_html": { "$ref": "#/components/schemas/EditionEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/EditionEffectRaw" }, "flavor": { "$ref": "#/components/schemas/EditionFlavor" }, "illustrator": { "$ref": "#/components/schemas/EditionIllustrator" }, "image": { "description": "An API image path (`/cards/images/example.jpg` implies `https://api.gatcg.com/cards/images/example.jpg`).", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "orientation": { "$ref": "#/components/schemas/EditionOrientation" }, "other_orientations": { "description": "Other orientations related to this edition.", "example": [], "type": "array", "items": { "description": "Other orientations that relate to this one. This will return the back face for editions with an `orientation` set to `\"front\"`, and vice versa.", "type": "object", "properties": { "classes": { "description": "The card's classes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR" ], "type": "array", "items": { "type": "string" } }, "cost": { "description": "The card's cost.", "type": "object", "properties": { "type": { "description": "The cost type.", "example": "memory", "enum": [ "memory", "none", "reserve" ], "type": "string" }, "value": { "description": "The cost value.\nThis is a number represented as a string, or a dynamic cost like `\"X\"`.\nThis is only `null` if the cost type is `\"none\"`.", "example": "1", "type": "string", "nullable": true } }, "additionalProperties": false, "required": [ "type", "value" ] }, "cost_memory": { "$ref": "#/components/schemas/CardCostMemory" }, "cost_reserve": { "$ref": "#/components/schemas/CardCostReserve" }, "created_at": { "type": "string", "format": "date-time" }, "durability": { "$ref": "#/components/schemas/CardStatDurability" }, "edition": { "type": "object", "properties": { "card_id": { "type": "string" }, "collaborators": { "type": "array", "items": { "type": "string" } }, "collector_number": { "type": "string" }, "configuration": { "$ref": "#/components/schemas/EditionConfiguration" }, "created_at": { "type": "string", "format": "date-time" }, "effect": { "$ref": "#/components/schemas/EditionEffect" }, "effect_html": { "$ref": "#/components/schemas/EditionEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/EditionEffectRaw" }, "flavor": { "$ref": "#/components/schemas/EditionFlavor" }, "illustrator": { "$ref": "#/components/schemas/EditionIllustrator" }, "image": { "type": "string" }, "last_update": { "type": "string", "format": "date-time" }, "orientation": { "$ref": "#/components/schemas/EditionOrientation" }, "rarity": { "type": "number" }, "set": { "type": "object", "properties": { "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "language": { "description": "The language used by the dataset.", "example": "EN", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "name": { "description": "The name of the set.", "example": "Mortal Ambition", "type": "string" }, "prefix": { "description": "The set's prefix as printed in the footer of its cards.", "example": "AMB", "type": "string" }, "release_date": { "description": "When the set was publicly-released.", "example": "2024-10-11T00:00:00", "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "created_at", "id", "language", "last_update", "name", "prefix", "release_date" ] }, "slug": { "type": "string" }, "thema_charm_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_grace_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_valor_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_charm_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_grace_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_nonfoil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_valor_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil_dynamic": { "type": "boolean" }, "thema_nonfoil_dynamic": { "type": "boolean" }, "uuid": { "type": "string" } }, "additionalProperties": false, "required": [ "card_id", "collaborators", "collector_number", "configuration", "created_at", "effect", "effect_html", "effect_raw", "flavor", "illustrator", "image", "last_update", "orientation", "rarity", "set", "slug", "thema_charm_foil", "thema_charm_nonfoil", "thema_ferocity_foil", "thema_ferocity_nonfoil", "thema_foil", "thema_foil_dynamic", "thema_grace_foil", "thema_grace_nonfoil", "thema_mystique_foil", "thema_mystique_nonfoil", "thema_nonfoil", "thema_nonfoil_dynamic", "thema_valor_foil", "thema_valor_nonfoil", "uuid" ] }, "edition_id": { "type": "string" }, "effect": { "$ref": "#/components/schemas/CardEffectTemplate" }, "effect_html": { "$ref": "#/components/schemas/CardEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/CardEffectRaw" }, "element": { "type": "string" }, "elements": { "type": "array", "items": { "type": "string" } }, "flavor": { "$ref": "#/components/schemas/CardFlavor" }, "last_update": { "type": "string", "format": "date-time" }, "level": { "$ref": "#/components/schemas/CardStatLevel" }, "life": { "$ref": "#/components/schemas/CardStatLife" }, "name": { "type": "string" }, "power": { "$ref": "#/components/schemas/CardStatPower" }, "slug": { "type": "string" }, "speed": { "$ref": "#/components/schemas/CardStatSpeed" }, "subtypes": { "description": "The card's subtypes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR", "POLEARM" ], "type": "array", "items": { "type": "string" } }, "types": { "description": "The card's types. The possible values are revealed by the `option/search` endpoint.", "example": [ "REGALIA", "WEAPON" ], "type": "array", "items": { "type": "string" } }, "uuid": { "type": "string" } }, "additionalProperties": false, "required": [ "classes", "cost", "cost_memory", "cost_reserve", "created_at", "durability", "edition", "edition_id", "effect", "effect_html", "effect_raw", "element", "elements", "flavor", "last_update", "level", "life", "name", "power", "slug", "speed", "subtypes", "types", "uuid" ] } }, "rarity": { "description": "The edition's rarity. The possible values are revealed by the `option/search` endpoint.", "example": 1, "type": "number" }, "slug": { "description": "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", "type": "string" }, "set": { "type": "object", "properties": { "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "language": { "description": "The language used by the dataset.", "example": "EN", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "name": { "description": "The name of the set.", "example": "Mortal Ambition", "type": "string" }, "prefix": { "description": "The set's prefix as printed in the footer of its cards.", "example": "AMB", "type": "string" }, "release_date": { "description": "When the set was publicly-released.", "example": "2024-10-11T00:00:00", "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "created_at", "id", "language", "last_update", "name", "prefix", "release_date" ] }, "thema_charm_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_grace_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_valor_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_charm_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_grace_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_nonfoil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_valor_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil_dynamic": { "description": "Determines if the Thema scores for the edition are dynamic.\nDynamic Thema scores update daily and are primarily used for added randomization in Path of Silver events.", "example": false, "type": "boolean" }, "thema_nonfoil_dynamic": { "description": "Determines if the Thema scores for the edition are dynamic.\nDynamic Thema scores update daily and are primarily used for added randomization in Path of Silver events.", "example": false, "type": "boolean" }, "uuid": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" } }, "additionalProperties": false, "required": [ "card_id", "circulationTemplates", "circulations", "collaborators", "collector_number", "configuration", "created_at", "effect", "effect_html", "effect_raw", "flavor", "illustrator", "image", "last_update", "orientation", "other_orientations", "rarity", "set", "slug", "thema_charm_foil", "thema_charm_nonfoil", "thema_ferocity_foil", "thema_ferocity_nonfoil", "thema_foil", "thema_foil_dynamic", "thema_grace_foil", "thema_grace_nonfoil", "thema_mystique_foil", "thema_mystique_nonfoil", "thema_nonfoil", "thema_nonfoil_dynamic", "thema_valor_foil", "thema_valor_nonfoil", "uuid" ] } }, "rule": { "description": "Additional rules and erratas the card is subject to.", "example": [], "type": "array", "items": { "type": "object", "properties": { "date_added": { "type": "string" }, "description": { "type": "string" }, "title": { "type": "string" } }, "additionalProperties": false, "required": [ "date_added", "description", "title" ] } }, "speed": { "$ref": "#/components/schemas/CardStatSpeed" }, "slug": { "description": "The card's URL-friendly slug.", "example": "crescent-glaive", "type": "string" }, "subtypes": { "description": "The card's subtypes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR", "POLEARM" ], "type": "array", "items": { "type": "string" } }, "types": { "description": "The card's types. The possible values are revealed by the `option/search` endpoint.", "example": [ "REGALIA", "WEAPON" ], "type": "array", "items": { "type": "string" } }, "uuid": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" } }, "additionalProperties": false, "required": [ "classes", "cost", "cost_memory", "cost_reserve", "created_at", "durability", "editions", "effect", "effect_html", "effect_raw", "element", "elements", "flavor", "last_update", "legality", "level", "life", "name", "power", "referenced_by", "references", "result_editions", "rule", "slug", "speed", "subtypes", "types", "uuid" ] } } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "description": "Error message.", "type": "string" } }, "additionalProperties": false, "required": [ "error" ] } } } } } } }, "/cards/search": { "get": { "operationId": "GetCardsAPISpec_get_/search", "tags": [ "Multiple cards" ], "summary": "Find cards.", "description": "This returns cards matching the provided query parameters.", "parameters": [ { "description": "Get cards with any `class` value included in this list.", "name": "class", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "description": "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.", "name": "class_logic", "in": "query", "required": false, "schema": { "default": "OR", "enum": [ "AND", "OR" ], "type": "string" } }, { "description": "Include or exclude editions which have collaborators.", "name": "collab", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "description": "Get a card with an edition's `collector_number` that exactly matches this string.", "name": "collector_number", "in": "query", "required": false, "schema": { "type": "string" } }, { "description": "Find cards using a specific configuration.", "name": "configuration", "in": "query", "required": false, "schema": { "example": "flip", "enum": [ "default", "flip" ], "type": "string" } }, { "description": "Get a card with an edition's `effect_raw` that is similar to this string.", "name": "edition_effect", "in": "query", "required": false, "schema": { "type": "string" } }, { "description": "Get a card with an edition's `flavor` that is similar to this string.", "name": "edition_flavor", "in": "query", "required": false, "schema": { "type": "string" } }, { "description": "Get a card with an edition's `last_update` date greater than this value.", "name": "edition_last_update", "in": "query", "required": false, "schema": { "format": "date", "type": "string", "example": "2023-03-30" } }, { "description": "Get a card with an edition's `slug` that exactly matches this string.", "name": "edition_slug", "in": "query", "required": false, "schema": { "type": "string" } }, { "description": "Get a card with `effect_raw` or edition `effect_raw` that is similar to this string.", "name": "effect", "in": "query", "required": false, "schema": { "type": "string" } }, { "description": "Get cards with any `elements` value included in this list. `\\\"null\\\"` can be used to match cards with no element.", "name": "element", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "description": "Use this to adjust how cards are targeted by the `element` query parameter. `OR` includes any card which includes one or more of the `elements` values, whilst `AND` only matches cards that include all of the specified `elements` values.", "name": "element_logic", "in": "query", "required": false, "schema": { "default": "OR", "enum": [ "AND", "OR" ], "type": "string" } }, { "description": "Get a card with a `flavor` that is similar to this string.", "name": "flavor", "in": "query", "required": false, "schema": { "type": "string" } }, { "description": "Get a card with an edition's `illustrator` that exactly matches this string. `\"null\"` can be used to match cards with no illustrator.", "name": "illustrator", "in": "query", "required": false, "schema": { "type": "string" } }, { "description": "Get a card with an edition's set's `language` that exactly matches this string.", "name": "language", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "description": "Get a card with a `last_update` date greater than this value.", "name": "last_update", "in": "query", "required": false, "schema": { "format": "date", "type": "string", "example": "2023-03-30" } }, { "description": "Used in parallel with `legality_limit`, specify which game format to target.", "name": "legality_format", "in": "query", "required": false, "schema": { "enum": [ "DRAFT", "PANTHEON", "STANDARD" ], "type": "string" } }, { "description": "Used in parallel with `legality_format`, specify an exact card limit.", "name": "legality_limit", "in": "query", "required": false, "schema": { "type": "number" } }, { "description": "Used in parallel with `legality_format`, specify whether a card is legal or restricted.\nThis is ignored if `legality_limit` is specified.", "name": "legality_state", "in": "query", "required": false, "schema": { "default": "ANY", "enum": [ "ANY", "LEGAL", "RESTRICTED" ], "type": "string" } }, { "description": "Get a card with a `name` that is similar to this string.", "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "description": "Specify the order to return the matching results in.", "name": "order", "in": "query", "required": false, "schema": { "default": "ASC", "enum": [ "ASC", "DESC" ], "type": "string" } }, { "description": "Move to a specific `page` of results.", "name": "page", "in": "query", "required": false, "schema": { "default": 1, "minimum": 1, "type": "number" } }, { "description": "Specify how many results to include per page.", "name": "page_size", "in": "query", "required": false, "schema": { "default": 50, "maximum": 50, "minimum": 1, "type": "number" } }, { "description": "Get a cards with any edition's set's `prefix` included in this list.", "name": "prefix", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "description": "Get a card with an edition's `rarity` that exactly matches this number.", "name": "rarity", "in": "query", "required": false, "schema": { "type": "number" } }, { "description": "Get a card with a `rule` whose `title` or `description` contains this case-insensitive string.", "name": "rule", "in": "query", "required": false, "schema": { "type": "string" } }, { "description": "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.", "name": "rule_title", "in": "query", "required": false, "schema": { "type": "string" } }, { "description": "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.", "name": "separate_editions", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "description": "Get a card with a `slug` that exactly matches this string.", "name": "slug", "in": "query", "required": false, "schema": { "type": "string" } }, { "description": "Get a card by its speed stat.", "name": "speed", "in": "query", "required": false, "schema": { "type": "array", "items": { "enum": [ "fast", "none", "slow" ], "type": "string" } } }, { "description": "Get a card whose numeric stats are contained within a semicolon-delimited list of values.", "name": "stats", "in": "query", "required": false, "schema": { "type": "string" } }, { "description": "Specify the primary card or edition field the results are sorted by.", "name": "sort", "in": "query", "required": false, "schema": { "default": "collector_number", "enum": [ "collector_number", "cost_memory", "cost_reserve", "durability", "level", "life", "name", "power", "rarity" ], "type": "string" } }, { "description": "Get cards with any `subtype` value included in this list.", "name": "subtype", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "description": "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.", "name": "subtype_logic", "in": "query", "required": false, "schema": { "default": "OR", "enum": [ "AND", "OR" ], "type": "string" } }, { "description": "Get cards with any `type` value included in this list.", "name": "type", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "description": "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.", "name": "type_logic", "in": "query", "required": false, "schema": { "default": "OR", "enum": [ "AND", "OR" ], "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "A list of matching cards.", "type": "array", "items": { "description": "The Card type describes a uniquely-named card, with child Edition types denoting different releases.", "type": "object", "properties": { "classes": { "description": "The card's classes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR" ], "type": "array", "items": { "type": "string" } }, "cost_memory": { "$ref": "#/components/schemas/CardCostMemory" }, "cost_reserve": { "$ref": "#/components/schemas/CardCostReserve" }, "cost": { "description": "The card's cost.", "type": "object", "properties": { "type": { "description": "The cost type.", "example": "memory", "enum": [ "memory", "none", "reserve" ], "type": "string" }, "value": { "description": "The cost value.\nThis is a number represented as a string, or a dynamic cost like `\"X\"`.\nThis is only `null` if the cost type is `\"none\"`.", "example": "1", "type": "string", "nullable": true } }, "additionalProperties": false, "required": [ "type", "value" ] }, "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "durability": { "$ref": "#/components/schemas/CardStatDurability" }, "editions": { "description": "A list of all editions this card is a parent of.", "type": "array", "items": { "description": "The Edition type describes a specific release of its parent Card.", "type": "object", "properties": { "card_id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "circulationTemplates": { "description": "Templated prints of this edition which are shared with other editions of this or any other card.", "type": "array", "items": { "$ref": "#/components/schemas/CirculationTemplate" } }, "circulations": { "description": "Non-templated prints of this edition which are not shared with other editions of any other card.", "example": [], "type": "array", "items": { "$ref": "#/components/schemas/Circulation" } }, "collaborators": { "description": "Collaborators that worked on the edition's artwork alongside the edition's illustrator.", "example": [], "type": "array", "items": { "type": "string" } }, "collector_number": { "description": "The edition's collector number in the set it belongs to.", "example": "010", "type": "string" }, "configuration": { "$ref": "#/components/schemas/EditionConfiguration" }, "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "effect": { "$ref": "#/components/schemas/EditionEffect" }, "effect_html": { "$ref": "#/components/schemas/EditionEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/EditionEffectRaw" }, "flavor": { "$ref": "#/components/schemas/EditionFlavor" }, "illustrator": { "$ref": "#/components/schemas/EditionIllustrator" }, "image": { "description": "An API image path (`/cards/images/example.jpg` implies `https://api.gatcg.com/cards/images/example.jpg`).", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "orientation": { "$ref": "#/components/schemas/EditionOrientation" }, "other_orientations": { "description": "Other orientations related to this edition.", "example": [], "type": "array", "items": { "description": "Other orientations that relate to this one. This will return the back face for editions with an `orientation` set to `\"front\"`, and vice versa.", "type": "object", "properties": { "classes": { "description": "The card's classes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR" ], "type": "array", "items": { "type": "string" } }, "cost": { "description": "The card's cost.", "type": "object", "properties": { "type": { "description": "The cost type.", "example": "memory", "enum": [ "memory", "none", "reserve" ], "type": "string" }, "value": { "description": "The cost value.\nThis is a number represented as a string, or a dynamic cost like `\"X\"`.\nThis is only `null` if the cost type is `\"none\"`.", "example": "1", "type": "string", "nullable": true } }, "additionalProperties": false, "required": [ "type", "value" ] }, "cost_memory": { "$ref": "#/components/schemas/CardCostMemory" }, "cost_reserve": { "$ref": "#/components/schemas/CardCostReserve" }, "created_at": { "type": "string", "format": "date-time" }, "durability": { "$ref": "#/components/schemas/CardStatDurability" }, "edition": { "type": "object", "properties": { "card_id": { "type": "string" }, "collaborators": { "type": "array", "items": { "type": "string" } }, "collector_number": { "type": "string" }, "configuration": { "$ref": "#/components/schemas/EditionConfiguration" }, "created_at": { "type": "string", "format": "date-time" }, "effect": { "$ref": "#/components/schemas/EditionEffect" }, "effect_html": { "$ref": "#/components/schemas/EditionEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/EditionEffectRaw" }, "flavor": { "$ref": "#/components/schemas/EditionFlavor" }, "illustrator": { "$ref": "#/components/schemas/EditionIllustrator" }, "image": { "type": "string" }, "last_update": { "type": "string", "format": "date-time" }, "orientation": { "$ref": "#/components/schemas/EditionOrientation" }, "rarity": { "type": "number" }, "set": { "type": "object", "properties": { "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "language": { "description": "The language used by the dataset.", "example": "EN", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "name": { "description": "The name of the set.", "example": "Mortal Ambition", "type": "string" }, "prefix": { "description": "The set's prefix as printed in the footer of its cards.", "example": "AMB", "type": "string" }, "release_date": { "description": "When the set was publicly-released.", "example": "2024-10-11T00:00:00", "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "created_at", "id", "language", "last_update", "name", "prefix", "release_date" ] }, "slug": { "type": "string" }, "thema_charm_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_grace_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_valor_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_charm_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_grace_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_nonfoil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_valor_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil_dynamic": { "type": "boolean" }, "thema_nonfoil_dynamic": { "type": "boolean" }, "uuid": { "type": "string" } }, "additionalProperties": false, "required": [ "card_id", "collaborators", "collector_number", "configuration", "created_at", "effect", "effect_html", "effect_raw", "flavor", "illustrator", "image", "last_update", "orientation", "rarity", "set", "slug", "thema_charm_foil", "thema_charm_nonfoil", "thema_ferocity_foil", "thema_ferocity_nonfoil", "thema_foil", "thema_foil_dynamic", "thema_grace_foil", "thema_grace_nonfoil", "thema_mystique_foil", "thema_mystique_nonfoil", "thema_nonfoil", "thema_nonfoil_dynamic", "thema_valor_foil", "thema_valor_nonfoil", "uuid" ] }, "edition_id": { "type": "string" }, "effect": { "$ref": "#/components/schemas/CardEffectTemplate" }, "effect_html": { "$ref": "#/components/schemas/CardEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/CardEffectRaw" }, "element": { "type": "string" }, "elements": { "type": "array", "items": { "type": "string" } }, "flavor": { "$ref": "#/components/schemas/CardFlavor" }, "last_update": { "type": "string", "format": "date-time" }, "level": { "$ref": "#/components/schemas/CardStatLevel" }, "life": { "$ref": "#/components/schemas/CardStatLife" }, "name": { "type": "string" }, "power": { "$ref": "#/components/schemas/CardStatPower" }, "slug": { "type": "string" }, "speed": { "$ref": "#/components/schemas/CardStatSpeed" }, "subtypes": { "description": "The card's subtypes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR", "POLEARM" ], "type": "array", "items": { "type": "string" } }, "types": { "description": "The card's types. The possible values are revealed by the `option/search` endpoint.", "example": [ "REGALIA", "WEAPON" ], "type": "array", "items": { "type": "string" } }, "uuid": { "type": "string" } }, "additionalProperties": false, "required": [ "classes", "cost", "cost_memory", "cost_reserve", "created_at", "durability", "edition", "edition_id", "effect", "effect_html", "effect_raw", "element", "elements", "flavor", "last_update", "level", "life", "name", "power", "slug", "speed", "subtypes", "types", "uuid" ] } }, "rarity": { "description": "The edition's rarity. The possible values are revealed by the `option/search` endpoint.", "example": 1, "type": "number" }, "slug": { "description": "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", "type": "string" }, "set": { "type": "object", "properties": { "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "language": { "description": "The language used by the dataset.", "example": "EN", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "name": { "description": "The name of the set.", "example": "Mortal Ambition", "type": "string" }, "prefix": { "description": "The set's prefix as printed in the footer of its cards.", "example": "AMB", "type": "string" }, "release_date": { "description": "When the set was publicly-released.", "example": "2024-10-11T00:00:00", "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "created_at", "id", "language", "last_update", "name", "prefix", "release_date" ] }, "thema_charm_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_grace_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_valor_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_charm_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_grace_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_nonfoil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_valor_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil_dynamic": { "description": "Determines if the Thema scores for the edition are dynamic.\nDynamic Thema scores update daily and are primarily used for added randomization in Path of Silver events.", "example": false, "type": "boolean" }, "thema_nonfoil_dynamic": { "description": "Determines if the Thema scores for the edition are dynamic.\nDynamic Thema scores update daily and are primarily used for added randomization in Path of Silver events.", "example": false, "type": "boolean" }, "uuid": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" } }, "additionalProperties": false, "required": [ "card_id", "circulationTemplates", "circulations", "collaborators", "collector_number", "configuration", "created_at", "effect", "effect_html", "effect_raw", "flavor", "illustrator", "image", "last_update", "orientation", "other_orientations", "rarity", "set", "slug", "thema_charm_foil", "thema_charm_nonfoil", "thema_ferocity_foil", "thema_ferocity_nonfoil", "thema_foil", "thema_foil_dynamic", "thema_grace_foil", "thema_grace_nonfoil", "thema_mystique_foil", "thema_mystique_nonfoil", "thema_nonfoil", "thema_nonfoil_dynamic", "thema_valor_foil", "thema_valor_nonfoil", "uuid" ] } }, "element": { "description": "The card's element. The possible values are revealed by the `option/search` endpoint.", "example": "WATER", "type": "string", "deprecated": true }, "elements": { "description": "The card's element(s). The possible values are revealed by the `option/search` endpoint.", "example": [ "WATER" ], "type": "array", "items": { "type": "string" } }, "effect": { "$ref": "#/components/schemas/CardEffectTemplate" }, "effect_html": { "$ref": "#/components/schemas/CardEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/CardEffectRaw" }, "flavor": { "$ref": "#/components/schemas/CardFlavor" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "legality": { "$ref": "#/components/schemas/CardLegality" }, "level": { "$ref": "#/components/schemas/CardStatLevel" }, "life": { "$ref": "#/components/schemas/CardStatLife" }, "name": { "description": "The card's name.", "example": "Crescent Glaive", "type": "string" }, "power": { "$ref": "#/components/schemas/CardStatPower" }, "referenced_by": { "description": "References made to this card by other cards.", "example": [], "type": "array", "items": { "type": "object", "properties": { "direction": { "type": "string", "enum": [ "FROM" ] }, "kind": { "$ref": "#/components/schemas/CardReferenceKind" }, "name": { "description": "The card's name.", "example": "Crescent Glaive", "type": "string" }, "slug": { "description": "The card's URL-friendly slug.", "example": "crescent-glaive", "type": "string" } }, "additionalProperties": false, "required": [ "direction", "kind", "name", "slug" ] } }, "references": { "description": "References this card makes to other cards.", "example": [], "type": "array", "items": { "type": "object", "properties": { "direction": { "type": "string", "enum": [ "TO" ] }, "kind": { "$ref": "#/components/schemas/CardReferenceKind" }, "name": { "description": "The card's name.", "example": "Crescent Glaive", "type": "string" }, "slug": { "description": "The card's URL-friendly slug.", "example": "crescent-glaive", "type": "string" } }, "additionalProperties": false, "required": [ "direction", "kind", "name", "slug" ] } }, "result_editions": { "description": "A list of all editions this card is a parent of which match the given query.", "type": "array", "items": { "description": "The Edition type describes a specific release of its parent Card.", "type": "object", "properties": { "card_id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "circulationTemplates": { "description": "Templated prints of this edition which are shared with other editions of this or any other card.", "type": "array", "items": { "$ref": "#/components/schemas/CirculationTemplate" } }, "circulations": { "description": "Non-templated prints of this edition which are not shared with other editions of any other card.", "example": [], "type": "array", "items": { "$ref": "#/components/schemas/Circulation" } }, "collaborators": { "description": "Collaborators that worked on the edition's artwork alongside the edition's illustrator.", "example": [], "type": "array", "items": { "type": "string" } }, "collector_number": { "description": "The edition's collector number in the set it belongs to.", "example": "010", "type": "string" }, "configuration": { "$ref": "#/components/schemas/EditionConfiguration" }, "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "effect": { "$ref": "#/components/schemas/EditionEffect" }, "effect_html": { "$ref": "#/components/schemas/EditionEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/EditionEffectRaw" }, "flavor": { "$ref": "#/components/schemas/EditionFlavor" }, "illustrator": { "$ref": "#/components/schemas/EditionIllustrator" }, "image": { "description": "An API image path (`/cards/images/example.jpg` implies `https://api.gatcg.com/cards/images/example.jpg`).", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "orientation": { "$ref": "#/components/schemas/EditionOrientation" }, "other_orientations": { "description": "Other orientations related to this edition.", "example": [], "type": "array", "items": { "description": "Other orientations that relate to this one. This will return the back face for editions with an `orientation` set to `\"front\"`, and vice versa.", "type": "object", "properties": { "classes": { "description": "The card's classes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR" ], "type": "array", "items": { "type": "string" } }, "cost": { "description": "The card's cost.", "type": "object", "properties": { "type": { "description": "The cost type.", "example": "memory", "enum": [ "memory", "none", "reserve" ], "type": "string" }, "value": { "description": "The cost value.\nThis is a number represented as a string, or a dynamic cost like `\"X\"`.\nThis is only `null` if the cost type is `\"none\"`.", "example": "1", "type": "string", "nullable": true } }, "additionalProperties": false, "required": [ "type", "value" ] }, "cost_memory": { "$ref": "#/components/schemas/CardCostMemory" }, "cost_reserve": { "$ref": "#/components/schemas/CardCostReserve" }, "created_at": { "type": "string", "format": "date-time" }, "durability": { "$ref": "#/components/schemas/CardStatDurability" }, "edition": { "type": "object", "properties": { "card_id": { "type": "string" }, "collaborators": { "type": "array", "items": { "type": "string" } }, "collector_number": { "type": "string" }, "configuration": { "$ref": "#/components/schemas/EditionConfiguration" }, "created_at": { "type": "string", "format": "date-time" }, "effect": { "$ref": "#/components/schemas/EditionEffect" }, "effect_html": { "$ref": "#/components/schemas/EditionEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/EditionEffectRaw" }, "flavor": { "$ref": "#/components/schemas/EditionFlavor" }, "illustrator": { "$ref": "#/components/schemas/EditionIllustrator" }, "image": { "type": "string" }, "last_update": { "type": "string", "format": "date-time" }, "orientation": { "$ref": "#/components/schemas/EditionOrientation" }, "rarity": { "type": "number" }, "set": { "type": "object", "properties": { "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "language": { "description": "The language used by the dataset.", "example": "EN", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "name": { "description": "The name of the set.", "example": "Mortal Ambition", "type": "string" }, "prefix": { "description": "The set's prefix as printed in the footer of its cards.", "example": "AMB", "type": "string" }, "release_date": { "description": "When the set was publicly-released.", "example": "2024-10-11T00:00:00", "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "created_at", "id", "language", "last_update", "name", "prefix", "release_date" ] }, "slug": { "type": "string" }, "thema_charm_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_grace_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_valor_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_charm_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_grace_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_nonfoil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_valor_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil_dynamic": { "type": "boolean" }, "thema_nonfoil_dynamic": { "type": "boolean" }, "uuid": { "type": "string" } }, "additionalProperties": false, "required": [ "card_id", "collaborators", "collector_number", "configuration", "created_at", "effect", "effect_html", "effect_raw", "flavor", "illustrator", "image", "last_update", "orientation", "rarity", "set", "slug", "thema_charm_foil", "thema_charm_nonfoil", "thema_ferocity_foil", "thema_ferocity_nonfoil", "thema_foil", "thema_foil_dynamic", "thema_grace_foil", "thema_grace_nonfoil", "thema_mystique_foil", "thema_mystique_nonfoil", "thema_nonfoil", "thema_nonfoil_dynamic", "thema_valor_foil", "thema_valor_nonfoil", "uuid" ] }, "edition_id": { "type": "string" }, "effect": { "$ref": "#/components/schemas/CardEffectTemplate" }, "effect_html": { "$ref": "#/components/schemas/CardEffectHTML" }, "effect_raw": { "$ref": "#/components/schemas/CardEffectRaw" }, "element": { "type": "string" }, "elements": { "type": "array", "items": { "type": "string" } }, "flavor": { "$ref": "#/components/schemas/CardFlavor" }, "last_update": { "type": "string", "format": "date-time" }, "level": { "$ref": "#/components/schemas/CardStatLevel" }, "life": { "$ref": "#/components/schemas/CardStatLife" }, "name": { "type": "string" }, "power": { "$ref": "#/components/schemas/CardStatPower" }, "slug": { "type": "string" }, "speed": { "$ref": "#/components/schemas/CardStatSpeed" }, "subtypes": { "description": "The card's subtypes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR", "POLEARM" ], "type": "array", "items": { "type": "string" } }, "types": { "description": "The card's types. The possible values are revealed by the `option/search` endpoint.", "example": [ "REGALIA", "WEAPON" ], "type": "array", "items": { "type": "string" } }, "uuid": { "type": "string" } }, "additionalProperties": false, "required": [ "classes", "cost", "cost_memory", "cost_reserve", "created_at", "durability", "edition", "edition_id", "effect", "effect_html", "effect_raw", "element", "elements", "flavor", "last_update", "level", "life", "name", "power", "slug", "speed", "subtypes", "types", "uuid" ] } }, "rarity": { "description": "The edition's rarity. The possible values are revealed by the `option/search` endpoint.", "example": 1, "type": "number" }, "slug": { "description": "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", "type": "string" }, "set": { "type": "object", "properties": { "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "language": { "description": "The language used by the dataset.", "example": "EN", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "name": { "description": "The name of the set.", "example": "Mortal Ambition", "type": "string" }, "prefix": { "description": "The set's prefix as printed in the footer of its cards.", "example": "AMB", "type": "string" }, "release_date": { "description": "When the set was publicly-released.", "example": "2024-10-11T00:00:00", "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "created_at", "id", "language", "last_update", "name", "prefix", "release_date" ] }, "thema_charm_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_grace_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_valor_foil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_charm_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_grace_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_nonfoil": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_valor_nonfoil": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_foil_dynamic": { "description": "Determines if the Thema scores for the edition are dynamic.\nDynamic Thema scores update daily and are primarily used for added randomization in Path of Silver events.", "example": false, "type": "boolean" }, "thema_nonfoil_dynamic": { "description": "Determines if the Thema scores for the edition are dynamic.\nDynamic Thema scores update daily and are primarily used for added randomization in Path of Silver events.", "example": false, "type": "boolean" }, "uuid": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" } }, "additionalProperties": false, "required": [ "card_id", "circulationTemplates", "circulations", "collaborators", "collector_number", "configuration", "created_at", "effect", "effect_html", "effect_raw", "flavor", "illustrator", "image", "last_update", "orientation", "other_orientations", "rarity", "set", "slug", "thema_charm_foil", "thema_charm_nonfoil", "thema_ferocity_foil", "thema_ferocity_nonfoil", "thema_foil", "thema_foil_dynamic", "thema_grace_foil", "thema_grace_nonfoil", "thema_mystique_foil", "thema_mystique_nonfoil", "thema_nonfoil", "thema_nonfoil_dynamic", "thema_valor_foil", "thema_valor_nonfoil", "uuid" ] } }, "rule": { "description": "Additional rules and erratas the card is subject to.", "example": [], "type": "array", "items": { "type": "object", "properties": { "date_added": { "type": "string" }, "description": { "type": "string" }, "title": { "type": "string" } }, "additionalProperties": false, "required": [ "date_added", "description", "title" ] } }, "speed": { "$ref": "#/components/schemas/CardStatSpeed" }, "slug": { "description": "The card's URL-friendly slug.", "example": "crescent-glaive", "type": "string" }, "subtypes": { "description": "The card's subtypes. The possible values are revealed by the `option/search` endpoint.", "example": [ "WARRIOR", "POLEARM" ], "type": "array", "items": { "type": "string" } }, "types": { "description": "The card's types. The possible values are revealed by the `option/search` endpoint.", "example": [ "REGALIA", "WEAPON" ], "type": "array", "items": { "type": "string" } }, "uuid": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" } }, "additionalProperties": false, "required": [ "classes", "cost", "cost_memory", "cost_reserve", "created_at", "durability", "editions", "effect", "effect_html", "effect_raw", "element", "elements", "flavor", "last_update", "legality", "level", "life", "name", "power", "referenced_by", "references", "result_editions", "rule", "slug", "speed", "subtypes", "types", "uuid" ] } }, "has_more": { "description": "Are there more pages beyond this one with results?", "example": false, "type": "boolean" }, "order": { "description": "The order the results are returned.", "example": "ASC", "enum": [ "ASC", "DESC" ], "type": "string" }, "page": { "description": "The current page.", "example": 1, "type": "number" }, "page_size": { "description": "The maximum number of results returned per page.", "example": 30, "maximum": 50, "minimum": 1, "type": "number" }, "paginated_cards_count": { "description": "The number of cards returned on this page.", "example": 1, "type": "number" }, "sort": { "description": "The primary field the results are sorted by.", "example": "collector_number", "enum": [ "collector_number", "cost_memory", "cost_reserve", "durability", "level", "life", "name", "power", "rarity" ], "type": "string" }, "total_cards": { "description": "The total result count across all pages.", "example": 1, "type": "number" }, "total_pages": { "description": "The total number of pages.", "example": 1, "type": "number" } }, "additionalProperties": false, "required": [ "data", "has_more", "order", "page", "page_size", "paginated_cards_count", "sort", "total_cards", "total_pages" ] } } } } } } }, "/changelog/list": { "get": { "operationId": "GetChangelogsAPISpec_get_/list", "tags": [ "Metadata" ], "summary": "List changelog entries.", "description": "This returns a list of API update changelog entries ordered by descending date.", "parameters": [ { "description": "Number of results to display.", "name": "limit", "in": "query", "required": false, "schema": { "default": 50, "minimum": 1, "maximum": 100, "type": "number" } } ], "responses": { "200": { "description": "A list of changelog entries ordered by descending date.", "content": { "application/json": { "schema": { "description": "A list of changelog entries ordered by descending date.", "type": "array", "items": { "type": "object", "properties": { "content": { "description": "A HTML description of the update with Index-specific links.", "example": "Added new set: Alchemical Revolution First Edition.", "type": "string" }, "date": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "uuid": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" } }, "additionalProperties": false, "required": [ "content", "date", "uuid" ] } } } } } } } }, "/featured-sets/images/{filename}": { "get": { "operationId": "GetFeaturedSetImageAPISpec_get_/featured-sets/images/{filename}", "tags": [ "Featured Sets", "Images" ], "summary": "Get featured set image.", "description": "This returns a featured set group's logo image.", "parameters": [ { "description": "The filename to download.", "name": "filename", "in": "path", "required": true, "schema": { "example": "AMB.png", "type": "string" } } ], "responses": { "200": { "description": "Image file.", "content": { "application/json": { "schema": { "items": { "type": "string", "format": "binary" }, "description": "Image file.", "type": "array" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "description": "Error message.", "type": "string" } }, "additionalProperties": false, "required": [ "error" ] } } } } } } }, "/featured-sets": { "get": { "operationId": "GetFeaturedSetsAPISpec_get_/featured-sets", "tags": [ "Featured Sets" ], "summary": "Get featured set groups.", "description": "This returns a list of featured set groups and the sets they contain.", "parameters": [], "responses": { "200": { "description": "A list of featured set groups.", "content": { "application/json": { "schema": { "description": "A list of featured set groups.", "type": "array", "items": { "type": "object", "properties": { "image": { "description": "An API image path (`/cards/images/example.jpg` implies `https://api.gatcg.com/cards/images/example.jpg`).", "type": "string" }, "name": { "description": "The name of the featured set group.", "example": "Alchemical Revolution", "type": "string" }, "sets": { "description": "The sets which belong to the featured set group.", "type": "array", "items": { "type": "object", "properties": { "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "language": { "description": "The language used by the dataset.", "example": "EN", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "name": { "description": "The name of the set.", "example": "Mortal Ambition", "type": "string" }, "prefix": { "description": "The set's prefix as printed in the footer of its cards.", "example": "AMB", "type": "string" }, "release_date": { "description": "When the set was publicly-released.", "example": "2024-10-11T00:00:00", "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "created_at", "id", "language", "last_update", "name", "prefix", "release_date" ] } }, "uuid": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" } }, "additionalProperties": false, "required": [ "image", "name", "sets", "uuid" ] } } } } } } } }, "/omnidex/events/{event_id}/decklists": { "get": { "operationId": "GetOmnidexEventDecklistsAPISpec_get_/events/{event_id}/decklists", "tags": [ "Omnidex" ], "summary": "Get an Omnidex event's decklists.", "description": "This returns public decklist data for the event (if available).", "parameters": [ { "name": "event_id", "in": "path", "required": true, "schema": { "example": 27292, "type": "number" } } ], "responses": { "200": { "description": "The matching event's team.", "content": { "application/json": { "schema": { "description": "The matching event's team.", "type": "array", "items": { "$ref": "#/components/schemas/OmnidexEventPlayerDecklist" } } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "description": "Error message.", "type": "string" } }, "additionalProperties": false, "required": [ "error" ] } } } } } } }, "/omnidex/events/{event_id}/judges": { "get": { "operationId": "GetOmnidexEventJudgesAPISpec_get_/events/{event_id}/judges", "tags": [ "Omnidex" ], "summary": "Get judges in an Omnidex event.", "description": "This returns a list of judges in the event.", "parameters": [ { "name": "event_id", "in": "path", "required": true, "schema": { "example": 27292, "type": "number" } } ], "responses": { "200": { "description": "The matching event's team.", "content": { "application/json": { "schema": { "description": "The matching event's team.", "type": "array", "items": { "$ref": "#/components/schemas/OmnidexEventJudge" } } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "description": "Error message.", "type": "string" } }, "additionalProperties": false, "required": [ "error" ] } } } } } } }, "/omnidex/events/{event_id}/pairings": { "get": { "operationId": "GetOmnidexEventSPairingsAPISpec_get_/events/{event_id}/pairings", "tags": [ "Omnidex" ], "summary": "Get an Omnidex event's pairings.", "description": "This returns pairings for an event. By default it returns the latest stage and round.", "parameters": [ { "name": "event_id", "in": "path", "required": true, "schema": { "example": 27292, "type": "number" } }, { "description": "A round ID.", "name": "round", "in": "query", "required": false, "schema": { "example": 1, "type": "number" } }, { "description": "A stage ID.", "name": "stage", "in": "query", "required": false, "schema": { "example": 1, "type": "number" } } ], "responses": { "200": { "description": "The matching event's pairings.", "content": { "application/json": { "schema": { "description": "The matching event's pairings.", "type": "object", "properties": { "pairings": { "type": "array", "items": { "$ref": "#/components/schemas/OmnidexEventMatch" } }, "round": { "$ref": "#/components/schemas/OmnidexEventRoundWithTimer" }, "stage": { "$ref": "#/components/schemas/OmnidexEventStage" } }, "additionalProperties": false, "required": [ "pairings", "round", "stage" ] } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "description": "Error message.", "type": "string" } }, "additionalProperties": false, "required": [ "error" ] } } } } } } }, "/omnidex/events/{event_id}/players": { "get": { "operationId": "GetOmnidexEventPlayersAPISpec_get_/events/{event_id}/players", "tags": [ "Omnidex" ], "summary": "Get players in an Omnidex event.", "description": "This returns a list of players participating in the event.", "parameters": [ { "name": "event_id", "in": "path", "required": true, "schema": { "example": 27292, "type": "number" } } ], "responses": { "200": { "description": "The matching event's team.", "content": { "application/json": { "schema": { "description": "The matching event's team.", "type": "array", "items": { "$ref": "#/components/schemas/OmnidexEventPlayer" } } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "description": "Error message.", "type": "string" } }, "additionalProperties": false, "required": [ "error" ] } } } } } } }, "/omnidex/events/{event_id}/round": { "get": { "operationId": "GetOmnidexEventRoundLatestAPISpec_get_/events/{event_id}/round", "tags": [ "Omnidex" ], "summary": "Get basic information about a round in an Omnidex event.", "description": "This returns basic info about a round in an Omnidex event. If no stage or round is specified, it returns the latest stage and round respectively.", "parameters": [ { "name": "event_id", "in": "path", "required": true, "schema": { "example": 27292, "type": "number" } }, { "description": "A round ID.", "name": "round", "in": "query", "required": false, "schema": { "example": 1, "type": "number" } }, { "description": "A stage ID.", "name": "stage", "in": "query", "required": false, "schema": { "example": 1, "type": "number" } } ], "responses": { "200": { "description": "The matching event's basic round and stage info.", "content": { "application/json": { "schema": { "description": "The matching event's basic round and stage info.", "type": "object", "properties": { "round": { "$ref": "#/components/schemas/OmnidexEventRoundWithTimer" }, "stage": { "$ref": "#/components/schemas/OmnidexEventStage" } }, "additionalProperties": false, "required": [ "round", "stage" ] } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "description": "Error message.", "type": "string" } }, "additionalProperties": false, "required": [ "error" ] } } } } } } }, "/omnidex/events/{event_id}": { "get": { "operationId": "GetOmnidexEventByIdAPISpec_get_/events/{event_id}", "tags": [ "Omnidex" ], "summary": "Get Omnidex event by ID.", "description": "This returns an Omnidex event matching the provided ID.", "parameters": [ { "name": "event_id", "in": "path", "required": true, "schema": { "example": 27292, "type": "number" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmnidexEvent", "description": "The matching event." } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "description": "Error message.", "type": "string" } }, "additionalProperties": false, "required": [ "error" ] } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "description": "Error message.", "type": "string" } }, "additionalProperties": false, "required": [ "error" ] } } } } } } }, "/omnidex/events/{event_id}/standings": { "get": { "operationId": "GetOmnidexEventStandingsAPISpec_get_/events/{event_id}/standings", "tags": [ "Omnidex" ], "summary": "Get an Omnidex event's standings.", "description": "This returns Swiss stage standings for the event.", "parameters": [ { "name": "event_id", "in": "path", "required": true, "schema": { "example": 27292, "type": "number" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmnidexEventStandings", "description": "The matching event's team." } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "description": "Error message.", "type": "string" } }, "additionalProperties": false, "required": [ "error" ] } } } } } } }, "/omnidex/events/{event_id}/statistics": { "get": { "operationId": "GetOmnidexEventStatisticsAPISpec_get_/events/{event_id}/statistics", "tags": [ "Omnidex" ], "summary": "Get statistics for an Omnidex event.", "description": "This returns public statistics data for an Omnidex event (if available).", "parameters": [ { "name": "event_id", "in": "path", "required": true, "schema": { "example": 27292, "type": "number" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmnidexEventStatistics", "description": "The matching event's statistics." } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "description": "Error message.", "type": "string" } }, "additionalProperties": false, "required": [ "error" ] } } } } } } }, "/omnidex/events/{event_id}/teams": { "get": { "operationId": "GetOmnidexEventTeamsAPISpec_get_/events/{event_id}/teams", "tags": [ "Omnidex" ], "summary": "Get teams in an Omnidex event.", "description": "This returns a list of teams participating in the event (if applicable).", "parameters": [ { "name": "event_id", "in": "path", "required": true, "schema": { "example": 27292, "type": "number" } } ], "responses": { "200": { "description": "The matching event's team.", "content": { "application/json": { "schema": { "description": "The matching event's team.", "type": "array", "items": { "$ref": "#/components/schemas/OmnidexEventTeam" } } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "description": "Error message.", "type": "string" } }, "additionalProperties": false, "required": [ "error" ] } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "description": "Error message.", "type": "string" } }, "additionalProperties": false, "required": [ "error" ] } } } } } } }, "/option/search": { "get": { "operationId": "OptionSearchAPISpec_get_/search", "tags": [ "Definitions" ], "summary": "Get lists of terms which are commonly used throughout the API.", "parameters": [ { "description": "Select a specific option rather than including all of them.", "name": "field", "in": "query", "required": false, "schema": { "example": "statOperator", "type": "string" } } ], "responses": { "200": { "description": "A list of featured set groups.", "content": { "application/json": { "schema": { "description": "A list of featured set groups.", "type": "object", "properties": { "circulation": { "description": "Circulation and CirculationTemplate types.", "type": "array", "items": { "type": "object", "properties": { "foil": { "description": "Are cards printed with this circulation foil?", "type": "boolean" }, "text": { "description": "A human-friendly version of the circulation value.", "example": "Non-foil", "type": "string" }, "value": { "description": "The circulation type (this matches `kind` values found on `Circulation` and `CirculationTemplate` responses).", "example": "NONFOIL", "type": "string" } }, "additionalProperties": false, "required": [ "foil", "text", "value" ] } }, "circulationPopulationOperator": { "description": "Circulation population operators used by `Circulation` and `CirculationTemplate` responses.", "type": "array", "items": { "type": "object", "properties": { "symbol": { "description": "The circulation population operator symbol.", "example": "≈", "type": "string" }, "text": { "description": "A human-friendly version of the circulation population operator value.", "example": "Approximate", "type": "string" }, "value": { "description": "The circulation population operator.", "example": "APPROXIMATE", "type": "string" } }, "additionalProperties": false, "required": [ "symbol", "text", "value" ] } }, "class": { "description": "Card classes.", "type": "array", "items": { "type": "object", "properties": { "text": { "description": "A human-friendly version of the value.", "example": "Some value", "type": "string" }, "value": { "description": "A value referenced or returned elsewhere by the API.", "example": "SOMEVALUE", "type": "string" } }, "additionalProperties": false, "required": [ "text", "value" ] } }, "configuration": { "description": "Card edition configurations.", "type": "object", "properties": { "orientations": { "description": "A list of matching `configurationOrientation` values this configuration uses.", "example": [], "type": "array", "items": { "type": "string" } }, "text": { "description": "A human-friendly version of the configuration value.", "example": "Default", "type": "string" }, "value": { "description": "The card edition's game configuration.", "example": "default", "type": "string" } }, "additionalProperties": false, "required": [ "orientations", "text", "value" ] }, "configurationOrientation": { "description": "Card edition configurations.", "type": "object", "properties": { "text": { "description": "A human-friendly version of the configuration orientation value.", "example": "Front", "type": "string" }, "value": { "description": "The orientation of the game configuration.", "example": "front", "type": "string" } }, "additionalProperties": false, "required": [ "text", "value" ] }, "element": { "description": "Card elements.", "type": "array", "items": { "type": "object", "properties": { "text": { "description": "A human-friendly version of the value.", "example": "Some value", "type": "string" }, "value": { "description": "A value referenced or returned elsewhere by the API.", "example": "SOMEVALUE", "type": "string" } }, "additionalProperties": false, "required": [ "text", "value" ] } }, "gameFormat": { "description": "Game formats.", "type": "array", "items": { "type": "object", "properties": { "text": { "description": "A human-friendly version of the value.", "example": "Some value", "type": "string" }, "value": { "description": "A value referenced or returned elsewhere by the API.", "example": "SOMEVALUE", "type": "string" } }, "additionalProperties": false, "required": [ "text", "value" ] } }, "language": { "description": "Card set languages.", "type": "array", "items": { "type": "object", "properties": { "text": { "description": "A human-friendly version of the value.", "example": "Some value", "type": "string" }, "value": { "description": "A value referenced or returned elsewhere by the API.", "example": "SOMEVALUE", "type": "string" } }, "additionalProperties": false, "required": [ "text", "value" ] } }, "rarity": { "description": "Card edition rarities.", "type": "array", "items": { "type": "object", "properties": { "display": { "description": "The rarity abbreviation.", "example": "UR", "type": "string" }, "text": { "description": "The rarity name.", "example": "Ultra Rare", "type": "string" }, "value": { "description": "A stringified version of the rarity numbers associated with card editions.", "example": 5, "type": "string" } }, "additionalProperties": false, "required": [ "display", "text", "value" ] } }, "set": { "description": "Card sets.", "type": "object", "properties": { "display": { "description": "The set's display name. This usually matches the `text` value, but sometimes contains a shortened version instead.", "example": "GenSeSha", "type": "string" }, "text": { "description": "The set's full name.", "example": "I’ve been recruited as a champion to save the world but suddenly got transported to modern Earth!", "type": "string" }, "value": { "description": "The set's prefix.", "example": "GSC", "type": "string" } }, "additionalProperties": false, "required": [ "display", "text", "value" ] }, "stat": { "description": "Numeric card stats.", "type": "array", "items": { "type": "object", "properties": { "group": { "description": "The group the stat belongs to.", "example": "Card stats", "type": "string" }, "text": { "description": "The stat name.", "example": "Reserve Cost", "type": "string" }, "value": { "description": "The stat key.", "example": "cost_reserve", "type": "string" } }, "additionalProperties": false, "required": [ "group", "text", "value" ] } }, "statOperator": { "description": "Operators that can be used when searching for cards by their numeric stat values.", "type": "array", "items": { "type": "object", "properties": { "for": { "description": "The value keys this stat operator specifically targets.", "default": "undefined", "example": [ "cost_memory", "cost_reserve" ], "type": "array", "items": { "type": "string" } }, "input": { "description": "Does this stat operator require additional input?\nA missing value is truthy - this property only applies if the value explicitly returns `false`.", "default": "undefined", "example": false, "type": "boolean" }, "symbol": { "description": "The operator's symbol.", "example": "= X", "type": "string" }, "text": { "description": "A human-friendly description of the operator.", "example": "is X", "type": "string" }, "value": { "description": "The computer-friendly operator.", "example": "=-1", "type": "string" } }, "additionalProperties": false, "required": [ "symbol", "text", "value" ] } }, "subtype": { "description": "Card subtypes.", "type": "array", "items": { "type": "object", "properties": { "text": { "description": "A human-friendly version of the value.", "example": "Some value", "type": "string" }, "value": { "description": "A value referenced or returned elsewhere by the API.", "example": "SOMEVALUE", "type": "string" } }, "additionalProperties": false, "required": [ "text", "value" ] } }, "type": { "description": "Card types.", "type": "array", "items": { "type": "object", "properties": { "text": { "description": "A human-friendly version of the value.", "example": "Some value", "type": "string" }, "value": { "description": "A value referenced or returned elsewhere by the API.", "example": "SOMEVALUE", "type": "string" } }, "additionalProperties": false, "required": [ "text", "value" ] } } }, "additionalProperties": false, "required": [ "circulation", "circulationPopulationOperator", "class", "configuration", "configurationOrientation", "element", "gameFormat", "language", "rarity", "set", "stat", "statOperator", "subtype", "type" ] } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "description": "Error message.", "type": "string" } }, "additionalProperties": false, "required": [ "error" ] } } } } } } }, "/": { "get": { "operationId": "GetAPISpec_get_/", "tags": [ "Metadata" ], "summary": "Get API metadata.", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "commit_hash": { "description": "The git commit hash the API is running on.", "example": "61b58e38f226a8148fba5da8398e7cb2e2c11fd2", "type": "string" }, "db": { "description": "The database the API is pulling data from.", "example": "production-live", "type": "string" }, "deploy_hash": { "description": "The deployment hash the API is running on.", "example": "dpl_13SZp56zC5qn3f9yG1cW2HTdJ31f", "type": "string" }, "message": { "description": "A brief description of the API.", "example": "Grand Archive TCG API server.", "type": "string" }, "request_received": { "description": "The time the request was received by the server.", "example": 1748939089, "type": "number" } }, "additionalProperties": false, "required": [ "commit_hash", "db", "deploy_hash", "message", "request_received" ] } } } } } } } }, "components": { "schemas": { "CardCostMemory": { "description": "The card's memory cost (`cost_reserve` will be `null` if this is numeric).\nBe aware that cards can have both memory and reserve cost set to `null` (example: Shifting Currents).", "example": 1, "minimum": 0, "type": "number", "nullable": true, "deprecated": true }, "CardCostReserve": { "description": "The card's reserve cost (`cost_memory` will be `null` if this is numeric).\n`-1` represents a card with \"X\" cost (example: Lost in Thought).\nBe aware that cards can have both memory and reserve cost set to `null` (example: Shifting Currents).", "example": null, "minimum": -1, "type": "number", "nullable": true, "deprecated": true }, "CardStatDurability": { "description": "The card's durability stat.", "example": 3, "type": "number", "nullable": true }, "CirculationTemplate": { "additionalProperties": false, "type": "object", "properties": { "kind": { "$ref": "#/components/schemas/CirculationKind", "description": "The circulation type." }, "population": { "description": "The quantity of editions printed with this circulation.", "example": 100, "type": "number" }, "population_operator": { "description": "A symbol to describe the accuracy of the population. The possible values are revealed by the `option/search` endpoint.", "example": "=", "type": "string" }, "printing": { "description": "Is this circulation still in print?", "example": false, "type": "boolean" }, "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "edition_id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "foil": { "description": "Is this circulation foil?", "example": false, "type": "boolean" }, "uuid": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "variants": { "example": [], "type": "array", "items": { "$ref": "#/components/schemas/CirculationVariant" } }, "name": { "description": "The circulation template's unique name.", "example": "AMB NF C 2", "type": "string" } }, "required": [ "created_at", "edition_id", "foil", "kind", "name", "population", "population_operator", "printing", "uuid", "variants" ] }, "CirculationKind": { "enum": [ "FOIL", "NONFOIL" ], "type": "string" }, "CirculationVariant": { "description": "Circulation variants describe print variations within specific Circulation and CirculationTemplate types. This is mainly used to describe stamp variants.", "additionalProperties": false, "type": "object", "properties": { "kind": { "$ref": "#/components/schemas/CirculationKind", "description": "The circulation type." }, "population": { "description": "The quantity of editions printed with this circulation.", "example": 100, "type": "number" }, "population_operator": { "description": "A symbol to describe the accuracy of the population. The possible values are revealed by the `option/search` endpoint.", "example": "=", "type": "string" }, "printing": { "description": "Is this circulation still in print?", "example": false, "type": "boolean" }, "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "description": { "description": "A short description of the variant.", "example": "Ascent Ferocity stamp.", "type": "string" }, "edition_id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "image": { "description": "An API image path (`/cards/images/example.jpg` implies `https://api.gatcg.com/cards/images/example.jpg`).", "type": "string" }, "last_update": { "description": "When the dataset was last updated.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "uuid": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" } }, "required": [ "created_at", "description", "edition_id", "image", "kind", "last_update", "population", "population_operator", "printing", "uuid" ] }, "Circulation": { "description": "The Circulation type describes the print of its parent Edition.", "additionalProperties": false, "type": "object", "properties": { "kind": { "$ref": "#/components/schemas/CirculationKind", "description": "The circulation type." }, "population": { "description": "The quantity of editions printed with this circulation.", "example": 100, "type": "number" }, "population_operator": { "description": "A symbol to describe the accuracy of the population. The possible values are revealed by the `option/search` endpoint.", "example": "=", "type": "string" }, "printing": { "description": "Is this circulation still in print?", "example": false, "type": "boolean" }, "created_at": { "description": "When the dataset was created.", "example": "2024-10-11T12:00:00+00:00", "type": "string", "format": "date-time" }, "edition_id": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "foil": { "description": "Is this circulation foil?", "example": false, "type": "boolean" }, "uuid": { "description": "A 10-character alphanumeric UUID.", "example": "abcde12345", "type": "string" }, "variants": { "example": [], "type": "array", "items": { "$ref": "#/components/schemas/CirculationVariant" } } }, "required": [ "created_at", "edition_id", "foil", "kind", "population", "population_operator", "printing", "uuid", "variants" ] }, "EditionConfiguration": { "description": "The edition's play configuration. The `\"flip\"` response is given on editions which are double-faced.", "example": "default", "enum": [ "default", "flip" ], "type": "string" }, "EditionEffect": { "description": "The edition's specific effect. This is only populated if the value differs from the parent `Card`'s `effect` value.", "example": null, "type": "string", "nullable": true }, "EditionEffectHTML": { "description": "The edition's specific raw effect. This is `null` if the edition's `effect` value is `null`.", "example": null, "type": "string", "nullable": true }, "EditionEffectRaw": { "description": "The edition's specific raw effect. This is `null` if the edition's `effect` value is `null`.", "example": null, "type": "string", "nullable": true }, "EditionFlavor": { "description": "The edition's specific flavor text. This is only populated if the value differs from the parent `Card`'s `flavor` value.", "example": "The centerpiece of the Imperial Armory.", "type": "string", "nullable": true }, "EditionIllustrator": { "description": "The edition's illustrator.", "example": "Dragonart", "type": "string", "nullable": true }, "EditionOrientation": { "description": "The edition's orientation. This is set to `\"front\"` or `\"back\"` if the edition's `configuration` is `\"flip\"`, otherwise it will be `null`.", "example": null, "anyOf": [ { "enum": [ "back", "front" ], "type": "string" } ], "nullable": true }, "EditionThemaScore": { "description": "One of the edition's Thema score values.", "example": null, "type": "number", "nullable": true }, "EditionThemaScoreTotal": { "description": "The sum of a range of edition Thema score values.", "example": null, "type": "number", "nullable": true }, "CardEffectTemplate": { "description": "The card's effect as a template.", "example": "[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.)*", "type": "string", "nullable": true }, "CardEffectHTML": { "description": "The card's effect as HTML. This is `null` if the card's `effect` value is `null`.", "example": "Class Bonus Level 2+ Crescent Glaive gets +1. (Apply this effect only if your champion's class matches this card's class and only if your champion is level 2 or higher.)", "type": "string", "nullable": true, "deprecated": true }, "CardEffectRaw": { "description": "The card's effect as plain text. This is `null` if the card's `effect` value is `null`.", "example": "[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.)", "type": "string", "nullable": true }, "CardFlavor": { "description": "The card's flavor text.", "example": "Convalescing waves cascade through the soul, revitalizing the body and mind from the depths.", "type": "string", "nullable": true }, "CardStatLevel": { "description": "The card's level stat.", "example": null, "type": "number", "nullable": true }, "CardStatLife": { "description": "The card's life stat.", "example": null, "type": "number", "nullable": true }, "CardStatPower": { "description": "The card's power stat.", "example": 1, "type": "number", "nullable": true }, "CardStatSpeed": { "description": "The card's speed stat. `true` represents Fast whilst `false` represents Slow.", "example": null, "type": "boolean", "nullable": true }, "CardLegality": { "description": "Legality limits the card is subject to. This is only populated if the card is limited in certain formats. The possible game format values are revealed by the `option/search` endpoint.", "example": null, "anyOf": [ { "type": "object", "additionalProperties": { "type": "number" } } ], "nullable": true }, "CardReferenceKind": { "description": "The reference type.", "example": "SUMMON", "enum": [ "BREW", "GENERATE", "MASTERY", "REFERENCE", "STATUS", "SUMMON" ], "type": "string" }, "Omit_EditionThemaRanked__kind___uuid___created_at__": { "type": "object", "properties": { "change": { "description": "The percent change in the edition's total thema score compared to its previous total thema score in the dataset.\nA positive number represents an increase in total thema score, whilst a negative number represents a decrease in total thema score.", "example": 0.13, "type": "number" }, "thema_total": { "$ref": "#/components/schemas/EditionThemaScoreTotal" }, "thema_charm": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_ferocity": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_grace": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_mystique": { "$ref": "#/components/schemas/EditionThemaScore" }, "thema_valor": { "$ref": "#/components/schemas/EditionThemaScore" }, "rank": { "description": "The overall rank of the edition's total thema scores on the given created at date in relation to other editions with dynamic thema scores.", "example": 16, "type": "number" }, "rank_change": { "description": "The change in the edition's overall rank compared to its previous rank in the dataset.\nA positive number represents a rise in rank, whilst a negative number represents a fall in rank.", "example": -2, "type": "number" } }, "additionalProperties": false, "required": [ "change", "rank", "rank_change", "thema_charm", "thema_ferocity", "thema_grace", "thema_mystique", "thema_total", "thema_valor" ] }, "OmnidexEventPlayerDecklist": { "type": "object", "properties": { "decklist": { "$ref": "#/components/schemas/OmnidexEventDecklist" }, "player": { "type": "number" }, "visible": { "type": "boolean", "enum": [ true ] } }, "additionalProperties": false, "required": [ "decklist", "player", "visible" ] }, "OmnidexEventDecklist": { "type": "object", "properties": { "main": { "type": "array", "items": { "$ref": "#/components/schemas/OmnidexEventDecklistCard" } }, "material": { "type": "array", "items": { "$ref": "#/components/schemas/OmnidexEventDecklistCard" } }, "sideboard": { "type": "array", "items": { "$ref": "#/components/schemas/OmnidexEventDecklistCard" } } }, "additionalProperties": false, "required": [ "main", "material", "sideboard" ] }, "OmnidexEventDecklistCard": { "type": "object", "properties": { "card": { "type": "string" }, "quantity": { "type": "number" } }, "additionalProperties": false, "required": [ "card", "quantity" ] }, "OmnidexEventJudge": { "additionalProperties": false, "type": "object", "properties": { "country": { "type": "string" }, "cp": { "type": "number" }, "emblem": { "$ref": "#/components/schemas/OmnidexEventPlayerEmblem" }, "id": { "type": "number" }, "rank": { "type": "number" }, "username": { "type": "string" }, "judgeExperience": { "type": "number" }, "judgeLevel": { "type": "number" } }, "required": [ "country", "cp", "emblem", "id", "judgeExperience", "judgeLevel", "rank", "username" ] }, "OmnidexEventPlayerEmblem": { "enum": [ "ascendant", "bronze", "demigod", "diamond", "gold", "platinum", "silver", "unranked" ], "type": "string" }, "OmnidexEventMatch": { "type": "object", "properties": { "completedAt": { "type": "number" }, "id": { "type": "number" }, "label": { "type": "string" }, "pairing": { "type": "array", "items": { "$ref": "#/components/schemas/OmnidexEventMatchPairing" } }, "status": { "$ref": "#/components/schemas/OmnidexEventMatchStatus" } }, "additionalProperties": false, "required": [ "id", "pairing", "status" ] }, "OmnidexEventMatchPairing": { "type": "object", "properties": { "dropped": { "type": "boolean" }, "eloChange": { "type": "number" }, "id": { "type": "number" }, "score": { "type": "number" }, "status": { "$ref": "#/components/schemas/OmnidexEventMatchPairingStatus" } }, "additionalProperties": false, "required": [ "dropped", "eloChange", "id", "score", "status" ] }, "OmnidexEventMatchPairingStatus": { "enum": [ "byed", "loser", "tied", "waiting", "winner" ], "type": "string" }, "OmnidexEventMatchStatus": { "enum": [ "byed", "complete", "started", "waiting" ], "type": "string" }, "OmnidexEventRoundWithTimer": { "additionalProperties": false, "type": "object", "properties": { "id": { "type": "number" }, "status": { "$ref": "#/components/schemas/OmnidexEventRoundStatus" }, "total": { "type": "number" }, "timer": { "$ref": "#/components/schemas/OmnidexEventRoundTimer" } }, "required": [ "id", "status", "timer", "total" ] }, "OmnidexEventRoundStatus": { "enum": [ "complete", "started", "waiting" ], "type": "string" }, "OmnidexEventRoundTimer": { "anyOf": [ { "additionalProperties": false, "type": "object", "properties": { "serverTime": { "type": "string" }, "timerEnd": { "nullable": true }, "timerPaused": { "nullable": true }, "timerStart": { "nullable": true } }, "required": [ "serverTime", "timerEnd", "timerPaused", "timerStart" ] }, { "additionalProperties": false, "type": "object", "properties": { "serverTime": { "type": "string" }, "timerEnd": { "type": "string" }, "timerPaused": { "nullable": true }, "timerStart": { "type": "string" } }, "required": [ "serverTime", "timerEnd", "timerPaused", "timerStart" ] }, { "additionalProperties": false, "type": "object", "properties": { "serverTime": { "type": "string" }, "timerEnd": { "type": "string" }, "timerPaused": { "type": "string" }, "timerStart": { "type": "string" } }, "required": [ "serverTime", "timerEnd", "timerPaused", "timerStart" ] } ] }, "OmnidexEventStage": { "type": "object", "properties": { "id": { "type": "number" }, "status": { "$ref": "#/components/schemas/OmnidexEventStageStatus" }, "type": { "$ref": "#/components/schemas/OmnidexEventStageType" } }, "additionalProperties": false, "required": [ "id", "status", "type" ] }, "OmnidexEventStageStatus": { "enum": [ "completable", "complete", "started", "waiting" ], "type": "string" }, "OmnidexEventStageType": { "enum": [ "single-elimination", "swiss" ], "type": "string" }, "OmnidexEventPlayer": { "type": "object", "properties": { "country": { "type": "string" }, "cp": { "type": "number" }, "emblem": { "$ref": "#/components/schemas/OmnidexEventPlayerEmblem" }, "id": { "type": "number" }, "rank": { "type": "number" }, "username": { "type": "string" } }, "additionalProperties": false, "required": [ "country", "cp", "emblem", "id", "rank", "username" ] }, "OmnidexEvent": { "anyOf": [ { "additionalProperties": false, "type": "object", "properties": { "category": { "$ref": "#/components/schemas/OmnidexEventCategory" }, "decklists": { "type": "boolean" }, "description": { "type": "string" }, "format": { "type": "string", "enum": [ "team-standard-3v3" ] }, "host": { "$ref": "#/components/schemas/OmnidexEventHost" }, "id": { "type": "number" }, "judges": { "type": "array", "items": { "type": "number" } }, "name": { "type": "string" }, "players": { "type": "array", "items": { "type": "number" } }, "ranked": { "type": "boolean" }, "setting": { "$ref": "#/components/schemas/OmnidexEventSetting" }, "status": { "$ref": "#/components/schemas/OmnidexEventStatus" }, "startAt": { "type": "string" }, "startedAt": { "type": "string", "nullable": true }, "url": { "type": "string" }, "vpMultiplier": { "type": "number" }, "singleEliminationMatchConfig": { "anyOf": [ { "enum": [ "bo1", "bo3", "bo5" ], "type": "string" } ], "nullable": true }, "singleEliminationCutSize": { "type": "number" }, "stages": { "type": "array", "items": { "$ref": "#/components/schemas/OmnidexEventStage" } }, "swissMatchConfig": { "$ref": "#/components/schemas/OmnidexEventMatchConfig" }, "swissRounds": { "type": "number" }, "teamSize": { "type": "number" }, "teams": { "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "single-elimination", "swiss" ], "type": "string" } }, "required": [ "category", "decklists", "description", "format", "host", "id", "judges", "name", "players", "ranked", "setting", "singleEliminationCutSize", "singleEliminationMatchConfig", "stages", "startAt", "startedAt", "status", "swissMatchConfig", "swissRounds", "teamSize", "teams", "type", "url", "vpMultiplier" ] }, { "additionalProperties": false, "type": "object", "properties": { "category": { "$ref": "#/components/schemas/OmnidexEventCategory" }, "decklists": { "type": "boolean" }, "description": { "type": "string" }, "format": { "$ref": "#/components/schemas/OmnidexEventFormat1v1" }, "host": { "$ref": "#/components/schemas/OmnidexEventHost" }, "id": { "type": "number" }, "judges": { "type": "array", "items": { "type": "number" } }, "name": { "type": "string" }, "players": { "type": "array", "items": { "type": "number" } }, "ranked": { "type": "boolean" }, "setting": { "$ref": "#/components/schemas/OmnidexEventSetting" }, "status": { "$ref": "#/components/schemas/OmnidexEventStatus" }, "startAt": { "type": "string" }, "startedAt": { "type": "string", "nullable": true }, "url": { "type": "string" }, "vpMultiplier": { "type": "number" }, "singleEliminationMatchConfig": { "anyOf": [ { "enum": [ "bo1", "bo3", "bo5" ], "type": "string" } ], "nullable": true }, "singleEliminationCutSize": { "type": "number" }, "stages": { "type": "array", "items": { "$ref": "#/components/schemas/OmnidexEventStage" } }, "swissMatchConfig": { "$ref": "#/components/schemas/OmnidexEventMatchConfig" }, "swissRounds": { "type": "number" }, "type": { "enum": [ "single-elimination", "swiss" ], "type": "string" } }, "required": [ "category", "decklists", "description", "format", "host", "id", "judges", "name", "players", "ranked", "setting", "singleEliminationCutSize", "singleEliminationMatchConfig", "stages", "startAt", "startedAt", "status", "swissMatchConfig", "swissRounds", "type", "url", "vpMultiplier" ] }, { "additionalProperties": false, "type": "object", "properties": { "category": { "$ref": "#/components/schemas/OmnidexEventCategory" }, "decklists": { "type": "boolean" }, "description": { "type": "string" }, "format": { "type": "string", "enum": [ "free-play" ] }, "host": { "$ref": "#/components/schemas/OmnidexEventHost" }, "id": { "type": "number" }, "judges": { "type": "array", "items": { "type": "number" } }, "name": { "type": "string" }, "players": { "type": "array", "items": { "type": "number" } }, "ranked": { "type": "boolean" }, "setting": { "$ref": "#/components/schemas/OmnidexEventSetting" }, "status": { "$ref": "#/components/schemas/OmnidexEventStatus" }, "startAt": { "type": "string" }, "startedAt": { "type": "string", "nullable": true }, "url": { "type": "string" }, "vpMultiplier": { "type": "number" }, "type": { "type": "string", "enum": [ "free-play" ] } }, "required": [ "category", "decklists", "description", "format", "host", "id", "judges", "name", "players", "ranked", "setting", "startAt", "startedAt", "status", "type", "url", "vpMultiplier" ] } ] }, "OmnidexEventCategory": { "enum": [ "ascent", "nationals", "regionals", "regular", "store-championships", "worlds" ], "type": "string" }, "OmnidexEventFormat": { "enum": [ "draft", "free-play", "standard", "team-standard-3v3" ], "type": "string" }, "OmnidexEventHost": { "type": "object", "properties": { "address": { "type": "string" }, "addressCountryCode": { "type": "string" }, "id": { "type": "number" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "address", "addressCountryCode", "id", "name" ] }, "OmnidexEventSetting": { "enum": [ "online", "physical" ], "type": "string" }, "OmnidexEventStatus": { "enum": [ "canceled", "canceled-reset", "canceled-suspended", "completable", "complete", "rsvp", "started", "starting" ], "type": "string" }, "OmnidexEventMatchConfig": { "enum": [ "bo1", "bo3", "bo5" ], "type": "string" }, "OmnidexEventFormat1v1": { "enum": [ "draft", "standard" ], "type": "string" }, "OmnidexEventStandings": { "type": "object", "properties": { "id": { "type": "number" }, "rounds": { "type": "object", "properties": { "latest": { "type": "number" }, "total": { "type": "number" } }, "additionalProperties": false, "required": [ "latest", "total" ] }, "standings": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/OmnidexEventStandingsPlayer" } }, { "type": "array", "items": { "$ref": "#/components/schemas/OmnidexEventStandingsTeam" } } ] }, "status": { "$ref": "#/components/schemas/OmnidexEventStageStatus" }, "type": { "type": "string", "enum": [ "swiss" ] } }, "additionalProperties": false, "required": [ "id", "rounds", "standings", "status", "type" ] }, "OmnidexEventStandingsPlayer": { "anyOf": [ { "additionalProperties": false, "type": "object", "properties": { "tiebreaker": { "type": "number" }, "status": { "$ref": "#/components/schemas/OmnidexEventStandingsEntityStatus" }, "statsByes": { "type": "number" }, "statsDroppedRound": { "type": "number" }, "statsDroppedStage": { "type": "number" }, "statsGamesPlayed": { "type": "number" }, "statsGamesWon": { "type": "number" }, "statsLosses": { "type": "number" }, "statsPercentGW": { "type": "number" }, "statsPercentMW": { "type": "number" }, "statsPercentOGW": { "type": "number" }, "statsPercentOMW": { "type": "number" }, "statsScore": { "type": "number" }, "statsTies": { "type": "number" }, "statsWins": { "type": "number" }, "id": { "type": "number" }, "team": { "type": "string" }, "teamSlot": { "type": "number" } }, "required": [ "id", "statsByes", "statsGamesPlayed", "statsGamesWon", "statsLosses", "statsPercentGW", "statsPercentMW", "statsPercentOGW", "statsPercentOMW", "statsScore", "statsTies", "statsWins", "status", "team", "teamSlot", "tiebreaker" ] }, { "additionalProperties": false, "type": "object", "properties": { "tiebreaker": { "type": "number" }, "status": { "$ref": "#/components/schemas/OmnidexEventStandingsEntityStatus" }, "statsByes": { "type": "number" }, "statsDroppedRound": { "type": "number" }, "statsDroppedStage": { "type": "number" }, "statsGamesPlayed": { "type": "number" }, "statsGamesWon": { "type": "number" }, "statsLosses": { "type": "number" }, "statsPercentGW": { "type": "number" }, "statsPercentMW": { "type": "number" }, "statsPercentOGW": { "type": "number" }, "statsPercentOMW": { "type": "number" }, "statsScore": { "type": "number" }, "statsTies": { "type": "number" }, "statsWins": { "type": "number" }, "id": { "type": "number" } }, "required": [ "id", "statsByes", "statsGamesPlayed", "statsGamesWon", "statsLosses", "statsPercentGW", "statsPercentMW", "statsPercentOGW", "statsPercentOMW", "statsScore", "statsTies", "statsWins", "status", "tiebreaker" ] } ] }, "OmnidexEventStandingsEntityStatus": { "enum": [ "active", "awaiting-decklist", "eliminated", "winner" ], "type": "string" }, "OmnidexEventStandingsTeam": { "additionalProperties": false, "type": "object", "properties": { "tiebreaker": { "type": "number" }, "status": { "$ref": "#/components/schemas/OmnidexEventStandingsEntityStatus" }, "statsByes": { "type": "number" }, "statsDroppedRound": { "type": "number" }, "statsDroppedStage": { "type": "number" }, "statsGamesPlayed": { "type": "number" }, "statsGamesWon": { "type": "number" }, "statsLosses": { "type": "number" }, "statsPercentGW": { "type": "number" }, "statsPercentMW": { "type": "number" }, "statsPercentOGW": { "type": "number" }, "statsPercentOMW": { "type": "number" }, "statsScore": { "type": "number" }, "statsTies": { "type": "number" }, "statsWins": { "type": "number" }, "name": { "type": "string" } }, "required": [ "name", "statsByes", "statsGamesPlayed", "statsGamesWon", "statsLosses", "statsPercentGW", "statsPercentMW", "statsPercentOGW", "statsPercentOMW", "statsScore", "statsTies", "statsWins", "status", "tiebreaker" ] }, "OmnidexEventStatistics": { "anyOf": [ { "additionalProperties": false, "type": "object", "properties": { "decklistsAdvancedElementBreakdown": { "$ref": "#/components/schemas/OmnidexEventDecklistStatsNumericBreakdown" }, "decklistsBasicElementBreakdown": { "$ref": "#/components/schemas/OmnidexEventDecklistStatsNumericBreakdown" }, "decklistsChampionBreakdown": { "$ref": "#/components/schemas/OmnidexEventDecklistStatsNumericBreakdown" }, "decklistsStatsRevealed": { "type": "boolean", "enum": [ true ] }, "decklistsTopNAdvancedElementBreakdown": { "$ref": "#/components/schemas/OmnidexEventDecklistStatsNumericBreakdown" }, "decklistsTopNBasicElementBreakdown": { "$ref": "#/components/schemas/OmnidexEventDecklistStatsNumericBreakdown" }, "decklistsTopNChampionBreakdown": { "$ref": "#/components/schemas/OmnidexEventDecklistStatsNumericBreakdown" }, "decklistsTopNRound": { "type": "number" }, "decklistsTopNStage": { "type": "number" }, "decklistsTopNStatsRevealed": { "type": "boolean", "enum": [ true ] }, "decklistsTopNValue": { "type": "number" } }, "required": [ "decklistsAdvancedElementBreakdown", "decklistsBasicElementBreakdown", "decklistsChampionBreakdown", "decklistsStatsRevealed", "decklistsTopNAdvancedElementBreakdown", "decklistsTopNBasicElementBreakdown", "decklistsTopNChampionBreakdown", "decklistsTopNRound", "decklistsTopNStage", "decklistsTopNStatsRevealed", "decklistsTopNValue" ] }, { "additionalProperties": false, "type": "object", "properties": { "decklistsAdvancedElementBreakdown": { "$ref": "#/components/schemas/OmnidexEventDecklistStatsNumericBreakdown" }, "decklistsBasicElementBreakdown": { "$ref": "#/components/schemas/OmnidexEventDecklistStatsNumericBreakdown" }, "decklistsChampionBreakdown": { "$ref": "#/components/schemas/OmnidexEventDecklistStatsNumericBreakdown" }, "decklistsStatsRevealed": { "type": "boolean", "enum": [ true ] }, "decklistsTopNStatsRevealed": { "type": "boolean", "enum": [ false ] } }, "required": [ "decklistsAdvancedElementBreakdown", "decklistsBasicElementBreakdown", "decklistsChampionBreakdown", "decklistsStatsRevealed", "decklistsTopNStatsRevealed" ] }, { "additionalProperties": false, "type": "object", "properties": { "decklistsStatsRevealed": { "type": "boolean", "enum": [ false ] }, "decklistsTopNAdvancedElementBreakdown": { "$ref": "#/components/schemas/OmnidexEventDecklistStatsNumericBreakdown" }, "decklistsTopNBasicElementBreakdown": { "$ref": "#/components/schemas/OmnidexEventDecklistStatsNumericBreakdown" }, "decklistsTopNChampionBreakdown": { "$ref": "#/components/schemas/OmnidexEventDecklistStatsNumericBreakdown" }, "decklistsTopNRound": { "type": "number" }, "decklistsTopNStage": { "type": "number" }, "decklistsTopNStatsRevealed": { "type": "boolean", "enum": [ true ] }, "decklistsTopNValue": { "type": "number" } }, "required": [ "decklistsStatsRevealed", "decklistsTopNAdvancedElementBreakdown", "decklistsTopNBasicElementBreakdown", "decklistsTopNChampionBreakdown", "decklistsTopNRound", "decklistsTopNStage", "decklistsTopNStatsRevealed", "decklistsTopNValue" ] }, { "additionalProperties": false, "type": "object", "properties": { "decklistsStatsRevealed": { "type": "boolean", "enum": [ false ] }, "decklistsTopNStatsRevealed": { "type": "boolean", "enum": [ false ] } }, "required": [ "decklistsStatsRevealed", "decklistsTopNStatsRevealed" ] } ] }, "OmnidexEventDecklistStatsNumericBreakdown": { "additionalProperties": false, "type": "object", "properties": { "total": { "type": "number" } }, "required": [ "total" ] }, "OmnidexEventTeam": { "type": "object", "properties": { "name": { "type": "string" }, "players": { "type": "array", "items": { "$ref": "#/components/schemas/OmnidexEventTeamPlayer" } } }, "additionalProperties": false, "required": [ "name", "players" ] }, "OmnidexEventTeamPlayer": { "type": "object", "properties": { "id": { "type": "number" }, "slot": { "type": "number" } }, "additionalProperties": false, "required": [ "id", "slot" ] } } }, "servers": [ { "url": "https://api.gatcg.com", "description": "Production server (uses live data)" } ] }