InsiderCat API 版本与弃用政策

InsiderCat 在 URL 路径中为其公开 API 设定版本（/api/v1/...）。本页是代理和开发者可以依赖的权威说明，介绍版本机制以及未来弃用将如何发出通知，让集成方无需猜测。

当前版本

版本: 1.0.0 (路径前缀 /api/v1)

API 参考 · /openapi.json

什么算作破坏性变更

非破坏性：新增接口、新增可选查询参数、新增响应字段。
破坏性变更，受本政策约束：删除或重命名字段、更改字段类型，或更改现有接口的默认行为。

弃用通知方式

被弃用的接口在移除前至少提前 90 天通知。
在此期间，来自该接口的响应会携带 Deprecation 响应头和 Sunset 响应头（RFC 8594），标明移除日期，并附带指向本页面及后续替代接口的 Link 响应头。
弃用信息会列在下方，并在开发者门户公布。
对于重大弃用，已注册的 API key 持有者可能会收到邮件通知。

当前已弃用的接口

无。所有 /api/v1 接口均完全受支持。

开发者门户 API 参考联系我们

# 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)