The Kotlin/Java SDK provides a convenient access with the Open Source TCGdex API.
The SDK is available both for Kotlin use and Java.
The full API/SDK documentation in progress at API Documentation - TCGdex
Gradle
- add the repository in you
build.gradle
repositories {
...
maven { url 'https://jitpack.io' }
}- Add the dependency in your
build.gradle
dependencies {
implementation 'net.tcgdex:java-sdk:{Version}'
}Maven
- add the repository in your
pom.xml
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>- Add the depedency in your
pom.xml
<dependency>
<groupId>net.tcgdex</groupId>
<artifactId>java-sdk</artifactId>
<version>{Version}</version>
</dependency>Note: a complete documentation is available at TCGdex.dev
Example: Fetch a Card
// Import the SDK
import net.tcgdex.sdk.TCGdex
// Init the library with the language code (see the API REST documentation for the list)
val api = TCGdex("en")
// returns you a Card Class with every informations filled!
val card = api.fetchCard("swsh1-1")Other Functions
api.fetchCard("swsh3-136")
api.fetchCard("swsh3", "136")
api.fetchSet("swsh3")
api.fetchSets()
api.fetchSerie("swsh")
api.fetchSeries()
api.fetchTypes()
api.fetchType("Colorless")
api.fetchRetreats()
api.fetchRetreat("1")
api.fetchRarities()
api.fetchRarity("Uncommon")
api.fetchIllustrators()
api.fetchIllustrator("tetsuya koizumi")
api.fetchHPs()
api.fetchHP("110")
api.fetchCategories()
api.fetchCategory("Pokemon")
api.fetchDexIds()
api.fetchDexId("162")
api.fetchEnergyTypes()
api.fetchEnergyType("Special")
api.fetchRegulationMarks()
api.fetchRegulationMark("D")
api.fetchStages()
api.fetchStage("Basic")
api.fetchSuffixes()
api.fetchSuffix("EX")
api.fetchTrainerTypes()
api.fetchTrainerType("Tool")
api.fetchVariants()
api.fetchVariant("holo")See CONTRIBUTING.md
TL::DR
-
Fork
-
Commit your changes
-
Pull Request on this Repository
This project is licensed under the MIT License. A copy of the license is available at LICENSE.md
This is based on the Maxopoly TCGdex Java SDK