Demonstrações como eram na data
DFP e ITR da CVM, conta a conta, com documento, versão, origem, o dia em que ficaram públicas e valid_until. Filtre por period_end.
Referência da API
Esta é a referência técnica da API de dados do TickerLab. O produto, as três portas (o conector MCP, a CLI e a API) e como pedir a chave estão em tickerlab.com.br.
known_at em toda rotaO que a API entrega hoje
Esta lista é conferida por teste contra o portão de direitos da API (site-api/catalogo.json, gerado do código): se um conjunto entra ou sai, o teste falha até o site acompanhar. A base tem muito mais tabelas do que a API entrega; a API só serve o que a fonte permite redistribuir.
Catálogo
As rotas do beta, todas em https://api.tickerlab.com.br. Cada cartão diz de onde o dado vem e sob qual licença você pode usá-lo.
DFP e ITR da CVM, conta a conta, com documento, versão, origem, o dia em que ficaram públicas e valid_until. Filtre por period_end.
Situação, data, motivo, matriz e o mês do retrato, como era em known_at. MEI, empresário individual e o que não é empresa saem not_available.
O cadastro na Receita e, da companhia aberta, cada DFP e ITR que ela devia, com o prazo da CVM, o dia da entrega e se veio no prazo, como era em known_at. A entrega que ainda não tinha acontecido sai not_filed. MEI, empresário individual e o que não é empresa saem not_available.
As companhias abertas do mesmo grupo de setores (pelo setor informado à CVM no FCA), cada uma com receita, EBITDA, lucro, dívida líquida, margens e ROE do último DFP já entregue, e a mediana de cada razão entre os pares, como era em known_at. Comparação não é opinião sobre a empresa.
Cada documento que a companhia entregou à CVM pelo IPE (fato relevante, comunicado, assembleia...), com protocolo, categoria, tipo e o endereço do documento, e cada troca da firma de auditoria, do mais novo ao mais velho, como era em known_at. Filtre por types; a página segue por next_cursor. O assunto escrito pela companhia não sai.
De quem a empresa era controlada, coligada ou participada e quem ela controlava, com a participação no capital (pelo FRE), e a firma que a auditava (pelo FCA), de 1 a 3 saltos (depth), como era em known_at. Filtre por types. Cada ponta com a razão social da época, pela Receita. Sócio pessoa física, MEI e empresário individual não saem.
Num pedido, os blocos que a sua chave libera (cadastro, sócios pessoa jurídica, vínculos, eventos, crédito, ativos e comparáveis), cada um com a fonte e o dia em que ficou público, a linha do tempo, as deduções separadas dos fatos e o que não foi achado, como era em known_at. Bloco que a chave não libera não sai, e o que a análise ainda não consulta vem em not_included. Sócio pessoa física, MEI e empresário individual não saem. A licença de cada fonte usada vem na resposta.
As empresas que entraram como sócias de uma empresa com estabelecimento ativo do CNAE principal (cnae; na UF state, se dada) nos últimos years anos, os FIPs sócios dessas empresas (pelo registro de fundos da CVM) e as companhias abertas com controlada ou coligada no setor (pelo FRE), como era em known_at. Cada comprador traz os sinais e exemplos, com fonte e data. É movimento passado, não intenção de compra. Só pessoa jurídica: sócio pessoa física, MEI e empresário individual não saem.
Cadastro e taxas da CVM, a carteira da competência mais nova já pública e, se você enviar assumed_return, o custo da taxa em 5 e 20 anos. O retorno é seu, não nosso: nada é previsão.
O que a Receita e a CVM mostram sobre o cedente ou o sacado como era em known_at: situação cadastral e situação especial, fatos relevantes dos últimos 12 meses e a presença como cedente em FIDCs. Cada fato com a fonte e o dia em que ficou público. Não é nota nem opinião de crédito: a decisão é sua. MEI e empresário individual saem not_available.
Energia elétrica, bancos, seguros, saúde suplementar e telecomunicações: o total do mercado, o CR4 e o HHI por ano, a fatia de cada companhia aberta e quem são elas, a partir das séries públicas das agências. A lista dos setores sai em /data/v1/sectors, sem gastar cota. Só empresas: nenhuma pessoa física.
O mesmo de cada rota, num pedido só, com o estado de cada item. Um pedido da cota por CNPJ válido e distinto.
Conjuntos, campos, licença e atribuição de cada fonte, só do que o contrato da organização libera. Não gasta cota.
Pedidos, negados, plano, limites e o que falta da cota. Não gasta cota, mas conta no limite por minuto.
Regras da base
Todo valor tem o dia em que ficou público e o dia em que foi substituído. Você pode pedir a base como ela era em qualquer data.
?known_at=2024-09-30Cada campo diz a fonte, o dia em que ficou público e, quando a base sabe, quando o TickerLab o viu. O documento e a versão vêm em cada linha de demonstração.
published_at · observed_atA licença da fonte vem na resposta, não num rodapé. Fonte sem licença conhecida não sai pela API.
"license": "ODbL (…)"O catálogo descreve os campos de cada conjunto. Nomes e códigos de erro saem em inglês, estáveis entre versões.
GET /data/v1/catalogHonestidade
Negar é o padrão: um dado só sai pela API quando a fonte permite distribuir e quando sabemos de quem ele é. O que fica de fora fica escrito aqui.
Cotações, Ibovespa e múltiplos que dependem da cotação.
Não há dado aberto: só com licença da B3. Enquanto não houver, não há rota.Nomes de sócios, dívida de pessoa, qualquer dado negativo de alguém que a base trata como pessoa.
LGPD: empresário individual e MEI não saem; o que a base trata como pessoa respondenot_available.Posts de assessorias de M&A, páginas guardadas como prova, dados de licença “não comercial”.
A fonte não autoriza redistribuir. Servem à análise dentro do app, não à API.Dados vêm das fontes oficiais e podem ter atraso ou erro da própria fonte. Nada aqui é recomendação de investimento.
Documentação
Tudo o que um piloto precisa para integrar sem falar com a gente: autenticação, versões, direitos por fonte, erros e lotes. Se precisou perguntar, a documentação falhou e a gente conserta.
$ export TICKERLAB_CHAVE=…
$ curl -H "Authorization: Bearer $TICKERLAB_CHAVE" \
https://api.tickerlab.com.br/data/v1/catalog