InsiderCat API Versioning & Deprecation Policy

InsiderCat versions its public API in the URL path (/api/v1/...). This page is the source of truth agents and developers can rely on for how versioning works and how a future deprecation would be signaled, so integrations do not have to guess.

Current version

Version: 1.0.0 (path prefix /api/v1)

API reference · /openapi.json

What counts as a breaking change

Not breaking: new endpoints, new optional query parameters, new response fields.
Breaking, and covered by this policy: removing or renaming a field, changing a field's type, or changing default behavior of an existing endpoint.

How deprecation is signaled

A deprecated endpoint gets a minimum 90-day notice before removal.
During that window, responses from the deprecated endpoint carry a Deprecation header and a Sunset header (RFC 8594) naming the removal date, plus a Link header pointing back to this page and to any successor endpoint.
The deprecation is listed below and announced on the developer portal.
Registered API key holders may be notified by email for material deprecations.

Currently deprecated endpoints

None. All /api/v1 endpoints are fully supported.

Developer portal API reference Contact

# InsiderCat API versioning and deprecation policy

InsiderCat versions its public API in the URL path (`/api/v1/...`). The current and only version is `v1`.

## Compatibility within v1

- Adding new endpoints, new optional query parameters, and new response fields is not a breaking change.
- Removing or renaming a field, changing a field's type, or changing default behavior is a breaking change and requires a deprecation notice under this policy (or a new API version).

## How deprecation is signaled

- A deprecated endpoint gets a minimum 90-day notice before removal.
- During that window, responses from the deprecated endpoint include a `Deprecation` header and a `Sunset` header (RFC 8594) naming the removal date, plus a `Link` header pointing back to this page and to any successor endpoint.
- The deprecation is also listed on this page and announced on the developer portal.
- Registered API key holders are notified by email at hi@insidercat.com's discretion for material deprecations.

## Currently deprecated endpoints

- None. All `/api/v1` endpoints are fully supported.

## Resources

- [Developer portal](/developers)
- [API reference](/api-mcp/docs)
- [OpenAPI JSON](/openapi.json)