Dicionários, identidades e unidades

O OpenAPI define parâmetros, enums, schemas de resposta e custo por operação. GET /v1/schema publica recursos, grãos, fontes e unidades, incluindo o catálogo de créditos. O catálogo MCP contém as 28 ferramentas e seus parâmetros. São contratos públicos; as rotas privadas do bridge e de administração não fazem parte deste catálogo.

Ações e companhias exigem o escopo companies:read; os demais blocos usam funds:read. Confira os escopos autorizados da chave ou do login OAuth antes de executar. A documentação pública não remove autenticação, créditos ou limites.

FIDCs

Identidade e contextofund_id e class_id persistentes; mês AAAA-MM

Unidades e interpretação*_brl em reais; *_ratio em fração. Leia metric_definitions e as definições de recebíveis.

Ações B3

Identidade e contextoTicker + ISIN + categoria; mesma release

Unidades e interpretaçãounit_close_price em BRL por ação; OHLC divide por quote_factor. Preços não ajustados. Fundamentos preservam fundamental_units; não converta índices/múltiplos em percentuais.

Proventos e acionistas

Identidade e contextoPapel exato; direitos, pagamentos e ações corporativas separados; snapshot FRE

Unidades e interpretaçãoNão somar trilhas distintas. Percentuais FRE são %; não multiplicar por 100. Capitalização da companhia repetida entre classes não deve ser somada.

Companhias CVM

Identidade e contextoCódigo CVM da companhia, dataset DFP/ITR, consolidação, período e revisão

Unidades e interpretaçãoUse o dicionário /v1/companhias/contas-contabeis. Preserve rubrica, moeda e escala contábil; não misture individual e consolidado ou revisões.

CRI/CRA

Identidade e contextoTipo + CNPJ da securitizadora + código; competência e hash da fonte

Unidades e interpretaçãoCarteira, balanço, fluxos e prazos ficam em dados. Preserve unidades reportadas; taxa/rating da fonte não é marcação/rating atual.

CDA

Identidade e contextoClasse + mês explícito + partição/release; todas as páginas

Unidades e interpretaçãoPosições públicas com valores e campos da fonte. Ausência/confidencialidade não é zero. Abra fundos investidos separadamente no mesmo mês.

Séries e desempenho de fundos

Identidade e contextoCNPJ + source_series_id quando ambíguo; frequência diária ou mensal

Unidades e interpretaçãoRetornos, volatilidade e drawdown em fração; Sharpe é índice. Preserve window_context, método e motivos de indisponibilidade.

Títulos públicos

Identidade e contextoData da curva ou ticker + intervalo

Unidades e interpretaçãoPU em BRL por título; taxas anuais em fração. Compra, venda e preços indicativos são distintos. Não interpolar curva.

Macroeconomia

Identidade e contextoSGS 11, 432 e 433; CDI em rota própria

Unidades e interpretaçãoSGS 11: % ao dia; 432: % ao ano; 433: % de variação mensal. Preserve frequência; não anualizar silenciosamente.

BOVA11

Identidade e contextoTicker/ISIN exatos; intervalo diário B3

Unidades e interpretaçãoBRL por cota, preço não ajustado de ETF. Proxy de bolsa, não índice oficial do Ibovespa nem retorno total.

Indústria

Identidade e contextoCompetências, universo e dimensões constantes

Unidades e interpretaçãoFluxos somados e PL final dos períodos; agregados podem conter dupla contagem. Preserve cobertura, metodologia e avisos de qualidade.

null, pendência de atualização e ausência reportada não significam zero. Catálogo cadastral não comprova dados no período. Preserve source_sha256, versão, release, frequência e unidades nos resultados e nas exportações.

Crédito por chamada e por consulta

Ações, CRI/CRA e Tesouro: 1 crédito por chamada/página. CDA, desempenho, macro e BOVA11: 1 crédito por consulta, com páginas incluídas por até 15 minutos na mesma chave e filtros. Recursos FIDC mantêm seus custos específicos de 1 a 10 créditos. A política vigente está no /pricing e em x-credits-cost do OpenAPI; x-paid-navigation-minutes indica a continuação elegível.

Três aliases legados permanecem: caracteristicas-anbima (1 crédito), medidas (2) e investidores/historico (3), sob /v1/classes/{class_id}. Use as rotas canônicas em novas integrações.