BulkDataApi

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

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

Constructors

Link copied to clipboard
constructor(config: ScryfallConfig = ScryfallConfig(), engine: HttpClientEngine? = null, logger: (String) -> Unit? = null)

Functions

Link copied to clipboard
suspend fun all(format: String? = "json", pretty: Boolean? = false): ScryfallList<BulkData>

Returns a List object of all Bulk Data items on Scryfall. https://scryfall.com/docs/api/bulk-data/all

Link copied to clipboard
suspend fun byId(id: String, format: String? = "json", pretty: Boolean? = false): BulkData

Returns a Bulk Data object with the given Scryfall id. https://scryfall.com/docs/api/bulk-data/id

Link copied to clipboard
suspend fun byType(type: String, format: String? = "json", pretty: Boolean? = false): BulkData

Returns a Bulk Data object with the given type slug (e.g., oracle-cards, default-cards). https://scryfall.com/docs/api/bulk-data/type