scryfall-api/devmugi.mtgcards.scryfall.api.models

Package-level declarations

Types

@Serializable

data class AutocompleteResult(val objectType: String, val totalValues: Int, val data: List<String>)

@Serializable

data class BulkData(val objectType: String = "bulk_data", val id: String, val uri: String, val type: String, val name: String, val description: String, val downloadUri: String, val updatedAt: String, val size: Long, val contentType: String, val contentEncoding: String)

Card

@Serializable

data class Card(val arenaId: Int? = null, val id: String, val language: String, val mtgoId: Int? = null, val mtgoFoilId: Int? = null, val multiverseIds: List<Int>? = null, val tcgplayerId: Int? = null, val tcgplayerEtchedId: Int? = null, val cardmarketId: Int? = null, val resourceId: String? = null, val objectType: String, val layout: String, val oracleId: String? = null, val printsSearchUri: String, val rulingsUri: String, val scryfallUri: String, val uri: String, val allParts: List<RelatedCard>? = null, val cardFaces: List<CardFace>? = null, val manaValue: Double = 0.0, val colorIdentity: List<String> = emptyList(), val colorIndicator: List<String>? = null, val colors: List<String>? = null, val defense: String? = null, val edhrecRank: Int? = null, val gameChanger: Boolean? = null, val handModifier: String? = null, val keywords: List<String> = emptyList(), val legalities: Legalities = Legalities(), val lifeModifier: String? = null, val loyalty: String? = null, val manaCost: String? = null, val name: String, val oracleText: String? = null, val oversized: Boolean = false, val pennyRank: Int? = null, val power: String? = null, val producedMana: List<String>? = null, val reserved: Boolean = false, val toughness: String? = null, val typeLine: String, val artist: String? = null, val artistIds: List<String>? = null, val attractionLights: List<Int>? = null, val booster: Boolean = false, val borderColor: String, val cardBackId: String? = null, val collectorNumber: String, val contentWarning: Boolean? = null, val digital: Boolean, val finishes: List<String> = emptyList(), val flavorName: String? = null, val flavorText: String? = null, val frameEffects: List<String>? = null, val frame: String, val fullArt: Boolean, val games: List<String> = emptyList(), val highresImage: Boolean, val illustrationId: String? = null, val imageStatus: String, val imageUris: ImageUris? = null, val prices: Prices? = Prices(), val printedName: String? = null, val printedText: String? = null, val printedTypeLine: String? = null, val promo: Boolean, val promoTypes: List<String>? = null, val purchaseUris: Map<String, String>? = null, val rarity: String, val relatedUris: Map<String, String>, val releasedAt: String, val reprint: Boolean, val scryfallSetUri: String, val setName: String, val setSearchUri: String, val setType: String, val setUri: String, val setCode: String, val setId: String, val storySpotlight: Boolean, val textless: Boolean, val variation: Boolean, val variationOf: String? = null, val securityStamp: String? = null, val watermark: String? = null, val preview: Preview? = null)

CardFace

@Serializable

data class CardFace(val artist: String? = null, val artistId: String? = null, val manaValue: Double? = null, val colorIndicator: List<String>? = null, val colors: List<String>? = null, val defense: String? = null, val flavorText: String? = null, val illustrationId: String? = null, val imageUris: ImageUris? = null, val layout: String? = null, val loyalty: String? = null, val manaCost: String, val name: String, val objectType: String, val oracleId: String? = null, val oracleText: String? = null, val power: String? = null, val printedName: String? = null, val printedText: String? = null, val printedTypeLine: String? = null, val toughness: String? = null, val typeLine: String? = null, val watermark: String? = null)

Individual face information for multiface cards.

CardSymbol

@Serializable

data class CardSymbol(val objectType: String = "card_symbol", val symbol: String, val looseVariant: String? = null, val english: String, val transposable: Boolean, val representsMana: Boolean, val manaValue: Double? = null, val appearsInManaCosts: Boolean, val funny: Boolean, val colors: List<String>, val hybrid: Boolean, val phyrexian: Boolean, val gathererAlternates: List<String>? = null, val svgUri: String? = null)

https://scryfall.com/docs/api/card-symbols

Catalog

@Serializable

data class Catalog(val objectType: String = "catalog", val uri: String, val totalValues: Int, val data: List<String>)

Identifier

@Serializable

data class Identifier(val id: String? = null, val oracleId: String? = null, val illustrationId: String? = null, val multiverseId: Int? = null, val mtgoId: Int? = null, val arenaId: Int? = null, val set: String? = null, val collectorNumber: String? = null, val name: String? = null)

IdentifiersRequest

@Serializable

data class IdentifiersRequest(val identifiers: List<Identifier>, val pretty: Boolean? = false)

ImageUris

@Serializable

data class ImageUris(val small: String? = null, val normal: String? = null, val large: String? = null, val png: String? = null, val artCrop: String? = null, val borderCrop: String? = null)

Available imagery for a card or card face.

Legalities

@Serializable

data class Legalities(val standard: String? = null, val future: String? = null, val historic: String? = null, val timeless: String? = null, val gladiator: String? = null, val pioneer: String? = null, val explorer: String? = null, val modern: String? = null, val legacy: String? = null, val pauper: String? = null, val vintage: String? = null, val penny: String? = null, val commander: String? = null, val oathbreaker: String? = null, val brawl: String? = null, val historicBrawl: String? = null, val alchemy: String? = null, val pauperCommander: String? = null, val duel: String? = null, val oldschool: String? = null, val premodern: String? = null, val predh: String? = null, val standardBrawl: String? = null)

Legal status for each supported format. Possible legalities are legal, not_legal, restricted, and banned.

NotFound

@Serializable

data class NotFound(val objectType: String = "not_found", val name: String? = null, val set: String? = null, val collectorNumber: String? = null, val type: String? = null)

ParsedManaCost

@Serializable

data class ParsedManaCost(val objectType: String = "mana_cost", val cost: String, val cmc: Double, val colors: List<String>, val colorless: Boolean, val monocolored: Boolean, val multicolored: Boolean)

https://scryfall.com/docs/api/card-symbols/parse-mana

Preview

@Serializable

data class Preview(val previewedAt: String? = null, val sourceUri: String? = null, val source: String? = null)

Preview metadata supplied by Scryfall.

Prices

@Serializable

data class Prices(val usd: String? = null, val usdFoil: String? = null, val usdEtched: String? = null, val eur: String? = null, val eurFoil: String? = null, val eurEtched: String? = null, val tix: String? = null)

Price information in multiple currencies.

RelatedCard

@Serializable

data class RelatedCard(val id: String, val objectType: String, val component: String, val name: String, val typeLine: String, val uri: String)

Related card reference (meld parts, combo pieces, tokens, etc.).

Ruling

@Serializable

data class Ruling(val objectType: String = "ruling", val oracleId: String, val source: String, val publishedAt: String, val comment: String)

ScryfallError

@Serializable

data class ScryfallError(val objectType: String = "error", val code: String? = null, val status: Int? = null, val details: String? = null, val type: String? = null, val warnings: List<String>? = null)

ScryfallList

@Serializable

data class ScryfallList<T>(val objectType: String = "list", val hasMore: Boolean = false, val nextPage: String? = null, val totalCards: Int? = null, val data: List<T> = emptyList(), val warnings: List<String>? = null, val notFound: List<NotFound>? = null)

A List object represents a requested sequence of other objects (Cards, Sets, etc). List objects may be paginated, and also include information about issues raised when generating the list. https://scryfall.com/docs/api/lists

Set

@Serializable

data class Set(val objectType: String = "set", val id: String, val code: String, val mtgoCode: String? = null, val arenaCode: String? = null, val tcgplayerId: Int? = null, val name: String, val setType: String, val releasedAt: String? = null, val blockCode: String? = null, val block: String? = null, val parentSetCode: String? = null, val cardCount: Int, val printedSize: Int? = null, val digital: Boolean = false, val foilOnly: Boolean, val nonfoilOnly: Boolean, val scryfallUri: String, val uri: String, val iconSvgUri: String, val searchUri: String)

A Set object represents a group of related Magic cards. All Card objects on Scryfall belong to exactly one set. https://scryfall.com/docs/api/sets

SortDirection

enum SortDirection : Enum<SortDirection>

The direction to sort the cards. If not provided, Scryfall chooses a reasonable default for the order.

SortingCards

enum SortingCards : Enum<SortingCards>

The order parameter determines how Scryfall should sort the returned cards.

UniqueModes

enum UniqueModes : Enum<UniqueModes>

The unique parameter specifies if Scryfall should remove “duplicate” results in your query. The options are: