# API do BID do Avaí

> API pública de leitura dos registros do Avaí Futebol Clube (clube 20058 no BID da CBF) de 2003-01-01 até hoje: contratações, rescisões, empréstimos, renovações, elenco atual e estatísticas. Respostas em JSON, autenticação por chave de API.

Os dados vêm exclusivamente do BID (Boletim Informativo Diário) da CBF, minerado dia a dia desde 2003-01-01 e atualizado a cada 20 minutos; uma consulta diária por atleta informa onde cada pessoa está registrada hoje. Não há dados de outras fontes.

Autenticação: cabeçalho `Authorization: Bearer SUA_CHAVE` ou `X-API-Key: SUA_CHAVE`. Limite de 600 requisições por 1 minuto por chave.

## Documentação

- [Documentação da API](https://bid.avaifc.com/docs): referência em português com parâmetros, exemplos de requisição e resposta, dicionário de dados e avisos de interpretação.
- [Referência completa](https://bid.avaifc.com/llms-full.txt): tudo o que é preciso para escrever um cliente funcional, em um só arquivo de texto.
- [OpenAPI 3.1](https://bid.avaifc.com/api/v1/openapi.json): contrato da API em JSON, sem chave.

## Endpoints

- [GET /api/v1/registros](https://bid.avaifc.com/docs#registros): Lista as publicações do clube no BID, da mais recente para a mais antiga.
- [GET /api/v1/atletas](https://bid.avaifc.com/docs#atletas): Uma entrada por pessoa (não por registro), com resumo da passagem pelo clube.
- [GET /api/v1/atletas/{codigo}](https://bid.avaifc.com/docs#atleta): Resumo, todos os registros, situação no BID e posição no elenco atual.
- [GET /api/v1/elenco](https://bid.avaifc.com/docs#elenco): Quem tem contrato ou vínculo ativo hoje, agrupado como no site.
- [GET /api/v1/estatisticas](https://bid.avaifc.com/docs#estatisticas): Totais do acervo, distribuição por ano e estado dos workers.
- [GET /api/v1/saude](https://bid.avaifc.com/docs#saude): Checagem rápida, sem chave: a API responde e o banco está acessível. Sem chave.
- [GET /api/v1/openapi.json](https://bid.avaifc.com/docs#openapi): Especificação OpenAPI 3.1 da API, sem chave. Sem chave.

## Páginas do site

- [BID do Avaí](https://bid.avaifc.com/): painel com os últimos registros, o histórico desde 2003 e o estado da mineração.
- [Elenco atual](https://bid.avaifc.com/elenco): quem tem contrato ou vínculo ativo hoje segundo o BID, agrupado por categoria.

## Avisos de interpretação

- tipo_contrato é o status atual, não o evento.
- Quem o Avaí empresta para fora não aparece com o Avaí.
- Base × profissional é estimativa nossa.
- O BID não informa a função da comissão técnica.
- Datas vêm no horário de Brasília, sem fuso.
- O histórico ainda pode estar sendo minerado.