Versioning and changes
How each API shows its version, where changes are listed, and which changes could need work on your side.
The version is part of the address, so Rate Capture stays at /v1. Every change is listed in the changelog, and a change that could stop working code is tagged Breaking. Code that ignores fields and values it doesn't recognise copes best with additions.
The version is in the path
- The Rate Capture API is version 1: every path starts
/v1. -
The Lighthouse-compatible API copies the shape of three read calls from Lighthouse's v3 rates API, so its paths start
/lighthouse/v3. That number follows Lighthouse, not Beacon.
Where changes are listed
Changes to the APIs, and important changes to these docs, are listed in the changelog, newest first. Each entry says which API it affects and what, if anything, you need to do.
The OpenAPI files
The machine-readable description of each API is its OpenAPI file. Tools can turn these files into client code or Postman collections.
The Rate Capture file is also served by the API itself, without a key, at https://api.pro.getbeacon.cloud/v1/openapi.json. That address
and the Rate Capture file above are the same file, so they always agree.
Breaking changes
Every change to the APIs is listed in the changelog, and one that could stop working code from working is tagged Breaking. Write your code to ignore fields it doesn't know, and to handle an error code or a value it hasn't seen before.