Skip to content

Image

Property Type Is required Description
id string|null No See CMS.
imageFileName string Yes The name of the image file located within the same directory of this resource.
hasBadQuality boolean No Defaults to false. Must be set to true if the image shows artifacts or imperfections of any kind (from lossy (re)compression, upscaling or scanning), if the image has distorted or uncrisp edges (with or without transparency), if the image is raw or unedited, or if the image doesn't look right in general.
metadata ImageMetadata Yes

When used as a file, the image suffix is required, e.g.:

  • international/base-set/003.3-102.image.json.
  • 0113.chansey.image.json.

ImageMetadata

ImageMetadata can be one of the following:

CardImageMetadata

CardImageMetadata is a CardReference with the following properties added to it:

Property Type Is required Description
cardIllustrators string[]|null No

PokemonImageMetadata

Property Type Is required Description
pokemonName string Yes
pokedexNumber int32 Yes

Examples

CardImageMetadata example

{
  "imageFileName": "3-102.jpg",
  "hasBadQuality": false,
  "metadata": {
    "cardName": "Chansey",
    "expansion": {
      "name": "Base Set",
      "series": "Original Series",
      "tcgRegion": "International",
      "code": "BS",
      "releaseDate": "1999-01-09T00:00:00Z",
      "cardNumberRightPart": "102"
    },
    "cardNumber": "3/102",
    "cardNumberSortingOrder": 3,
    "cardIllustrators": [
      "Ken Sugimori"
    ]
  }
}

PokemonImageMetadata example

{
  "imageFileName": "0113.chansey.png",
  "hasBadQuality": false,
  "metadata": {
    "pokemonName": "Chansey",
    "pokedexNumber": 113
  }
}