Card
Property | Type | Is required | Description |
---|---|---|---|
id | string|null | No | See CMS. |
name | string | Yes | |
expansion | Expansion | Yes | |
number | string|null | Yes | |
numberSortingOrder | int32 | Yes | |
variants | CardVariant[] | Yes | |
supertype | string | Yes | |
types | string[] | Yes | |
pokemonStage | string|null | No | |
evolvesFrom | string|null | No | |
evolvesInto | string[] | No | |
hitPoints | int32|null | No | |
energyTypes | string[] | No | |
description | string|null | No | |
rules | CardRule[] | No | |
effects | CardEffect[] | No | |
attacks | CardAttack[] | No | |
weaknesses | CardWeaknessResistance[] | No | |
resistances | CardWeaknessResistance[] | No | |
retreatCost | int32|null | No | |
rarity | string|null | No | |
illustrators | string[] | No | |
pokedexNumbers | int32[] | No | |
format | string | Yes | |
regulationMark | string|null | No | |
imageReference | ImageReference|null | No | |
isComplete | boolean | Yes | Even though some properties aren't required, the card itself might have them. If one or more properties are omitted for whatever reason, this property must be set to false , otherwise true (if all properties are present). |
needsReview | boolean | No | Defaults to false . Must be set to true if one or more properties might be incorrect or need review. Also consider using the notesMd property. |
notesMd | string|null | No | Additional notes. Uses Markdown syntax. |
When used as a file, the card
suffix is required, e.g., international/base-set/001.1-102.card.json
.
CardVariant
Property | Type | Is required | Description |
---|---|---|---|
id | string|null | No | See CMS. |
type | string | Yes | |
exclusiveCardLanguages | string[] | No | A list of languages to which this card variant is exclusive. |
descriptionMd | string|null | No | A short description of the card variant, such as how it could be obtained. Uses Markdown syntax. |
sortingOrder | int32|null | No | Overrides the the default sorting order (the default is by type, A-Z ascending). Usually only needed for cases where non-holographic card variants need to be listed before holographic card variants for example. |
NeedsReview | boolean | No | See the same property of Card. |
notesMd | string|null | No | See the same property of Card. |
CardRule
Property | Type | Is required | Description |
---|---|---|---|
id | string|null | No | See CMS. |
name | string|null | No | |
description | string | Yes | |
sortingOrder | int32 | Yes |
CardEffect
Property | Type | Is required | Description |
---|---|---|---|
id | string|null | No | See CMS. |
type | string | Yes | |
name | string | Yes | |
description | string | Yes | |
sortingOrder | int32 | Yes |
CardAttack
Property | Type | Is required | Description |
---|---|---|---|
id | string|null | No | See CMS. |
name | string | Yes | |
energies | CardAttackEnergy[] | No | |
hasExtraEnergies | boolean | No | Defaults to false . Some card attacks have a + sign next to the energy cost; certain Pokémon-GX attacks for example. |
damage | string|null | No | |
description | string|null | No | |
sortingOrder | int32 | Yes |
CardAttackEnergy
Property | Type | Is required | Description |
---|---|---|---|
id | string|null | No | See CMS. |
type | string | Yes | |
quantity | int32 | Yes | |
sortingOrder | int32 | Yes |
CardWeaknessResistance
Property | Type | Is required | Description |
---|---|---|---|
id | string|null | No | See CMS. |
type | string | Yes | |
value | string | Yes | |
sortingOrder | int32 | Yes |
Example
{
"name": "Espeon VMAX",
"expansion": {
"name": "Fusion Strike",
"series": "Sword & Shield Series",
"tcgRegion": "International",
"code": "FST",
"releaseDate": "2021-11-12T00:00:00Z",
"cardNumberRightPart": "264"
},
"number": "270/264",
"numberSortingOrder": 270,
"variants": [
{
"type": "Standard Set Foil",
"exclusiveCardLanguages": [],
"descriptionMd": null,
"sortingOrder": null,
"needsReview": false,
"notesMd": null
}
],
"supertype": "Pokémon",
"types": [
"Full Art Pokémon",
"Rainbow Pokémon",
"Pokémon VMAX",
"Dynamax Pokémon"
],
"pokemonStage": "VMAX",
"evolvesFrom": "Espeon V",
"evolvesInto": [],
"hitPoints": 310,
"energyTypes": [
"Psychic"
],
"description": null,
"rules": [
{
"name": null,
"description": "When your Pokémon VMAX is Knocked Out, your opponent takes 3 Prize cards.",
"sortingOrder": 1
}
],
"effects": [
{
"type": "Ability",
"name": "Solar Revelation",
"description": "Prevent all effects of attacks from your opponent's Pokémon done to all of your Pokémon that have Energy attached.(Existing effects are not removed. Damage is not an effect.)",
"sortingOrder": 1
}
],
"attacks": [
{
"name": "Max Mindstorm",
"energies": [
{
"type": "Psychic",
"quantity": 1,
"sortingOrder": 1
},
{
"type": "Colorless",
"quantity": 2,
"sortingOrder": 2
}
],
"hasExtraEnergies": false,
"damage": "60×",
"description": "This attack does 60 damage for each Energy attached to all of your opponent's Pokémon.",
"sortingOrder": 1
}
],
"weaknesses": [
{
"type": "Darkness",
"value": "×2",
"sortingOrder": 1
}
],
"resistances": [
{
"type": "Fighting",
"value": "-30",
"sortingOrder": 1
}
],
"retreatCost": 2,
"rarity": "Rare Rainbow",
"illustrators": [
"Kouki Saitou"
],
"pokedexNumbers": [
196
],
"format": "Standard",
"regulationMark": "E",
"imageReference": {
"relativeImageFilePath": "images/fusion-strike/270-264.png",
"hasBadQuality": false
},
"isComplete": true,
"needsReview": false,
"notesMd": null
}