ScryfallApiClient class

Dart API Client that wraps the Scryfall API.

Constructors

ScryfallApiClient({Client? httpClient})
Dart API Client that wraps the Scryfall API.

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

autocompleteCardName(String query, {bool? includeExtras}) Future<Catalog>
GET /cards/autocomplete
close() → void
Closes the connection to the Scryfall server.
getAbilityWords() Future<Catalog>
GET /catalog/ability-words
getAllCardSymbols() Future<PaginableList<CardSymbol>>
GET /symbology
getAllSets() Future<PaginableList<MtgSet>>
GET /sets
getArtifactTypes() Future<Catalog>
GET /catalog/artifact-types
getArtistNames() Future<Catalog>
GET /catalog/artist-names
getBulkData() Future<PaginableList<BulkData>>
GET /bulk-data
getBulkDataAllCards() Future<List<MtgCard>>
GET /bulk-data/all-cards?format=file
getBulkDataById(String id) Future<BulkData>
GET /bulk-data/:id
getBulkDataByIdAsFile(String id) Future<Uint8List>
GET /bulk-data/:id?format=file
getBulkDataByType(BulkDataType type) Future<BulkData>
GET /bulk-data/:type
getBulkDataByTypeAsFile(BulkDataType type) Future<Uint8List>
GET /bulk-data/:type?format=file
getBulkDataDefaultCards() Future<List<MtgCard>>
GET /bulk-data/default-cards?format=file
getBulkDataOracleCards() Future<List<MtgCard>>
GET /bulk-data/oracle-cards?format=file
getBulkDataRulings() Future<List<Ruling>>
GET /bulk-data/rulings?format=file
getBulkDataUniqueArtwork() Future<List<MtgCard>>
GET /bulk-data/unique-artwork?format=file
getCardByArenaId(int arenaId) Future<MtgCard>
GET /cards/arena/:id
getCardByArenaIdAsImage(int arenaId, {bool? backFace, ImageVersion? imageVersion}) Future<Uint8List>
GET /cards/arena/:id?format=image
getCardByCardmarketId(int cardmarketId) Future<MtgCard>
GET /cards/cardmarket/:id
getCardByCardmarketIdAsImage(int cardmarketId, {bool? backFace, ImageVersion? imageVersion}) Future<Uint8List>
GET /cards/cardmarket/:id?format=image
getCardById(String id) Future<MtgCard>
GET /cards/:id
getCardByIdAsImage(String id, {bool? backFace, ImageVersion? imageVersion}) Future<Uint8List>
GET /cards/:id?format=image
getCardByMtgoId(int mtgoId) Future<MtgCard>
GET /cards/mtgo/:id
getCardByMtgoIdAsImage(int mtgoId, {bool? backFace, ImageVersion? imageVersion}) Future<Uint8List>
GET /cards/mtgo/:id?format=image
getCardByMultiverseId(int multiverseId) Future<MtgCard>
GET /cards/multiverse/:id
getCardByMultiverseIdAsImage(int multiverseId, {bool? backFace, ImageVersion? imageVersion}) Future<Uint8List>
GET /cards/multiverse/:id?format=image
getCardByName(String name, {SearchType searchType = SearchType.exact, String? set}) Future<MtgCard>
GET /cards/named
getCardByNameAsImage(String name, {SearchType searchType = SearchType.exact, String? set, bool? backFace, ImageVersion? imageVersion}) Future<Uint8List>
GET /cards/named?format=image
getCardBySetCodeAndCollectorNumber(String setCode, String collectorNumber, {Language? language}) Future<MtgCard>
GET /cards/:code/:number(/:lang)
getCardBySetCodeAndCollectorNumberAsImage(String setCode, String collectorNumber, {Language? language, bool? backFace, ImageVersion? imageVersion}) Future<Uint8List>
GET /cards/:code/:number(/:lang)?format=image
getCardByTcgplayerId(int tcgplayerId) Future<MtgCard>
GET /cards/tcgplayer/:id
getCardByTcgplayerIdAsImage(int tcgplayerId, {bool? backFace, ImageVersion? imageVersion}) Future<Uint8List>
GET /cards/tcgplayer/:id?format=image
getCardNames() Future<Catalog>
GET /catalog/card-names
getCardsByIdentifiers(List<CardIdentifier> identifiers) Future<CardList>
POST /cards/collection
getCatalog(CatalogType catalogType) Future<Catalog>
GET /catalog/:catalog-type
getCreatureTypes() Future<Catalog>
GET /catalog/creature-types
getEnchantmentTypes() Future<Catalog>
GET /catalog/enchantment-types
getKeywordAbilities() Future<Catalog>
GET /catalog/keyword-abilities
getKeywordActions() Future<Catalog>
GET /catalog/keyword-actions
getLandTypes() Future<Catalog>
GET /catalog/land-types
getLoyalties() Future<Catalog>
GET /catalog/loyalties
getMigration(String id) Future<Migration>
GET /migrations/:id
getMigrations() Future<PaginableList<Migration>>
GET /migrations
getPlaneswalkerTypes() Future<Catalog>
GET /catalog/planeswalker-types
getPowers() Future<Catalog>
GET /catalog/powers
getRandomCard({String? query}) Future<MtgCard>
GET /cards/random
getRandomCardAsImage({String? query, bool? backFace, ImageVersion? imageVersion}) Future<Uint8List>
GET /cards/random?format=image
getRulingsByArenaId(int arenaId) Future<PaginableList<Ruling>>
GET /cards/arena/:id/rulings
getRulingsById(String id) Future<PaginableList<Ruling>>
GET /cards/:id/rulings
getRulingsByMtgoId(int mtgoId) Future<PaginableList<Ruling>>
GET /cards/mtgo/:id/rulings
getRulingsByMultiverseId(int multiverseId) Future<PaginableList<Ruling>>
GET /cards/multiverse/:id/rulings
getRulingsBySetCodeAndCollectorNumber(String setCode, String collectorNumber) Future<PaginableList<Ruling>>
GET /cards/:code/:number/rulings
getSetByCode(String code) Future<MtgSet>
Get /sets/:code
getSetById(String id) Future<MtgSet>
GET /sets/:id
getSetByTcgplayerId(int tcgplayerId) Future<MtgSet>
GET /sets/tcgplayer/:id
getSpellTypes() Future<Catalog>
GET /catalog/spell-types
getToughnesses() Future<Catalog>
GET /catalog/toughnesses
getWatermarks() Future<Catalog>
GET /catalog/watermarks
getWordBank() Future<Catalog>
GET /catalog/word-bank
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
parseMana(String manaCost) Future<ManaCost>
GET /symbology/parse-mana
searchCards(String searchQuery, {RollupMode? rollupMode, SortingOrder? sortingOrder, SortingDirection? sortingDirection, bool? includeExtras, bool? includeMultilingual, bool? includeVariations, int? page}) Future<PaginableList<MtgCard>>
GET /cards/search
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited