npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@bosstop/pokemontcgapi

v1.0.4

Published

Pokemon TCG API

Downloads

312

Readme

PokemonTCGAPI

This is a simple API wrapper that allows you to get information about Pokemon cards. It is built using Pokemon TCG API to get the data.

This is not an official API wrapper made by Pokemon TCG API.

Installation

Install the package using npm:

npm install @bosstop/pokemontcgapi

Install the package using pnpm:

pnpm install @bosstop/pokemontcgapi

Usage

import { PokemonTCG } from '@bosstop/pokemontcgapi';

const api = new PokemonTCG("<API_KEY>"); // Get your API key from https://pokemontcg.io/

Get Types

const types = await api.getTypes();
console.log(types);

Get Supertypes

const supertypes = await api.getSupertypes();
console.log(supertypes);

Get Subtypes

const subtypes = await api.getSubtypes();
console.log(subtypes);

Get Rarities

const rarities = await api.getRarities();
console.log(rarities);

Get All Sets

Usage: all(): Promise<Set[]>

const sets = await api.sets.all();
console.log(sets);

Get Set By ID

Usage: getSetByID(id: string): Promise<Set>

const set = await api.sets.getSetByID('base1');
console.log(set);

Get Set By Name

Usage: getSetByName(name: string): Promise<Set>

const set = await api.sets.getSetByName('base');
console.log(set);

Get Cards By ID

Usage: getCard(id: filters: ReturnData[]|string[] = []_)

const card = await api.cards.getCard('base1-4');
console.log(card);

Get Cards By Name

Usage: searchByName(name: string, subtype: string, type: string, filters: ReturnData[]|string[] = [])

const cards = await api.cards.getCardByName('Charizard');
console.log(cards);

Return Data

enum ReturnData {
    NAME = 'name',
    ID = 'id',
    HP = 'hp',
    SUPERTYPE = 'supertype',
    SUBTYPES = 'subtypes',
    TYPES = 'types',
    EVOLVESTO = 'evolvesTo',
    RULES = 'rules',
    ATTACKS = 'attacks',
    WEAKNESSES = 'weaknesses',
    RETREATCOST = 'retreatCost',
    SET = 'set',
    NUMBER = 'number',
    ARTIST = 'artist',
    RARITY = 'rarity',
    NATIONALPOKEDEXNUMBERS = 'nationalPokedexNumbers',
    LEGALITIES = 'legalities',
    IMAGES = 'images',
    TCGPLAYER = 'tcgplayer',
}

Donate

If you like this package, consider donating to me. It will help me to maintain this package and make more packages like this. Ko-fi