Versioning and Deprecation Policy

How the Bravado API is versioned, how long each version is supported, and the notice period before deprecation.

Bravado versions its APIs in the URL path. Today, all endpoints live under /v2/.

Current version

v2 is the current stable version for the Trade API, Copytrade API, and combos. The Data API is unversioned in path and follows the same policy.

Backwards-compatibility guarantees

Within a major version, Bravado makes only additive changes:

• New endpoints.
• New optional request fields.
• New response fields.
• New allowed values on existing enums, only when the semantic change is safe for existing clients.
• New response headers.
• New HTTP status codes on new failure modes.

Breaking changes within a major version are not shipped. If a breaking change is required, a new major version is introduced (for example, v3).

What is considered breaking

• Removing an endpoint.
• Removing a request or response field.
• Changing the type of a request or response field.
• Making an optional request field required.
• Changing the semantics of an existing field.
• Removing an enum value.

Deprecation policy

When an endpoint or field is scheduled for removal in a future major version, Bravado:

1. Announces the deprecation in the Changelog.
2. Emits a Deprecation and Sunset header on responses to the deprecated endpoint.
3. Keeps the deprecated endpoint working for at least a notice period before removal.

Deprecation headers

HTTP/1.1 200 OK
Deprecation: true
Sunset: Wed, 01 Jan 2026 00:00:00 GMT
Link: <https://bravado.mintlify.app/api/v3/some-endpoint>; rel="successor-version"

• Deprecation signals the endpoint is scheduled for removal.
• Sunset gives the date after which the endpoint may return 410 Gone.
• Link with rel="successor-version" points to the replacement endpoint when one exists.

Client integrations should log warnings when Deprecation: true is observed and open a migration issue against the successor.

Version support horizon

Related

• Changelog for the dated list of changes and deprecations.
• Status and uptime for platform incidents that may affect API behavior.