scryfall-sdk

A Node.js SDK for Scryfall written in Typescript.

As of August 8th, 2024, all features described in the Scryfall documentation should be supported. If you see something that isn't, make an issue!

Installation

batCopy
npm install scryfall-sdk

Using a node.js version older than v18?

Install the axios dependency alongside scryfall-sdk and it will automatically use it.

Basic Example Usage

tsCopy
import * as Scry from "scryfall-sdk";

// ...in some function somewhere...
const chalice = await Scry.Cards.byName("Chalice of the Void");
console.log(chalice.name, chalice.set); // "Chalice of the Void", "a25"

const prints = await chalice.getPrints();
console.log(prints.length); // 7

[!IMPORTANT]
Scryfall requires that all applications provide an agent, except if they are executing from web browser JavaScript.

If this is true for your application, you must set your agent before making any requests:

tsCopy
Scry.setAgent("MyAmazingAppName", "1.0.0");

Full Documentation

scryfall-sdk supports all features of Scryfall, along with automatically paginating through results, downloading bulk data streams, and more. See the documentation for information on everything you can do.

Know the endpoint you want, but not sure what it looks like in scryfall-sdk? Well, you're in luck: Scryfall-SDK Equivalents for Scryfall Routes

Contributing

Thanks for wanting to help out! Here's the setup you'll have to do:

batCopy
git clone https://github.com/ChiriVulpes/scryfall-sdk
cd scryfall-sdk
npm install

You can now make changes to the repository.

To compile, then test:

batCopy
gulp build

To compile and then test on every file change:

batCopy
gulp watch

MIT License

Copyright 2017-2024 Chiri Vulpes