API Versioning & Compatibility

Baselayer maintains a backwards compatible API contract.

We may add new fields, endpoints, or optional parameters without notice.

We recommend building for forward compatibility:

  • Accept and ignore unknown fields in responses
  • Use permissive parsers rather than strict schema validation
  • Explicitly access only the fields your application needs
  • Subscribe to the API changelog for notifications of additive changes

Baselayer will never:

  • Remove or rename existing fields
  • Change the type or format of existing fields
  • Make existing optional parameters required
  • Change HTTP status codes for existing scenarios

Breaking changes are only introduced through new API versions with advance notice and a deprecation timeline.