REST API

Authentication

All endpoints expect an API key as a Bearer token. Create keys under Account → API keys.

Authorization: Bearer tcgaze_live_…

Responses are JSON (UTF-8); images are returned as binary data. Every request counts against the monthly quota; image requests additionally count against the daily download limit. Rate limit: 60 requests per minute per key. Exceeding it returns 429, missing entitlement 402.

GET /api/v1/search

Image search across all sources. Parameters: q (required, max. 160 characters), game (all|pokemon|magic|yugioh|onepiece), lang (comma list, e.g. de,en), kind (all|single|sealed), official (true|false), page (1–20), limit (1–120).

curl -H "Authorization: Bearer $KEY" \
  "https://tcgaze.com/api/v1/search?q=Charizard%20ex%20125/197&game=pokemon&lang=en,de"

{
  "query": {"game": "pokemon", "text": "charizard ex", "set_code": "", "number": "125", "names": {"en": "Charizard ex", "de": "Glurak ex", "ja": "リザードンex"}},
  "total": 12,
  "items": [
    {
      "id": "…", "game": "pokemon", "kind": "single", "title": "Charizard ex",
      "subtitle": "Obsidian Flames · 125/197 · Double Rare", "language": "en",
      "set_code": "sv03", "number": "125", "rarity": "Double Rare",
      "image_url": "https://assets.tcgdex.net/en/sv/sv03/125/high.png", "fmt": "png",
      "page_url": "https://tcgdex.dev/…", "source_id": "tcgdex", "official": false,
      "sig": "…"
    }
  ],
  "providers": [{"id": "tcgdex", "name": "TCGdex", "count": 8, "error": ""}]
}

GET /api/v1/image

Fetches an image from a search result as PNG (default) or in its original format. Parameters: url and sig from the search result (required), format (png|original), size (longest edge in px, 0 = original). Response: image data with Content-Type and X-Image-Width/X-Image-Height.

curl -H "Authorization: Bearer $KEY" \
  "https://tcgaze.com/api/v1/image?url=https%3A%2F%2Fassets.tcgdex.net%2Fen%2Fsv%2Fsv03%2F125%2Fhigh.png&sig=…&format=png" \
  -o charizard-ex-125.png

GET /api/v1/listing-image

Generates a marketplace-ready listing image. Parameters: url, sig, preset (amazon|ebay|shop|square|transparent|kleinanzeigen), optional size, bg (hex or transparent), padding (0–0.3), format (png|jpeg|webp), shadow, trim.

curl -H "Authorization: Bearer $KEY" \
  "https://tcgaze.com/api/v1/listing-image?url=…&sig=…&preset=amazon" -o listing.jpg

GET /api/v1/me · GET /api/v1/catalog

/me returns your plan and current usage (day/month). /catalog lists games, languages, sources and presets - handy for select boxes in your own tools.

Error codes