Sleeved Docs

API Overview

Introduction to the Sleeved public API — base URL, response format, supported games, and key concepts for integration partners.

The Sleeved public API gives integration partners programmatic access to card data and deck exports. It is designed for use cases like building deck importers, syncing card indexes, and reading shared decks.

Base URL

All API endpoints are prefixed with:

https://api.sleeved.gg/api/v1

Supported Games

The API currently supports four games:

GameSlug
Digimon Card Gamedigimon
Gundam Card Gamegundam
Grand Archive TCGgrand-archive
Chrono Core TCGchrono-core

Use these slugs in path parameters wherever a :slug is shown in an endpoint.

Authentication

Every request requires an API key passed in the X-API-Key request header. See Authentication for details on key format and error handling.

Response Format

Success

All successful JSON responses wrap the payload in a data field:

{
  "data": { ... }
}

Errors

Error responses use an error field with a human-readable message:

{
  "error": "Invalid API key"
}

Common HTTP status codes:

StatusMeaning
200Request succeeded
400Bad request — invalid parameters
401Authentication failed
404Resource not found
429Rate limit exceeded

Text Exports

Deck text export endpoints return Content-Type: text/plain; charset=utf-8 rather than JSON. See Deck Endpoints for details.

Versioning

All routes are prefixed with /api/v1/. Breaking changes will be introduced under a new version prefix; the current version will continue to be served during any transition period.

Postman Collection

Download the Postman collection to get started quickly. It includes all endpoints with example responses and pre-configured variables for your API key and base URL.

Next Steps