Política de versionamento e descontinuação da API InsiderCat

O InsiderCat versiona sua API pública no caminho da URL (/api/v1/...). Esta página é a fonte de verdade que agentes e desenvolvedores podem usar para entender como o versionamento funciona e como uma futura descontinuação seria sinalizada, para que as integrações não precisem adivinhar.

Versão atual

Versão: 1.0.0 (prefixo de caminho /api/v1)

Referência da API · /openapi.json

O que conta como uma mudança que quebra compatibilidade

Não quebra compatibilidade: novos endpoints, novos parâmetros de consulta opcionais, novos campos de resposta.
Quebra compatibilidade, e é coberto por esta política: remover ou renomear um campo, alterar o tipo de um campo ou alterar o comportamento padrão de um endpoint existente.

Como a descontinuação é sinalizada

Um endpoint descontinuado recebe um aviso mínimo de 90 dias antes da remoção.
Durante esse período, as respostas do endpoint descontinuado trazem um cabeçalho Deprecation e um cabeçalho Sunset (RFC 8594) indicando a data de remoção, além de um cabeçalho Link apontando de volta para esta página e para qualquer endpoint substituto.
A descontinuação é listada abaixo e anunciada no portal do desenvolvedor.
Titulares de chaves de API registradas podem ser notificados por e-mail em descontinuações relevantes.

Endpoints atualmente descontinuados

Nenhum. Todos os endpoints /api/v1 são totalmente suportados.

Portal do desenvolvedor Referência da API Contato

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