Inconsistencies between GitHub repository OpenAPI and Apiary

Trakt Questions & Help
,
1

I’m trying to build a Golang CLI app for Trakt and I followed the documentation found at https://trakt.docs.apiary.io; however I also realized the trakt/trakt-api repository now offers a neat deno task openapi:generate which generates an OpenAPI spec file.

From a quick comparison the two documents however differ, some endpoints don’t exist anymore (e.g./languages), while some have been created (e.g. /search/{type}/exact).

So my question is: which is the current reference document for the API?

1 Like
2

Great question :smiling_face:

Short answer: both are usable today, but they serve different purposes and you need to be careful with the OpenAPI spec.

A bit more context:

  • Apiary is still the stable, user-facing reference for the Public Trakt API. It’s what most third-party integrations are built against and what we consider safe to rely on.
  • The OpenAPI spec generated from the trakt/trakt-api repo is more of a work-in-progress/internal-facing artifact. It reflects ongoing changes and experiments, which is why you’re seeing differences like the new /search/{type}/exact.

Because of that:

  • The OpenAPI spec can change more frequently and may not always be fully in sync or finalized.
  • Some endpoints in it may be experimental, evolving or not fully documented yet.

For now, we recommend:

  • Use Apiary as the source of truth for production integrations.
  • Feel free to explore or prototype with the OpenAPI spec, but treat it as “less-stable”.

When we’re ready to officially move or align documentation around OpenAPI, we’ll clearly announce it on GitHub.

Thanks for digging into this and for building on Trakt :hugs: