How do I self-host TCGdex locally?

Use the provided Dockerfile and docker-compose.yml to deploy the API on port 3000. Detailed instructions are in the documentation, but it requires Docker setup and configuration.

TCGdex vs PokéAPI: which one should I use for Pokémon data?

TCGdex is specialized for TCG card data with multilingual support and images, while PokéAPI focuses on video game Pokémon details. For TCG applications, TCGdex is the better choice.

Is TCGdex data up to date with new Pokémon TCG card releases?

Updates depend on community contributions, so new card sets might not be immediately available. Check the project's status page for progress on card additions.

Can I use TCGdex for a commercial project?

Yes, TCGdex is MIT-licensed, allowing commercial use. However, be mindful of Pokémon Company trademarks and ensure proper attribution in your project.

How can I contribute translations to TCGdex?

You can help by editing translation files in the meta/translations directory or adding language data to cards, as mentioned in the README's status section for incomplete translations.

What happens if the TCGdex API goes down?

Since it's self-hostable, you can run your own instance to avoid downtime. However, relying on the public API means depending on the project's maintainers for uptime.

Open-Awesome

TCGdex

MITTypeScriptv2.46.2

A multilingual Pokémon Trading Card Game database with card images and detailed information for the TCGdex API.

Visit Website GitHub

864 stars178 forks0 contributors

What is TCGdex?

TCGdex is an open-source database and API for the Pokémon Trading Card Game (TCG). It provides detailed information, images, and multilingual data for Pokémon TCG cards, enabling developers to build applications that need accurate card data. The project solves the problem of accessing structured, up-to-date Pokémon TCG information programmatically.

Target Audience

Developers building Pokémon TCG-related applications, websites, or tools, such as deck builders, collection trackers, or fan sites. It's also useful for data enthusiasts and translators contributing to the database.

Value Proposition

TCGdex offers a free, community-maintained alternative to proprietary Pokémon TCG databases, with multilingual support, high-quality images, and easy integration via SDKs. Its self-hostable nature gives developers full control over their data and deployment.

Overview

Pokémon Trading Card Game Card (TCG) Database for the TCGdex API. ⭐ Leave a star if the project interest you !

Use Cases

Best For

Building Pokémon TCG deck-building applications
Creating fan websites or wikis with card data
Developing collection tracking tools for TCG players
Integrating card images and details into mobile apps
Researching or analyzing Pokémon TCG card statistics
Building educational tools for learning about TCG mechanics

Not Ideal For

Projects requiring real-time trading card market prices or availability data
Applications needing deep integration with official Pokémon TCG online gameplay or simulators
Teams wanting a fully managed, cloud-hosted API with service level agreements (SLAs) and automatic updates

Pros & Cons

Pros

Multilingual Card Support

Cards include information in multiple languages (English, French, Spanish, etc.), making it ideal for international applications targeting diverse audiences.

Comprehensive Card Details

Provides rich data from physical cards, such as names, types, abilities, and stats, covering most information needed for TCG applications.

High-Quality Card Images

Includes images of Pokémon TCG cards for visual reference, essential for displaying cards in apps, websites, or tools.

API-First with SDKs

Built as a RESTful API with official SDKs for JavaScript/TypeScript, PHP, and Java, simplifying integration into various projects.

Self-Hostable Flexibility

Can be deployed locally using Docker and Docker Compose, giving developers full control over the database and deployment environment.

Cons

Community-Dependent Data

Data accuracy and completeness rely on volunteer contributions, leading to potential gaps in card sets or translations, as highlighted in the status section.

Self-Hosting Overhead

Requires Docker setup and maintenance, which can be complex for teams without DevOps expertise or resources for ongoing management.

Limited SDK Language Support

Only officially supports three programming languages (JS/TS, PHP, Java), necessitating custom wrappers for other stacks like Python or Ruby.

Frequently Asked Questions

Related Projects

PokeAPI

The Pokémon API

Stars5,248

Forks1,136

Last commit4 days ago

Kotlin-Pokedex

:cyclone: A Pokedex app using ViewModel, ViewBinding, LiveData, Room and Navigation

Stars1,553

Forks219

Last commit2 years ago

pgoapi

Pokemon Go API lib

Stars1,394

Forks433

Last commit3 years ago

Pokemon GO Java API

Pokemon Go API

Stars1,045

Forks322

Last commit4 years ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub