Pular para o conteúdo
TickerLabData

Referência da API

TickerLab Data: rotas, regras e licenças

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.

  • JSON
  • Chave no cabeçalho
  • known_at em toda rota
  • Licença em cada resposta

O que a API entrega hoje

Pequeno, conferido e com licença

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.

12conjuntos na APIempresas, o perfil da empresa, os comparáveis, os eventos, os vínculos, os compradores do setor, os ativos (contratos de petróleo e gás), demonstrações, fundos, a ficha de crédito, setores e a busca de empresas por filtros; cada um com licença e campos descritos
24fontesCVM (cadastros, registro de fundos, FCA, FRE, DFP, ITR, fatos relevantes, carteiras de fundos, FIDCs e informes de FII e FIP), Receita Federal (CNPJ), Anvisa (registros de produtos), as séries e os indicadores de ANEEL, Banco Central, SUSEP, ANS e Anatel e os contratos de E&P da ANP
22rotas14 de consulta, 2 de apresentação, 3 de lote, a lista de setores, o catálogo e o consumo
100CNPJs por loteum pedido da cota por CNPJ válido e distinto

Regras da base

Quatro regras que valem para toda tabela

Como era na data

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-30

Linhagem

Cada 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_at

Licença por tabela

A licença da fonte vem na resposta, não num rodapé. Fonte sem licença conhecida não sai pela API.

"license": "ODbL (…)"

Explicação

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/catalog

Honestidade

O que a API não entrega, e por quê

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 e índices da B3

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.

Nada sobre pessoa física

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 responde not_available.

Tabelas de uso interno

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

Integre sozinho, pela 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.