Como consultar dividendos e JCP pela API da brapi?
Os planos pagos incluem dados de proventos com valor por ação, data-com e data de pagamento para análises de renda e histórico.
Os planos Startup e Pro incluem dados de proventos de ações. Eles permitem montar históricos de dividendos e JCP, calcular valores recebidos por uma carteira e exibir datas importantes no seu produto.
Campos principais
| Campo | Significado |
|---|---|
rate | Valor do provento por ação |
lastDatePrior | Data-com, último dia para ter direito |
paymentDate | Data de pagamento, quando informada |
approvedOn | Data de aprovação, quando informada |
label | Tipo ou descrição do provento |
Os nomes acima refletem a resposta da API. Nem todo evento terá todas as datas preenchidas, então a integração deve tratar valores nulos.
Exemplo
Peça o módulo de dividendos no endpoint de cotação:
curl -H "Authorization: Bearer SEU_TOKEN" \
"https://brapi.dev/api/quote/PETR4?dividends=true"A resposta inclui dividendsData.cashDividends, além de outras categorias de
eventos quando disponíveis.
Casos de uso
- consolidar proventos recebidos por uma carteira;
- comparar histórico de pagamentos entre empresas;
- criar calendário de data-com e pagamento;
- calcular dividend yield com uma metodologia explícita;
- exibir alertas de eventos corporativos.
Histórico não é previsão. Empresas podem reduzir, suspender ou alterar pagamentos. Para consultar a estrutura completa, veja a documentação de ações.
Como funciona o cancelamento da assinatura?
Saiba como cancelar sua assinatura na brapi de forma simples e sem burocracia. Entenda o que acontece após o cancelamento e como reativar quando quiser.
Como realizar um upgrade ou downgrade de plano?
Saiba como realizar um upgrade ou downgrade de plano na brapi. Acesse a sua Dashboard, siga o guia passo a passo e escolha o plano certo para atender às necessidades do seu projeto. Após a troca de plano, tenha acesso imediato aos novos recursos e limites. Conte com o suporte da brapi para uma ótima experiência com nossa API.