brapi

FAQ - Perguntas Frequentes

O mercado financeiro brasileiro está em constante movimento, e ter acesso a dados financeiros atualizados é essencial para tomar decisões informadas nos mercados globais. É por isso que a API da brapi se tornou uma ferramenta indispensável para desenvolvedores e empresas que buscam integrar dados financeiros em suas aplicações.

Como começar?

Para começar a usar a API da brapi, você pode fazer uma requisição simples para obter informações sobre uma ação específica. Por exemplo, para obter dados da Petrobras (PETR4), você pode usar:

curl https://brapi.dev/api/quote/PETR4

Esta requisição retornará informações básicas sobre a ação, incluindo preço atual, variação e volume.

Posso usar a API gratuitamente?

Sim! A API da brapi oferece um plano gratuito que permite até 15.000 requisições por mês. Este plano é ideal para desenvolvedores que estão começando ou para projetos de menor escala.

Ações de teste com acesso irrestrito

Para facilitar o desenvolvimento e teste da API, disponibilizamos 4 ações com acesso completo e irrestrito:

  • PETR4 (Petrobras PN)
  • MGLU3 (Magazine Luiza ON)
  • VALE3 (Vale ON)
  • ITUB4 (Itaú Unibanco PN)

Vantagens das ações de teste:

Sem necessidade de autenticação - Não precisa de token ou chave de API
Sem limites de requisições - Pode fazer quantas requisições quiser
Acesso a todos os módulos - Dados fundamentalistas, históricos, dividendos
Todos os intervalos e períodos - 1m, 5m, 1h, 1d, 1y, etc.
Dados em tempo real - Informações sempre atualizadas

Exemplos de uso:

# Cotação simples da Petrobras (sem token)
curl https://brapi.dev/api/quote/PETR4

# Dados históricos completos (sem token)
curl https://brapi.dev/api/quote/VALE3?range=1y&interval=1d

# Todas as 4 ações com módulos avançados (sem token)
curl "https://brapi.dev/api/quote/PETR4,MGLU3,VALE3,ITUB4?modules=summaryProfile,balanceSheetHistory,defaultKeyStatistics&dividends=true"

⚠️ Importante: Se você misturar ações de teste com outras ações na mesma requisição, a autenticação será obrigatória.

Exemplo que requer autenticação:

# Mistura PETR4 (teste) com BBAS3 (requer token)
curl "https://brapi.dev/api/quote/PETR4,BBAS3?token=SEU_TOKEN"

Quais dados estão disponíveis?

A API oferece uma ampla gama de dados financeiros, incluindo:

  • Cotações de ações, FIIs e BDRs
  • Dados históricos de preços
  • Informações sobre dividendos
  • Dados fundamentalistas (balanços, DREs)
  • Indicadores financeiros
  • Dados de criptomoedas
  • Taxas de câmbio
  • Índices econômicos

Como obter dados históricos?

Para obter dados históricos, você pode usar os parâmetros range e interval. Por exemplo:

curl https://brapi.dev/api/quote/PETR4?range=1y&interval=1d

Isso retornará dados diários do último ano para a Petrobras.

Como funciona a autenticação?

Para planos pagos, você receberá uma chave de API que deve ser incluída no cabeçalho Authorization das suas requisições:

curl -H "Authorization: Bearer sua-chave-api" https://brapi.dev/api/quote/PETR4

Há limites de requisições?

Sim, os limites variam por plano:

  • Gratuito: 15.000 requisições/mês, 1 ação por requisição
  • Startup: 150.000 requisições/mês, 10 ações por requisição
  • Pro: 500.000 requisições/mês, 20 ações por requisição

Como monitorar meu uso?

Você pode acompanhar seu uso através do dashboard, onde encontrará gráficos detalhados sobre suas requisições e limites.

A API suporta WebSockets?

Atualmente, a API funciona através de requisições HTTP REST. Para dados atualizados, recomendamos fazer requisições periódicas conforme sua necessidade.

Como reportar problemas?

Se encontrar algum problema ou tiver sugestões, você pode:

Documentação adicional

Para informações mais detalhadas, consulte nossa documentação completa que inclui exemplos de código, referências de API e guias de implementação.