Cole no ChatGPT/Claude e peça para resumir/gerar SDK.
Proventos em dinheiro
GET
/traded-funds/[fundIdentifier]/cash-corporate-actions
Retorna eventos corporativos em dinheiro (ex.: rendimentos, dividendos, amortizações) para um fundo listado específico (FII, ETF, Fiagro, FI-Infra etc.).
Esse endpoint é ideal para:
- telas de detalhe do fundo (timeline de proventos/rendimentos)
- alertas para cotistas (ex.: anunciou / data-ex / pagamento)
- automações de carteira e conciliação de eventos com fonte rastreável
Quando usar
- Construir um calendário/timeline de proventos de um fundo (ex.: HGLG11)
- Conciliar valores com fonte oficial via campo
source - Montar séries históricas com valores ajustados (
adjusted_value,adjusted_net_value)
Parâmetros de requisição
| Parâmetro | Local | Descrição | Obrigatório |
|---|---|---|---|
[fundIdentifier] | URL | Identificador do fundo (ticker ou symbol). | 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 montar uma timeline "limpa", use
current=truee filtre por janela de datas quando necessário. payment_datepode sernullquando o pagamento ainda não foi definido; usepublish_dateeprior_ex_datecomo marcos do evento.
Resposta
| Código | Descrição |
|---|---|
| 200 | Retorna os eventos corporativos em dinheiro. |
| 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 (ex.: dividends). |
protocol | number | Protocolo do documento na FNET/CVM. |
publish_date | string (ISO 8601) | Data de publicação do evento. |
created_at | string (ISO 8601) | Data/hora de criação do registro na base da Partnr. |
prior_ex_date | string (date) | Data com ("data-ex"), usada para elegibilidade ao provento. |
payment_date | string (date) | null | Data de pagamento do provento (quando definida). |
isin_code | string | ISIN da classe de ativo associada ao provento. |
value | number | Valor bruto do provento por cota. |
net_value | number | Valor líquido (descontado de impostos retidos na fonte, quando aplicável). |
currency | string | Moeda do valor retornado (ex.: BRL). |
name | string | Nome/tipo do provento (ex.: Rendimento, Dividendo, Amortização). |
period_reference | string | null | Período de referência do provento (ex.: Novembro, 1º Semestre). |
amortization_type | string | null | Tipo de amortização (quando o evento é uma amortização). |
source | object | Metadados e links da fonte oficial do documento. |
id | string | ID único do provento na base da Partnr. |
adjusted_value | number | Valor bruto ajustado por eventos corporativos historicamente, para comparabilidade. |
adjusted_net_value | number | Valor líquido ajustado por eventos corporativos historicamente. |
adjustment_factor | number | Fator de ajuste corporativo usado para converter valores históricos para base comparável atual. |
Estrutura de source
| Campo | Tipo | Descrição |
|---|---|---|
visualization_url | string | URL para visualização do documento original na FNET. |
download_url | string | URL para download do documento original. |
published_at | string (ISO 8601) | Data de publicação do documento na fonte. |
retrieved_at | string (ISO 8601) | Data/hora em que a Partnr coletou o documento. |
name | string | Descrição resumida do evento (ex.: Rendimento (HGLG11 - R$ 1.1)). |
Sobre campos ajustados (
adjusted_*)Tudo que é adjusted é ajustado historicamente por eventos corporativos (como desdobramentos e grupamentos) para que o valor possa ser comparado de forma consistente com o preço atual da cota.
Exemplo
[
{
"event_type": "dividends",
"protocol": 792417,
"publish_date": "2024-11-29T18:05:00.000Z",
"created_at": "2026-04-08T17:49:36.198Z",
"prior_ex_date": "2024-11-29",
"payment_date": "2024-12-13",
"isin_code": "BRHGLGCTF004",
"value": 1.1,
"net_value": 1.1,
"currency": "BRL",
"name": "Rendimento",
"period_reference": "Novembro",
"amortization_type": null,
"source": {
"visualization_url": "https://fnet.bmfbovespa.com.br/fnet/publico/exibirDocumento?id=792417&cvm=true",
"download_url": "https://fnet.bmfbovespa.com.br/fnet/publico/downloadDocumento?id=792417",
"published_at": "2024-11-29T18:05:00.000Z",
"retrieved_at": "2026-04-08T17:49:36.198Z",
"name": "Rendimento (HGLG11 - R$ 1.1)"
},
"id": "69d69530f4f4b88b430ebba4",
"adjusted_value": 1.1,
"adjusted_net_value": 1.1,
"adjustment_factor": 1
}
]