japanese-pokemon-cards-sdk-.../README.md
2023-03-03 19:28:34 +01:00

34 lines
2 KiB
Markdown

# japanese-pokemon-cards-sdk-csharp
[![nuget](https://img.shields.io/nuget/vpre/JpnCardsPokemon.Sdk?style=flat-square)](https://www.nuget.org/packages/JpnCardsPokemon.Sdk/) [![downloads](https://img.shields.io/nuget/dt/JpnCardsPokemon.Sdk?style=flat-square)](https://www.nuget.org/packages/JpnCardsPokemon.Sdk/) ![license](https://img.shields.io/github/license/serraniel/japanese-pokemon-cards-sdk-csharp?style=flat-square) ![vulnerabilities](https://img.shields.io/snyk/vulnerabilities/github/serraniel/japanese-pokemon-cards-sdk-csharp?style=flat-square) ![dependencies](https://img.shields.io/librariesio/github/serraniel/japanese-pokemon-cards-sdk-csharp?style=flat-square)
Dependency-free C# SDK for interaction with [jpn-cards.com](https://jpn-cards-site.readthedocs.io/en/latest/home/). With the SDK you can gather information about Japanese Pokémon TCG. This includes information about sets and cards, including current price information if available.
The data is provided by an external API. Please check the above link for more information. The SDK only fetches their current JSON data and wraps them into object.
## Installing
The package is available at [Nuget](https://www.nuget.org/packages/JpnCardsPokemon.Sdk/).
**.Net CLI:**: `dotnet add package JpnCardsPokemon.Sdk --version 0.1.0-beta`
**Package manager:** `NuGet\Install-Package JpnCardsPokemon.Sdk -Version 0.1.0-beta`
## Documentation
You can find full documentation [here](docs/index.md).
## Examples
```csharp
var client = new ApiClient();
// fetch all set information
var sets = await client.FetchSetsAsync();
// fetch cards from set
var vmaxClimaxCards = await Client.FetchCardsAsync(new CardQueryFilterBuilder { SetCode = "s12a" });
// fetch all morpeko cards
var morpekoCards = await Client.FetchCardsAsync(new CardQueryFilterBuilder { Name = "morpeko" });
// fetch all Charizard drawn by Arita
var aritaCharizardCards = await Client.FetchCardsAsync(new CardQueryFilterBuilder { Name = "charizard", Artist = "mitsuhiro arita" });
```