scryfall-api/devmugi.mtgcards.scryfall.api/SearchQueryBuilder

SearchQueryBuilder

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

This builder provides a more intuitive and IDE-friendly way to construct search queries compared to manually building query strings with Scryfall syntax.

Example usage:

val query = searchQuery {
    type("creature")
    color("red")
    powerRange(min = 4)
    cmcRange(max = 5)
    isLegal("standard")
}

Constructors

SearchQueryBuilder

constructor()

Functions

artist

fun artist(name: String)

Searches for cards by artist name.

build

fun build(): String

Builds the final query string by joining all parts with spaces.

cmc

fun cmc(value: Int)

Filters by exact converted mana cost/mana value.

cmcRange

fun cmcRange(min: Int? = null, max: Int? = null)

Filters by converted mana cost/mana value range.

color

fun color(vararg colors: String)

Filters by exact color identity.

format

fun format(format: String)

Filters by format (Standard, Modern, Legacy, Vintage, Commander, etc.). This finds cards printed in a format, regardless of legality.

isLegal

fun isLegal(format: String)

Filters by cards that are legal in a specific format.

keyword

fun keyword(keyword: String)

Filters by keyword ability.

name

fun name(value: String)

Adds an exact name match to the query. This will match only cards with exactly the specified name.

nameContains

fun nameContains(value: String)

Adds a partial name match to the query. This will match cards whose names contain the specified text.

power

fun power(value: Int)

Filters by exact power.

powerRange

fun powerRange(min: Int? = null, max: Int? = null)

Filters by power range.

rarity

fun rarity(value: String)

Filters by rarity.

raw

fun raw(queryPart: String)

Adds a raw query string part. Use this for advanced queries that aren't covered by the DSL methods.

set

fun set(code: String)

Filters by set code.

text

fun text(value: String)

Searches for text in the oracle text.

toughness

fun toughness(value: Int)

Filters by exact toughness.

toughnessRange

fun toughnessRange(min: Int? = null, max: Int? = null)

Filters by toughness range.

type

fun type(value: String)

Filters by card type.

SearchQueryBuilder

See also

Constructors

Functions