https://github.com/mariomh8/scryfall-api
A Javascript library for https://scryfall.com/docs/api written in Typescript.
https://github.com/mariomh8/scryfall-api
bun magic-the-gathering mtg scryfall typescript
Last synced: 4 months ago
JSON representation
A Javascript library for https://scryfall.com/docs/api written in Typescript.
- Host: GitHub
- URL: https://github.com/mariomh8/scryfall-api
- Owner: MarioMH8
- License: mit
- Created: 2022-01-29T22:51:03.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2026-02-20T20:44:45.000Z (4 months ago)
- Last Synced: 2026-02-20T22:17:09.956Z (4 months ago)
- Topics: bun, magic-the-gathering, mtg, scryfall, typescript
- Language: TypeScript
- Homepage:
- Size: 69.9 MB
- Stars: 12
- Watchers: 1
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Support: SUPPORT.md
Awesome Lists containing this project
README
scryfall-api
A Javascript library for scryfall.com written in Typescript.
## Table of Contents
- [Installation](#installation)
- [Documentation](#documentation)
- [Contributing](#contributing)
## Installation
```bash
npm install --save scryfall-api
```
**Using bun**
```bash
bun add scryfall-api
```
## Documentation
In the documentation below, requiring the package is assumed.
```ts
import scryfall from 'scryfall-api';
scryfall.Cards.byName('Black Lotus').then(console.log);
```
**With CommonJS**
```js
const scryfall = require('scryfall-api');
scryfall.Cards.byName('Black Lotus').then(console.log);
```
**If you only need Cards**
```ts
import { Cards } from 'scryfall-api';
Cards.byName('Black Lotus').then(console.log);
```
Link to [full documentation.](./DOCUMENTATION.md)
## Contributing
This project uses [Bun](https://bun.sh) 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
```bash
git clone git@github.com:MarioMH8/scryfall-api.git
```
Go to the project directory
```bash
cd scryfall-api
```
Install dependencies
```bash
bun install
```
Compile the project
```bash
bun run build
```
## MIT License
[Copyright 2021-2025 MarioMH](./LICENSE)