API Versioning

When backwards-incompatible changes are made to the API, a new, dated version is released.

To set the API version on a specific request, you will have to use the api-version header. (see FAQs)

curl --request https://api.amberdata.com/markets/spot/... \
     --header "x-api-key: UAKHelloCryptoHiAmberdata" \
     --header "api-version: 2023-09-30"

Backwards Compatible Changes

Amberdata considers the following changes to be backwards-compatible

  • Adding new API resources.
  • Adding new optional request parameters to existing API methods.
  • Adding new properties to existing API responses.
  • Changing the order of properties in existing API responses.
  • Changing the length or format of opaque, Amberdata generated strings, such as object IDs, error messages, and other human-readable strings.


What are considered non-opaque strings?

Trading pairs, instruments, asset symbols etc. are not considered opaque. Such strings could only be modified with a new dated version.