Skip to content

Set List

The Set List Data Model describes the meta data properties of an individual Set.

  • Parent file: SetList
  • Parent property: data

TypeScript Model

Toggle Model
TypeScript
export type SetList = {
  baseSetSize: number;
  block?: string;
  cardsphereSetId?: number;
  code: string;
  codeV3?: string;
  decks?: DeckSet[];
  isForeignOnly?: boolean;
  isFoilOnly: boolean;
  isNonFoilOnly?: boolean;
  isOnlineOnly: boolean;
  isPaperOnly?: boolean;
  isPartialPreview?: boolean;
  keyruneCode: string;
  languages?: string[];
  mcmId?: number;
  mcmIdExtras?: number;
  mcmName?: string;
  mtgoCode?: string;
  name: string;
  parentCode?: string;
  releaseDate: string;
  sealedProduct?: SealedProduct[];
  tcgplayerGroupId?: number;
  totalSetSize: number;
  tokenSetCode?: string;
  translations: Translations;
  type: string;
};

Model Properties

baseSetSize

The number of cards in the set. This will default to totalSetSize if not available. Wizards of the Coast sometimes prints extra cards beyond the set size into promos or supplemental products.

  • Type: number
  • Introduced: v4.1.0

block O

The block name the set is in.

  • Type: string
  • Introduced: v4.0.0

cardsphereSetId O

The Cardsphere set identifier.

  • Type: number
  • Introduced: v5.2.1

code

The printing set code for the set.

  • Type: string
  • Introduced: v4.0.0

codeV3 O

The alternate printing set code Wizards of the Coast uses for a select few duel deck sets.

  • Type: string
  • Introduced: v4.2.1

decks O

All decks associated to the set. See the Deck (Set) Data Model.

  • Type: DeckSet[]
  • Introduced: v5.2.2

isForeignOnly O

If the set is only available outside the United States of America.

  • Type: boolean
  • Introduced: v4.4.1

isFoilOnly

If the set is only available in foil.

  • Type: boolean
  • Introduced: v4.0.0

isNonFoilOnly O

If the set is only available in non-foil.

  • Type: boolean
  • Introduced: v5.0.0

isOnlineOnly

If the set is only available in online game play variations.

  • Type: boolean
  • Introduced: v4.0.0

isPaperOnly O

If the set is only available in paper game play.

  • Type: boolean
  • Introduced: v4.6.2

isPartialPreview O

If the set is still in preview (spoiled). Preview sets do not have complete data.

  • Type: boolean
  • Introduced: v4.4.2

keyruneCode

The matching Keyrune code for set image icons.

  • Type: string
  • Introduced: v4.3.2

languages O

The languages the set was printed in.

  • Type: string[]
  • Introduced: v5.2.1

mcmId O

The Cardmarket set identifier.

  • Type: number
  • Introduced: v4.4.0

mcmIdExtras O

The split Cardmarket set identifier if a set is printed in two sets. This identifier represents the second set's identifier.

  • Type: number
  • Introduced: v5.1.0

mcmName O

The Cardmarket set name.

  • Type: string
  • Introduced: v4.4.0

mtgoCode O

The set code for the set as it appears on Magic: The Gathering Online.

  • Type: string
  • Introduced: v4.0.0

name

The name of the set.

  • Type: string
  • Introduced: v4.0.0

parentCode O

The parent printing set code for set variations like promotions, guild kits, etc.

  • Type: string
  • Introduced: v4.3.0

releaseDate

The release date in ISO 8601 format for the set.

  • Type: string
  • Introduced: v4.0.0

sealedProduct O

The sealed product information for the set. See the Sealed Product Data Model.

  • Type: SealedProduct[]
  • Introduced: v5.1.0

tcgplayerGroupId O

The group identifier of the set on TCGplayer.

  • Type: number
  • Introduced: v4.2.1

totalSetSize

The total number of cards in the set, including promos and related supplemental products.

  • Type: number
  • Introduced: v4.1.0

tokenSetCode O

The tokens set code, formatted in uppercase.

  • Type: string
  • Introduced: v5.2.1

translations

The translated set name by language. See the Translations Data Model.

  • Type: Translations
  • Introduced: v4.3.2

type

The expansion type of the set.

  • Type: string
  • Introduced: v4.0.0