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_dateeend_date - Exibir dados já normalizados para UI (
value,net_value,adjusted_*)
Parâmetros de requisição
| Parâmetro | Local | Descrição | Obrigatório |
|---|---|---|---|
identifier | URL | Identificador do fundo (symbol ou company_id). | Obrigatório |
current | Query | Se true, retorna apenas a versão atual do evento. Padrão: true. | Opcional |
start_date | Query | ISO 8601. Filtra por payment_date a partir desta data. | Opcional |
end_date | Query | ISO 8601. Filtra por payment_date até esta data. | Opcional |
Boas práticas
- Para timeline estável, use
current=true. - Use
start_date+end_datepara 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ódigo | Descrição |
|---|---|
| 200 | Retorna os eventos corporativos em dinheiro do fundo. |
| 400 | Parâmetros ausentes ou inválidos. |
| 401 | Não autorizado. |
| 404 | Fundo não encontrado. |
Formato da resposta
A resposta é uma lista de objetos com os campos abaixo:
| Campo | Tipo | Descrição |
|---|---|---|
event_type | string | Tipo do evento corporativo (ex.: dividends, amortization). |
protocol | number | Protocolo do documento de origem. |
publish_date | string (ISO 8601) | Data/hora de publicação do documento. |
created_at | string (ISO 8601) | Data/hora de criação do registro na base da Partnr. |
prior_ex_date | string (ISO 8601) | null | Data-com/data-ex do evento. |
payment_date | string (ISO 8601) | null | Data de pagamento do provento. |
isin_code | string | ISIN associado ao evento. |
value | number | Valor bruto por cota. |
net_value | number | Valor líquido por cota. |
currency | string | Moeda do valor (ex.: BRL). |
name | string | Nome do evento (ex.: Rendimento). |
period_reference | string | null | Período de referência informado na origem. |
amortization_type | string | null | Tipo de amortização (quando aplicável). |
source | object | Metadados e links da fonte oficial. |
id | string | ID único do evento na base da Partnr. |
adjusted_value | number | Valor bruto ajustado por eventos corporativos históricos. |
adjusted_net_value | number | Valor líquido ajustado por eventos corporativos históricos. |
adjustment_factor | number | Fator de ajuste aplicado aos campos ajustados. |
current | boolean | Só aparece quando current=false for enviado na query. |
Estrutura de source
| Campo | Tipo | Descrição |
|---|---|---|
visualization_url | string | URL para visualização do documento oficial. |
download_url | string | URL para download do documento oficial. |
published_at | string (ISO 8601) | Data/hora de publicação na origem. |
retrieved_at | string (ISO 8601) | Data/hora em que o documento foi coletado pela Partnr. |
name | string | Nome 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
}
]