Scryfall API Client
- Search for cards
- Get rulings for cards
Self-hosted Scryfall
- Can import Scryfall's bulk data exports
- Exposes the same REST API as scryfall.com

Examples

Scryfall

stax has built-in support for the Scryfall API. You can use it to search for cards, download bulk data, and more.

Searching for a Card

When searching for a card, the query is passed to the Scryfall API as is. The best resource for learning how to write these queries is the Scryfall Search Reference.

# Find all cards that have the type creature and a CMC less than 5
# You don't have to use quotes, but your shell may interpret symbols like < and >
# as IO redirection.
stax scryfall search "cmc<5 AND type:creature"

Getting Rulings For A Card

You can retrieve the rulings for a card by name using the rulings subcommand.

# Print all the rulings for the card Winter Orb
stax scryfall rulings Winter Orb

Generating HTML From The Comprehensive Rules

To generate HTML from the comprehensive rules, you first need to download a copy of the rules from Wizards of the Coast's website. Click on the TXT link to download the rules as a text file.

Then run:

stax rules html /path/to/rules.txt

You can specify a path to output the HTML file to using the --output flag.

stax rules html /path/to/rules.txt --output /path/to/output.html

Self-hosted Scryfall API

To start a self-hosted Scryfall API, you first need to download and load the bulk data.

This command will download the latest bulk data export from Scryfall and load it into a SQLite database.

stax bones load --http

# or if you want to manually download a bulk data file

stax bones load /path/to/bulk/data/file.json

Once the bulk data is loaded, you can start the API by running:

stax api

If you want to run it on a different port or IP (default is 0.0.0.0:8765), you can use the --listen flag:

stax api --listen 127.0.0.1:8766

# Packages

cmd

No description provided by the author

pkg

No description provided by the author