mightstone.services.mtgjson.models.SetList
- pydantic model mightstone.services.mtgjson.models.SetList
The Set List Data Model describes a metadata-like properties and values for an individual Set.
Show JSON schema
{ "title": "SetList", "description": "The Set List Data Model describes a metadata-like properties and values for an\nindividual Set.", "type": "object", "properties": { "id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "baseSetSize": { "since": "v4.1.0", "title": "Basesetsize", "type": "integer" }, "block": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.0.0", "title": "Block" }, "code": { "since": "v4.0.0", "title": "Code", "type": "string" }, "codeV3": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.2.1", "title": "Codev3" }, "isForeignOnly": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "since": "v4.4.1", "title": "Isforeignonly" }, "isFoilOnly": { "since": "v4.0.0", "title": "Isfoilonly", "type": "boolean" }, "isNonFoilOnly": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "since": "v5.0.0", "title": "Isnonfoilonly" }, "isOnlineOnly": { "since": "v4.0.0", "title": "Isonlineonly", "type": "boolean" }, "isPaperOnly": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "since": "v4.6.2", "title": "Ispaperonly" }, "isPartialPreview": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "since": "v4.4.2", "title": "Ispartialpreview" }, "keyruneCode": { "since": "v4.3.2", "title": "Keyrunecode", "type": "string" }, "mcmId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "since": "v4.4.0", "title": "Mcmid" }, "mcmIdExtras": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "since": "v5.1.0", "title": "Mcmidextras" }, "mcmName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.4.0", "title": "Mcmname" }, "mtgoCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.0.0", "title": "Mtgocode" }, "name": { "since": "v4.0.0", "title": "Name", "type": "string" }, "parentCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.3.0", "title": "Parentcode" }, "releaseDate": { "format": "date", "since": "v4.0.0", "title": "Releasedate", "type": "string" }, "sealedProduct": { "anyOf": [ { "items": { "$ref": "#/$defs/SealedProduct" }, "type": "array" }, { "type": "null" } ], "default": null, "since": "v5.1.0", "title": "Sealedproduct" }, "tcgplayerGroupId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "since": "v4.2.1", "title": "Tcgplayergroupid" }, "totalSetSize": { "since": "v4.1.0", "title": "Totalsetsize", "type": "integer" }, "translations": { "allOf": [ { "$ref": "#/$defs/Translations" } ], "since": "v4.3.2" }, "type": { "since": "v4.0.0", "title": "Type", "type": "string" } }, "$defs": { "Identifiers": { "properties": { "cardKingdomEtchedId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v5.2.0", "title": "Cardkingdometchedid" }, "cardKingdomFoilId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v5.0.0", "title": "Cardkingdomfoilid" }, "cardKingdomId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v5.0.0", "title": "Cardkingdomid" }, "cardsphereId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v5.2.1", "title": "Cardsphereid" }, "mcmId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.4.0", "title": "Mcmid" }, "mcmMetaId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.4.0", "title": "Mcmmetaid" }, "mtgArenaId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.5.0", "title": "Mtgarenaid" }, "mtgjsonFoilVersionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v5.2.1", "title": "Mtgjsonfoilversionid" }, "mtgjsonNonFoilVersionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v5.2.1", "title": "Mtgjsonnonfoilversionid" }, "mtgoFoilId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.5.0", "title": "Mtgofoilid" }, "mtgoId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.5.0", "title": "Mtgoid" }, "mtgjsonV4Id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v5.0.0", "title": "Mtgjsonv4Id" }, "multiverseId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.0.0", "title": "Multiverseid" }, "scryfallId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.0.0", "title": "Scryfallid" }, "scryfallOracleId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.3.1", "title": "Scryfalloracleid" }, "scryfallIllustrationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.3.1", "title": "Scryfallillustrationid" }, "tcgplayerProductId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.2.1", "title": "Tcgplayerproductid" }, "tcgplayerEtchedProductId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v5.2.0", "title": "Tcgplayeretchedproductid" } }, "title": "Identifiers", "type": "object" }, "PurchaseUrls": { "properties": { "cardKingdom": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v5.0.0", "title": "Cardkingdom" }, "cardKingdomEtched": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v5.2.0", "title": "Cardkingdometched" }, "cardKingdomFoil": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v5.0.0", "title": "Cardkingdomfoil" }, "cardmarket": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.4.0", "title": "Cardmarket" }, "tcgplayer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.4.0", "title": "Tcgplayer" }, "tcgplayerEtched": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v5.2.0", "title": "Tcgplayeretched" } }, "title": "PurchaseUrls", "type": "object" }, "SealedProduct": { "properties": { "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v5.2.1", "title": "Category" }, "identifiers": { "allOf": [ { "$ref": "#/$defs/Identifiers" } ], "since": "v5.2.0" }, "name": { "since": "v5.2.0", "title": "Name", "type": "string" }, "productSize": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "since": "v5.2.1", "title": "Productsize" }, "purchaseUrls": { "allOf": [ { "$ref": "#/$defs/PurchaseUrls" } ], "since": "v5.2.0" }, "releaseDate": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "since": "v5.2.0", "title": "Releasedate" }, "subtype": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v5.2.1", "title": "Subtype" }, "uuid": { "format": "uuid", "since": "v5.2.0", "title": "Uuid", "type": "string" } }, "required": [ "identifiers", "name", "purchaseUrls", "uuid" ], "title": "SealedProduct", "type": "object" }, "Translations": { "description": "The Translations Data Model describes a Set name translated per available language.", "properties": { "Ancient Greek": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.6.0", "title": "Ancient Greek" }, "Arabic": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.6.0", "title": "Arabic" }, "Chinese Simplified": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.0.0", "title": "Chinese Simplified" }, "Chinese Traditional": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.6.0", "title": "Chinese Traditional" }, "French": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.0.0", "title": "French" }, "German": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.0.0", "title": "German" }, "Hebrew": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.6.0", "title": "Hebrew" }, "Italian": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.0.0", "title": "Italian" }, "Japanese": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.0.0", "title": "Japanese" }, "Korean": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.0.0", "title": "Korean" }, "Latin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.6.0", "title": "Latin" }, "Phyrexian": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.7.0", "title": "Phyrexian" }, "Portuguese (Brazil)": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.0.0", "title": "Portuguese (Brazil)" }, "Russian": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.0.0", "title": "Russian" }, "Sanskrit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.6.0", "title": "Sanskrit" }, "Spanish": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "since": "v4.0.0", "title": "Spanish" } }, "title": "Translations", "type": "object" } }, "required": [ "baseSetSize", "code", "isFoilOnly", "isOnlineOnly", "keyruneCode", "name", "releaseDate", "totalSetSize", "translations", "type" ] }
- Fields:
- Validators:
- field baseSetSize: int [Required]
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.
- Validated by:
enforce_id
- field block: str | None = None
The block name the set was in.
- Validated by:
enforce_id
- field code: str [Required]
The set code for the set.
- Validated by:
enforce_id
- field code_v3: str | None = None (alias 'codeV3')
The alternate set code Wizards of the Coast uses for a select few duel deck sets.
- Validated by:
enforce_id
- field is_foil_only: bool [Required] (alias 'isFoilOnly')
If the set is only available in foil.
- Validated by:
enforce_id
- field is_foreign_only: bool | None = None (alias 'isForeignOnly')
If the set is available only outside the United States of America.
- Validated by:
enforce_id
- field is_non_foil_only: bool | None = None (alias 'isNonFoilOnly')
If the set is only available in non-foil.
- Validated by:
enforce_id
- field is_online_only: bool [Required] (alias 'isOnlineOnly')
If the set is only available in online game variations.
- Validated by:
enforce_id
- field is_paper_only: bool | None = None (alias 'isPaperOnly')
If the set is only available in paper.
- Validated by:
enforce_id
- field is_partial_preview: bool | None = None (alias 'isPartialPreview')
If the set is still in preview (spoiled). Preview sets do not have complete data.
- Validated by:
enforce_id
- field keyrune_code: str [Required] (alias 'keyruneCode')
The matching Keyrune code for set image icons.
- Validated by:
enforce_id
- field mcm_id: int | None = None (alias 'mcmId')
The Magic Card Market set identifier.
- Validated by:
enforce_id
- field mcm_id_extras: int | None = None (alias 'mcmIdExtras')
The split Magic Card Market set identifier if a set is printed in two sets. This identifier represents the second set’s identifier.
- Validated by:
enforce_id
- field mcm_name: str | None = None (alias 'mcmName')
The Magic Card Market set name.
- Validated by:
enforce_id
- field mtgo_code: str | None = None (alias 'mtgoCode')
The set code for the set as it appears on Magic: The Gathering Online.
- Validated by:
enforce_id
- field name: str [Required]
The name of the set.
- Validated by:
enforce_id
- field parent_code: str | None = None (alias 'parentCode')
The parent set code for set variations like promotions, guild kits, etc.
- Validated by:
enforce_id
- field release_date: date [Required] (alias 'releaseDate')
The release date in ISO 8601 format for the set.
- Validated by:
enforce_id
- field sealed_product: List[SealedProduct] | None = None (alias 'sealedProduct')
The sealed product information for the set. See the Sealed Product Data Model.
- Validated by:
enforce_id
- field tcgplayer_group_id: int | None = None (alias 'tcgplayerGroupId')
The group identifier of the set on TCGplayer.
- Validated by:
enforce_id
- field total_set_size: int [Required] (alias 'totalSetSize')
The total number of cards in the set, including promos and related supplemental products.
- Validated by:
enforce_id
- field translations: Translations [Required]
The translated set name by language. See the Translations Data Model.
- Validated by:
enforce_id
- field type: str [Required]
The expansion type of the set. Examples: “alchemy”, “archenemy”, “arsenal”, “box”, “commander”
- Validated by:
enforce_id