scryfall-sdk

A Node.js SDK for https://scryfall.com/docs/api-overview written in Typescript.

As of February 14th, 2019, all features of https://scryfall.com/docs/api-methods are supported. If you see something in the Scryfall documentation that isn't supported, make an issue! See support readme.

Installation

npm install scryfall-sdk

Documentation

Contributing

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

git clone https://github.com/Yuudaari/scryfall-sdk
git clone https://github.com/Yuudaari/tslint.json
cd scryfall-sdk
npm install

You can now make changes to the repository.

To compile, then test:

gulp build

To compile and then test on every file change:

gulp watch

If you want to make large, complex changes, make an issue before creating a PR. If I disagree with the changes you want to make, and you've already made them all in a PR, it'll feel a lot worse than being shot down in an issue, before you've written it all.

Pull Requests may be rejected if outside of the scope of the SDK, or not following the formatting rules. If tslint complains, I will complain. Please don't be mad.

If you add a new feature, please include a test for it in your PR.

Thanks again!

MIT License

Copyright 2017-2019 Mackenzie McClane

v1.5.1 (May 31st, 2019)

• Updated axios to fix a security issue.

v1.5.0 (March 23rd, 2019)

• Thanks to a contribution from somkun, the Scryfall SDK now uses Axios instead of Request Promise
• Added Scry.setRetry
• There was heavy refactoring in this update. You may notice some d.ts changes, most of that is updating interfaces as per the Scryfall documentation and not exporting some interfaces/enums.

v1.4.0 (February 14th, 2019)

• Added Cards.collection(...identifiers: CardIdentifier[])
• Added Cards.byTcgPlayerId(id: number)
• Added Sets.byId(id: string)
• Added Sets.byTcgPlayerId(id: number)
• Added Rulings.byArenaId(id: number)
• Added Catalog.artistNames()
• Added "done" event to the MagicEmitter, which is fired when the emitter ends, errors, or is cancelled.
• Fixed a potential security issue (low severity; Scryfall would have to intentionally have served corrupted data or an attacker would have to intercept the data from Scryfall).

v1.3.3 (November 8th, 2018)

• Fixed RelatedUris and PurchaseUris throwing errors in some configurations.

v1.3.2 (September 16th, 2018)

• Added support for filtering Cards.byName() by set. #10 Thanks dantolini!

v1.3.1 (August 10th, 2018)

• Added error(), allowing you to access the error returned by the last API call.

v1.3.0 (July 31st, 2018)

• Added an optional page parameter to Cards.all(), defaulting to 1. To get only the one page, you can call cancelAfterPage() on the resulting MagicEmitter.
• Added an optional lang parameter to Cards.bySet(). See the Scryfall Documentation for a list of valid languages.
• Added support for /cards/arena/:id

v1.2.1 (June 14th, 2018)

Fixed waitForAll throwing an uncatchable promise rejection error.

v1.2.0 (May 30th, 2018)

Misc updates. Now using a Typescript Gulp file and Gulp@4.0

New features:

• Search options
• MagicEmitter.all()
• Updated IScry.ts with new/updated card fields.

v1.1.0 (March 16th, 2018)

New features:

• Rulings
  • Rulings.byId (id: string): Promise<Ruling[]>;
  • Rulings.bySet (code: string, collectorId: string): Promise<Ruling[]>;
  • Rulings.byMultiverseId (id: number): Promise<Ruling[]>;
  • Rulings.byMtgoId (id: number): Promise<Ruling[]>;
• Catalogs
  • Catalog.artifactTypes (): Promise<string[]>;
  • Catalog.enchantmentTypes (): Promise<string[]>;
  • Catalog.spellTypes (): Promise<string[]>;
  • Catalog.watermarks (): Promise<string[]>;

v1.0.2 (March 16th, 2018)

Fixed an issue that caused the first page of results to be duplicated. How did I miss that for so long?

v1.0.1 (November 20th, 2017)

Fixed broken tests, some code cleanup

v1.0.0 (August 26th, 2017)

Initial release