scryfall-api/devmugi.mtgcards.scryfall.api

Package-level declarations

Types

class BulkDataApi(config: ScryfallConfig = ScryfallConfig(), engine: HttpClientEngine? = null, logger: (String) -> Unit? = null) : ScryfallBaseApi

Bulk Data endpoints. https://scryfall.com/docs/api/bulk-data

CardsApi

class CardsApi(config: ScryfallConfig = ScryfallConfig(), engine: HttpClientEngine? = null, logger: (String) -> Unit? = null) : ScryfallBaseApi

https://scryfall.com/docs/api/cards

CardSymbolApi

class CardSymbolApi(config: ScryfallConfig = ScryfallConfig(), engine: HttpClientEngine? = null, logger: (String) -> Unit? = null) : ScryfallBaseApi

Card Symbols (Symbology) endpoints. https://scryfall.com/docs/api/card-symbols

CatalogsApi

class CatalogsApi(config: ScryfallConfig = ScryfallConfig(), engine: HttpClientEngine? = null, logger: (String) -> Unit? = null) : ScryfallBaseApi

Catalogs are small curated lists of Magic data such as creature types and card names. https://scryfall.com/docs/api/catalogs

RulingsApi

class RulingsApi(config: ScryfallConfig = ScryfallConfig(), engine: HttpClientEngine? = null, logger: (String) -> Unit? = null) : ScryfallBaseApi

Rulings represent Oracle rulings, Wizards of the Coast set release notes, or Scryfall notes for a particular card. https://scryfall.com/docs/api/rulings

SearchQueryBuilder

class SearchQueryBuilder

A DSL builder for constructing Scryfall search queries in a type-safe way.

SetsApi

class SetsApi(config: ScryfallConfig = ScryfallConfig(), engine: HttpClientEngine? = null, logger: (String) -> Unit? = null) : ScryfallBaseApi

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

Functions

searchQuery

fun searchQuery(builder: SearchQueryBuilder.() -> Unit): String

Creates a Scryfall search query using the DSL builder.

searchWithBuilder

suspend fun CardsApi.searchWithBuilder(unique: UniqueModes? = null, order: SortingCards? = null, dir: SortDirection? = null, includeExtras: Boolean = false, includeMultilingual: Boolean = false, includeVariations: Boolean = false, page: Int = 1, builder: SearchQueryBuilder.() -> Unit): ScryfallList<Card>

Searches for cards using the DSL query builder instead of a raw query string.