- TypeScript
- Next.js
- Cheerio
- Vercel
API de dados de empresas da B3
Cotação, indicadores e proventos de ações e FIIs da B3, em JSON limpo, a partir de uma URL.
GET https://hideki.one/api/b3/{ticker}Experimente
GET https://hideki.one/api/b3/PETR4Use no seu código
curl https://hideki.one/api/b3/PETR4Formato da resposta
Valores em reais; percentuais como fração (0.0743 = 7,43%); datas no formato ISO 8601. Indicador que a fonte não publica para o ativo fica ausente.
Campos comuns
- kind"stock" | "reit"
- Ação ou FII.
- tickerstring
- Ticker em maiúsculas.
- namestring
- Nome da empresa ou do fundo.
- pricenumber
- Cotação, em reais.
- change12mnumber
- Variação da cotação em 12 meses.
- dividendYield12mnumber
- Dividend yield dos últimos 12 meses.
- indicatorsobject
- Indicadores fundamentalistas, por chave (listas ao lado).
- dividends[]object[]
- Até 10 proventos, do mais recente: type, exDate, payDate, amount.
- profileobject
- Só em FIIs: segmento, tipo, mandato, gestão.
- sourcestring
- Página de onde os dados vieram.
- fetchedAtstring
- Momento da coleta (ISO 8601).
Indicadores de ações
- pl
- P/L
- pvp
- P/VP
- psr
- P/Receita
- evEbitda
- EV/EBITDA
- lpa
- LPA
- vpa
- VPA
- grossMargin
- Margem bruta
- ebitdaMargin
- Margem EBITDA
- netMargin
- Margem líquida
- roe
- ROE
- roa
- ROA
- roic
- ROIC
- dividendYield
- Dividend yield
- payout
- Payout
- currentRatio
- Liquidez corrente
- netDebtToEbitda
- Dív. líquida/EBITDA
- netDebtToEquity
- Dív. líquida/Patrimônio
- revenueCagr5y
- CAGR receitas (5 anos)
- earningsCagr5y
- CAGR lucros (5 anos)
Indicadores de FIIs
- pvp
- P/VP
- vacancy
- Vacância
- managementFee
- Taxa de administração
- bookValuePerShare
- Valor patrimonial por cota
- netAssets
- Patrimônio líquido
- lastDividend
- Último rendimento
- shareholders
- Cotistas
- sharesOutstanding
- Cotas emitidas
- profile.segment
- Segmento
- profile.fundType
- Tipo
- profile.mandate
- Mandato
- profile.managementType
- Gestão
Erros e limites
- 400
invalid_tickerO ticker não tem o formato de um ticker da B3. - 404
not_foundNenhuma ação ou FII com esse ticker. - 429
rate_limitedLimite de consultas atingido; veja o cabeçalho Retry-After. - 502
upstream_unavailableA fonte dos dados não respondeu.
Até 30 consultas por minuto por IP. Cada resposta fica 20 minutos no cache da Vercel, por ticker: a mesma consulta nesse intervalo não vai até a fonte.
Como funciona
Um route handler do Next.js valida o ticker e busca a página do ativo no Investidor10, tentando ação ou FII primeiro conforme o final do ticker.
O HTML é lido com Cheerio pelos rótulos dos indicadores, não pela posição: um indicador que o site omite não desloca os outros.
Os números saem normalizados (reais, frações, datas ISO) e a resposta fica 20 minutos no CDN da Vercel.
A versão antiga, com o ticker no cabeçalho (/api/scraper), continua respondendo, marcada como obsoleta.
Dados extraídos do Investidor10, sujeitos a atraso. Nada aqui é recomendação de investimento.