Versioning

API versioning strategy and support policy

The API uses URI-based versioning to allow controlled evolution of the API surface.

Version Format

All endpoints include the version in the URL path:

https://api.youhodler.com/v1/balance https://api.youhodler.com/v1/convert/exchange

Current Versions

VersionStatusBase Path
v1Active/v1/...

Support Policy

  • Active versions receive new features, bug fixes, and security patches
  • Deprecated versions receive security patches only, with at least 6 months notice before removal
  • Retired versions return 410 Gone for all requests

When a new API version is released, the previous version enters a deprecation period. Partners will be notified via changelog and direct communication.

Breaking vs Non-Breaking Changes

Non-breaking changes (applied to the current version):

  • Adding new endpoints
  • Adding optional request parameters
  • Adding new fields to response objects
  • Adding new error codes that are not returned by existing endpoints under previously valid conditions

Breaking changes (require a new version):

  • Removing or renaming endpoints
  • Removing or renaming response fields
  • Changing the type of existing fields
  • Changing required parameters
  • Returning new error codes from existing endpoints in previously valid scenarios
  • Altering the authentication mechanism