scryfall/src/ScryfallSet.ts

A simple wrapper around Scryfall's public API.

import { ScryfallSetType } from "./ScryfallSetType";

/**
 * A Set object represents a group of related Magic cards. All cards on Scryfall belong to exactly one set.
 */
export interface ScryfallSet {
    /**
     * Object code - should equal set.
     */
    object: "set";
    /**
     * The unique three or four-letter code for this set. Officially released sets always have a three-letter set code; four-letter set codes exist simply for categorization purposes.
     */
    code: string;
    /**
     * The unique code for this set on Magic Online, which may differ from the regular code.
     */
    mtgo_code: string;
    /**
     * The English name of the set.
     */
    name: string;
    /**
     * The type of set (e.g. core, expansion, masters).
     */
    set_type: ScryfallSetType;
    /**
     * The date the set was released (in GMT-8 Pacific time). Not all sets have a known release date.
     */
    released_at?: Date;
    /**
     * The block code for this set, if any.
     */
    block_code?: string;
    /**
     * The block or group name code for this set, if any.
     */
    block?: string;
    /**
     * The set code for the parent set, if any. Promo and Token sets often have a parent set.
     */
    parent_set_code: string;
    /**
     * The number of cards in this set.
     */
    card_count: number;
    /**
     * True if this set was only released on Magic Online.
     */
    digital: boolean;
    /**
     * True if this set contains only foil cards.
     */
    foil_only: boolean;
    /**
     * A URI to an SVG file for this set’s icon on Scryfall’s CDN.
     */
    icon_svg_uri: string;
    /**
     * A Scryfall API URI that you can request to begin paging through the cards in this set.
     */
    search_uri: string;
}