TCGdex/java-sdk
1
0
Fork 1
mirror of https://github.com/tcgdex/java-sdk.git synced 2025-04-22 02:42:15 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Create README.md

Browse Source
This commit is contained in:
Maxopoly 2021-11-04 17:12:57 +01:00 committed by GitHub
parent 1498b061b0
commit fb49f92735
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md Normal file
View File

@ -0,0 +1,31 @@
# Tcgdex-java
This is a Java API for querying the Pokémon TCG database of [TCGdex](https://github.com/tcgdex/).
To use it, first initialize an API instance with the language you want results to be in
```java
TCGDexAPI api = new TCGDexAPI(TCGDexAPI.Language.EN);
```
Use it to obtain POJOs representing cards, sets and series. For all of these, there is a function listing all available including short info and a function to get detailed information regarding one.
```java
//all cards available
List<CardResume> allCards = api.getAllCards();
//detailed card info
CardInfo card = api.getCardInfo(allCards.get(23));
//all sets available
List<SetResume> allSets = getAllSets();
//Obtained set info either based on the listing of all sets
SetInfo set = getSetInfo(allSets.get(1));
//or based on some card, also works for CardInfo
SetInfo set2 = getSetInfo(allCards.get(10));
//all series available
List<SeriesResume> allSeries = getAllSeries();
//same possibilties for series
SeriesInfo series = getSeriesInfo(allSeries.get(2));
SeriesInfo series2 = getSeriesInfo(set);
```