README.md

TCGdex Python SDK

The TCGdex Python SDK provides a convenient access with the Open Source TCGdex API.

The full API/SDK documentation is available at API Documentation - TCGdex

Getting Started

How To install

run the following command:

pip install tcgdex-sdk

Getting Started

Example: Fetch a Card

from tcgdexsdk import TCGdex

tcgdex = TCGdex("en") # You can also use `Language.EN` TCGdex(Language.EN)
res = await tcgdex.card.get("swsh1-136")

Other Examples

# fetch a Set using the set's name or ID
await tcgdex.set.get('Darkness Ablaze')

# Fetch a serie using the serie's name or ID
await tcgdex.serie.get('Sword & Shield')

# Fetch cards possible pokemon cards HP
await tcgdex.hp.list()

# Fetch Cards with the specific number of HP
await tcgdex.hp.get('110')

# Fetch cards possible illustrators
await tcgdex.illustrator.list()

# Fetch Cards with the specific illustrator
await tcgdex.illustrator.get('tetsuya koizumi')

Other Endpoints

Every endpoints below work just like the ones above

• a function list to get the list of elements

• a function get to get details on the element

• variant: fetch by the variants

• trainerType: fetch trainer cards types

• suffix: fetch differents cards suffixes

• stage: fetch differents cards stages

• regulationMark: Fetch by the regulation mark (letter at the bottom of the card)

• energyType: Fetch different types of energies

• dexId: fetch pokemon Global Pokédex IDS

• type: fetch the cards using the Pokémon type(s)

• retreat: fetch the cards using the retreat count

• rarity: fetch the cards rarities

• illustrator: fetch all the cards illustrators

• hp: fetch the different cards possible HPs

• category: the different cards categories

Contributing

See CONTRIBUTING.md

TL::DR

• Fork

• Commit your changes

• Pull Request on this Repository

License

This project is licensed under the MIT License. A copy of the license is available at LICENSE.md