scryfall-api/devmugi.mtgcards.scryfall.js/CardsApiJs

CardsApiJs

class CardsApiJs(config: ScryfallConfig = ScryfallConfig())

JavaScript-friendly wrapper for CardsApi.

Usage:

const api = new CardsApiJs();
const results = await api.search('lightning bolt', { unique: 'prints' });
const card = await api.random();

Constructors

constructor(config: ScryfallConfig = ScryfallConfig())

Functions

fun autocomplete(q: String, options: AutocompleteOptions?): Promise<JsAutocompleteResult>

Get autocomplete suggestions for card names.

fun byArenaId(id: Int): Promise<JsCard>

Get a card by Arena ID.

fun byCardmarketId(id: Int): Promise<JsCard>

Get a card by Cardmarket ID.

fun byMtgoId(id: Int): Promise<JsCard>

Get a card by MTGO ID.

fun byMultiverseId(id: Int): Promise<JsCard>

Get a card by Multiverse ID.

fun byScryfallId(id: String): Promise<JsCard>

Get a card by Scryfall ID.

bySetAndCollectorNumber

fun bySetAndCollectorNumber(code: String, number: String, options: CollectorOptions?): Promise<JsCard>

Get a card by set code and collector number.

fun byTcgplayerId(id: Int): Promise<JsCard>

Get a card by TCGPlayer ID.

fun collection(identifiers: Array<JsIdentifier>): Promise<JsScryfallCardList>

Fetch multiple cards at once by their identifiers. Maximum of 75 identifiers per request.

fun namedExact(name: String, options: CardOptions?): Promise<JsCard>

Get a card by exact name.

fun namedFuzzy(name: String, options: CardOptions?): Promise<JsCard>

Get a card by fuzzy name match.

fun random(options: RandomOptions?): Promise<JsCard>

Get a random card.

fun search(q: String, options: SearchOptions?): Promise<JsScryfallCardList>

Search for cards using Scryfall fulltext search syntax.