$ cat tcg-api-openapi.yaml | head -5

OpenAPI 3.1 Specification

The official, hand-written OpenAPI 3.1 spec for the TCG Price Lookup API — kept in sync with production. Use it with any OpenAPI-compatible toolchain: documentation, client generation, mocking, and testing.

OpenAPI 3.1 | Hand-written | Production-synced | 5 Endpoints | Client Generation | Mock Server via Prism

What It Is

The OpenAPI specification is a machine-readable description of the entire TCG Price Lookup API. Every endpoint, every request parameter, every response schema — documented in a single YAML file following the OpenAPI 3.1 standard.

It's hand-written (not auto-generated from code) and reviewed against production for every release, so you can trust it as the canonical reference for integrating with the API.

tcg-api-openapi.yaml OpenAPI 3.1
openapi: "3.1.0"
info:
  title: TCG Price Lookup API
  version: "1.0.0"
  description: Live trading card prices
servers:
  - url: https://api.tcgpricelookup.com/v1
paths:
  /cards:
    get:
      summary: Search cards
      ...

Compatible Tools

Works with every major OpenAPI toolchain.

Swagger UI

Render interactive API docs with a single HTML file. Try every endpoint in your browser.

swagger-ui-serve spec.yaml

Redoc

Generate clean, three-panel reference documentation. Self-hostable static HTML.

redoc-cli build spec.yaml

Stoplight Elements

Embed rich API docs directly in your own developer portal or docs site.

Postman

Import the spec directly — Postman converts it into a full collection with pre-built requests.

Mintlify

Use the spec as the source of truth in a Mintlify docs site — full endpoint pages auto-generated.

Any OpenAPI Tool

The spec follows the 3.1 standard strictly — it works with any compliant tool in the ecosystem.

Generate a Client in Any Language

Use the OpenAPI Generator to produce a typed client in seconds. No SDK? No problem.

terminal openapi-generator
# Install the generator
$ npm install -g @openapitools/openapi-generator-cli

# Generate a Kotlin client
$ openapi-generator-cli generate \
    -i https://raw.githubusercontent.com/TCG-Price-Lookup/tcg-api-openapi/main/spec.yaml \
    -g kotlin \
    -o ./tcg-client-kotlin

# Or Swift, Java, C#, Ruby, Elixir, Dart...
$ openapi-generator-cli generate -i spec.yaml -g swift5 -o ./tcg-client-swift

Supported generators include:

KotlinSwiftJavaC#RubyElixirDartGoRustPHPPythonTypeScriptScalaRPerl + many more

Mock Server with Prism

Develop and test against a live mock server that returns real-shaped data — no API key required.

terminal prism mock server
# Install Prism
$ npm install -g @stoplight/prism-cli

# Start the mock server
$ prism mock https://raw.githubusercontent.com/TCG-Price-Lookup/tcg-api-openapi/main/spec.yaml

# Mock server is now running at http://localhost:4010
$ curl http://localhost:4010/v1/cards?q=charizard

Documented Endpoints

Method Endpoint Description
GET /v1/cards Search cards by name, game, set, and other filters
GET /v1/cards/{id} Fetch a single card by UUID with full price block
GET /v1/cards/{id}/history Price history over 7d, 30d, 90d, or 1y (Trader plan)
GET /v1/games List all supported games with catalog sizes
GET /v1/sets List sets with optional game filter

Ready to integrate?

Grab the spec from GitHub and start building. Free plan includes 200 requests/day — no credit card required.