Pular para o conteúdo principal
Cole no ChatGPT/Claude e peça para resumir/gerar SDK.

Proventos em dinheiro

GET
/traded-funds/{identifier}/cash-corporate-actions

Retorna eventos corporativos em dinheiro (ex.: dividendos e amortizações) para um fundo listado específico.

Esse endpoint é ideal para:

  • montar timeline/calendário de proventos no detalhe do fundo
  • alimentar alertas de data-com e pagamento
  • conciliar distribuições com fonte oficial rastreável

Quando usar

  • Consultar histórico de proventos de um fundo (HGLG11, HGLG, 11728688000147)
  • Filtrar janela de pagamento com start_date e end_date
  • Exibir dados já normalizados para UI (value, net_value, adjusted_*)

Parâmetros de requisição

ParâmetroLocalDescriçãoObrigatório
identifierURLIdentificador do fundo (symbol ou company_id).Obrigatório
currentQuerySe true, retorna apenas a versão atual do evento. Padrão: true.Opcional
start_dateQueryISO 8601. Filtra por payment_date a partir desta data.Opcional
end_dateQueryISO 8601. Filtra por payment_date até esta data.Opcional
Boas práticas
  • Para timeline estável, use current=true.
  • Use start_date + end_date para reduzir payload em telas de calendário.
  • Ordenação já vem por data mais recente (pagamento/data-com/publicação/criação, nesta ordem de fallback).

Resposta

CódigoDescrição
200Retorna os eventos corporativos em dinheiro do fundo.
400Parâmetros ausentes ou inválidos.
401Não autorizado.
404Fundo não encontrado.

Formato da resposta

A resposta é uma lista de objetos com os campos abaixo:

CampoTipoDescrição
event_typestringTipo do evento corporativo (ex.: dividends, amortization).
protocolnumberProtocolo do documento de origem.
publish_datestring (ISO 8601)Data/hora de publicação do documento.
created_atstring (ISO 8601)Data/hora de criação do registro na base da Partnr.
prior_ex_datestring (ISO 8601) | nullData-com/data-ex do evento.
payment_datestring (ISO 8601) | nullData de pagamento do provento.
isin_codestringISIN associado ao evento.
valuenumberValor bruto por cota.
net_valuenumberValor líquido por cota.
currencystringMoeda do valor (ex.: BRL).
namestringNome do evento (ex.: Rendimento).
period_referencestring | nullPeríodo de referência informado na origem.
amortization_typestring | nullTipo de amortização (quando aplicável).
sourceobjectMetadados e links da fonte oficial.
idstringID único do evento na base da Partnr.
adjusted_valuenumberValor bruto ajustado por eventos corporativos históricos.
adjusted_net_valuenumberValor líquido ajustado por eventos corporativos históricos.
adjustment_factornumberFator de ajuste aplicado aos campos ajustados.
currentbooleanSó aparece quando current=false for enviado na query.

Estrutura de source

CampoTipoDescrição
visualization_urlstringURL para visualização do documento oficial.
download_urlstringURL para download do documento oficial.
published_atstring (ISO 8601)Data/hora de publicação na origem.
retrieved_atstring (ISO 8601)Data/hora em que o documento foi coletado pela Partnr.
namestringNome do documento/evento na fonte.
Sobre campos ajustados (adjusted_*)

Os campos adjusted_value e adjusted_net_value são retornados em base ajustada para comparabilidade histórica com a cotação atual.

Exemplo

[
{
"event_type": "dividends",
"protocol": 1124347,
"publish_date": "2026-02-27T18:03:00.000Z",
"created_at": "2026-03-11T21:14:50.887Z",
"prior_ex_date": "2026-02-27",
"payment_date": "2026-03-13",
"isin_code": "BRHGLGCTF004",
"value": 1.1,
"net_value": 1.1,
"currency": "BRL",
"name": "Rendimento",
"period_reference": "FEVEREIRO",
"amortization_type": null,
"source": {
"visualization_url": "https://fnet.bmfbovespa.com.br/fnet/publico/exibirDocumento?id=1124347&cvm=true",
"download_url": "https://fnet.bmfbovespa.com.br/fnet/publico/downloadDocumento?id=1124347",
"published_at": "2026-02-27T18:03:00.000Z",
"retrieved_at": "2026-03-11T21:14:50.887Z",
"name": "Rendimento (HGLG11 - R$ 1.1)"
},
"id": "69b1db4ac474ef16c4f492ba",
"adjusted_value": 1.1,
"adjusted_net_value": 1.1,
"adjustment_factor": 1
},
{
"event_type": "dividends",
"protocol": 1098043,
"publish_date": "2026-01-30T18:03:00.000Z",
"created_at": "2026-03-11T18:26:59.466Z",
"prior_ex_date": "2026-01-30",
"payment_date": "2026-02-13",
"isin_code": "BRHGLGCTF004",
"value": 1.1,
"net_value": 1.1,
"currency": "BRL",
"name": "Rendimento",
"period_reference": "JANEIRO",
"amortization_type": null,
"source": {
"visualization_url": "https://fnet.bmfbovespa.com.br/fnet/publico/exibirDocumento?id=1098043&cvm=true",
"download_url": "https://fnet.bmfbovespa.com.br/fnet/publico/downloadDocumento?id=1098043",
"published_at": "2026-01-30T18:03:00.000Z",
"retrieved_at": "2026-03-11T18:26:59.466Z",
"name": "Rendimento (HGLG11 - R$ 1.1)"
},
"id": "69b1b3f3e190d3002a20133e",
"adjusted_value": 1.1,
"adjusted_net_value": 1.1,
"adjustment_factor": 1
}
]