The TCGdex Python SDK provides a convenient access to the Open Source TCGdex API.
Project description
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for tcgdex_sdk-2.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ca293c7357441dda8e47007039a0658ab5c5a73c29b8be76808f0fbc0aae67c8 |
|
MD5 | cc1813e895809b1e6149350a0d8058a2 |
|
BLAKE2b-256 | 618971f5e2a36ff8fc2f1a8d2db5efe1a515f9c8d96f1b8bebb1ba75fe88b233 |