Changelog & versioning

The version is part of the path. v1 only changes in backwards-compatible ways.

Versioning policy

Within /v1 we only make additive changes: new endpoints, new optional parameters, new response fields, new enum values in categories keys for new types, and new error detail texts. Ignore unknown fields and do not rely on field order.

Breaking changes — removing or renaming a field, changing a type, making a parameter required — ship as a new path (/v2). Error code values, category keys and sort names are part of the contract.

Deprecation and sunset

A deprecated version keeps working for at least 6 months after its successor is released.
Its responses carry Deprecation (RFC 9745) and Sunset (RFC 8594) headers with the date it stops working, plus a Link to this page.
Account owners with recent traffic on the old version are emailed at deprecation and 30 days before sunset.

Headers on a deprecated version

HTTP/1.1 200 OK
Deprecation: @1798761600
Sunset: Tue, 01 Jun 2027 00:00:00 GMT
Link: <https://hexascore.app/docs/changelog>; rel="deprecation"

Changes

v1 — time to beat (additive)

ItemDetail.time_to_beat: crowdsourced median hours and report count for main, extras and completionist on games (median_hours is null under 3 reports); null for movies, series and books.

v1 — first release

Lists, details and genres for games, movies, series and books.
/search, /lookup by external id and /me/usage.
OpenAPI 3.1 document at /openapi.json.