​
About API Versioning

The Ivy API is versioned using date. Breaking changes are released in new major versions of the date it got released(e.g., 2025-06-11). Breaking changes are changes that can potentially break an integration.

​
Breaking changes include:

  • Removing an entire endpoint
  • Removing or renaming a parameter
  • Removing or renaming a response field
  • Adding a new required parameter
  • Making a previously optional parameter required
  • Changing the type of a parameter or response field
  • Removing enum values
  • Adding a new validation rule to an existing parameter
  • Changing authentication or authorization requirements

​
Non-breaking (additive) changes include:

  • Adding a new endpoint
  • Adding an optional parameter
  • Adding an optional request header
  • Adding a response field
  • Adding a response header
  • Adding enum values
When a new Ivy API version is released, the previous API version will be supported for at least 24 months following the release of the new API version.

​
Specifying API Versions

We use the X-Ivy-Version header to specify the API Version. Your account will always have a default API Version from the date, you created your first API Key. You can overwrite this via the header for single requests. We have not had any breaking changes yet, so there is only one API Version.

​
Supported API Versions

Version 2023-01-01

Released 01-01-2023