Table of Contents

API reference

Generated from the source, so it always matches the shipped assembly. Every public type and member carries XML documentation — the build enforces it.

Only the public surface appears here. The transports, resource implementations and GraphQL wire types are internal, so browsing this is a reliable guide to what you can actually call.

Start here

Type What it is
ITcgDexClient The entry point. Groups every resource.
TcgDexClient The implementation, constructible without a container.
TcgDexOptions Language and endpoint configuration.
TcgDexLanguages The 18 accepted language codes.
TcgDexApiException The single exception type the SDK throws.
AddTcgDex Dependency-injection registration.

Resources

Type Covers
ICardResource Cards: get, list, query, detailed search.
ISetResource Sets, including their card lists.
ISerieResource Series, including their sets.
IRandomResource Random card, set or series.
ICatalogResource All 13 enumeration endpoints.

Querying

Type What it is
CardQuery The fluent, expression-based query builder.
CardFilter Equality-only filter for the GraphQL search.
QueryOperator Every operator the API supports.

See the querying guide for the query string each form produces.

Models

Type Notes
Card The centre of the model graph. Fields are populated by category.
CardBrief What list endpoints return — four fields only.
Set / SetBrief A set and its embedded form.
Serie / SerieBrief A series and its embedded form.
Attack Note Damage is text; use BaseDamage for the number.
Pricing Cardmarket and TCGplayer, both optional.
TcgPlayerPricing Printing names are data, so they are a dictionary.
TcgDexProblem The API's error body.

Two things worth knowing before reading the models:

  • Collections are never null. An absent array arrives empty, so iterating a Trainer's Attacks is safe.
  • Category decides what is populated. Pokémon carry Hp, Types, Attacks; Trainers carry TrainerType, Effect; Energy cards carry EnergyType. Anything category-specific is nullable because the API omits it.

The full namespace list is in the sidebar.

Edit this page