Skip to content

MarioMH8/scryfall-api

Repository files navigation

banner.png

scryfall-api

A Javascript library for scryfall.com written in Typescript.

npm GitHub issues

Table of Contents

Installation

npm install --save scryfall-api

Using bun

bun add scryfall-api

Documentation

In the documentation below, requiring the package is assumed.

import scryfall from 'scryfall-api';

scryfall.Cards.byName('Black Lotus').then(console.log);

With CommonJS

const scryfall = require('scryfall-api');

scryfall.Cards.byName('Black Lotus').then(console.log);

If you only need Cards

import { Cards } from 'scryfall-api';

Cards.byName('Black Lotus').then(console.log);

Link to full documentation.

Contributing

This project uses Bun as a runtime, test runner and bundler.

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

Clone the project

git clone git@github.com:MarioMH8/scryfall-api.git

Go to the project directory

cd scryfall-api

Install dependencies

bun install

Compile the project

bun run build

MIT License

Copyright 2021-2024 MarioMH