Cole no ChatGPT/Claude e peça para resumir/gerar SDK.

Proventos em dinheiro

GET

/companies/[companyIdentifier]/cash-corporate-actions

Retorna eventos corporativos em dinheiro (ex.: dividendos, JCP, restituições, amortizações) para uma empresa específica.

Esse endpoint é ideal para:

telas de detalhe do ativo/empresa (timeline de proventos)
alertas para investidores (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 uma empresa (ex.: PETR)
Filtrar por classe (ON/PN/UNIT) com stock_type
Consumir proventos já “prontos para UI” (ex.: parcelas em installments quando existirem)

Parâmetros de requisição

Parâmetro	Local	Descrição	Obrigatório
`[companyIdentifier]`	URL	Identificador da empresa (`symbol`, `company_id` ou `ticker`).	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
`stock_type`	Query	Filtra por tipo (CS, PS, PSA, PSB, PSC, PSD, UNIT).	Opcional

Boas práticas

Para montar uma timeline “limpa”, use current=true e filtre por janela de datas quando necessário.
payment_date pode ser null quando o pagamento ainda não foi definido; use approval_date, publish_date e prior_ex_date como marcos do evento.
Um mesmo evento pode ter parcelas; quando existir installments, ele descreve pagamentos em múltiplas datas.

Se você usar ticker

Quando o identificador é um ticker, a resposta é filtrada para o tipo de ação correspondente.
Ex.: PETR4 tende a retornar apenas eventos para stock_type=PS e PETR3 tende a retornar eventos para stock_type=CS.

Resposta

Código	Descrição
200	Retorna os eventos corporativos em dinheiro.
400	Parâmetros ausentes ou inválidos.
401	Não autorizado.
404	Empresa não encontrada.

Formato da resposta

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

Campo	Tipo	Descrição
`approval_date`	string (ISO 8601) \| null	Data de aprovação do provento.
`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/sem (ex-date), usada para elegibilidade ao provento.
`protocol`	string	Protocolo do provento na CVM.
`publish_date`	string (ISO 8601)	Data de publicação do evento.
`id`	string	ID único do provento na base da Partnr.
`payment_date`	string (ISO 8601) \| null	Data de pagamento do provento (quando definida).
`stock_type`	string	Tipo de ação (`CS`, `PS`, `PSA`, `PSB`, `PSC`, `PSD`, `UNIT`).
`isin_code`	string	ISIN da classe de ativo associada ao provento.
`value`	number	Valor bruto do provento por ação/cota.
`name`	string	Nome/tipo do provento (ex.: `Dividendo`, `Juros sobre capital próprio`).
`code`	string	Código do provento na CVM.
`installments`	array	Lista de parcelas do provento quando o pagamento é dividido em múltiplas datas.
`net_value`	number	Valor líquido (descontado de impostos retidos na fonte, ex.: 15% em JCP quando aplicável).
`adjusted_value`	number	Valor bruto ajustado por eventos corporativos historicamente, para comparabilidade com o preço atual da ação.
`adjusted_net_value`	number	Valor líquido ajustado por eventos corporativos historicamente, para comparabilidade com o preço atual da ação.
`adjustment_factor`	number	Fator de ajuste corporativo usado para converter valores históricos para base comparável atual.
`currency`	string	Moeda do valor retornado (ex.: `BRL`).
`source`	object	Metadados e links da fonte oficial do documento.

Estrutura de `installments[]`

Campo	Tipo	Descrição
`value`	number	Valor bruto da parcela.
`net_value`	number \| null	Valor líquido da parcela (após retenções, quando aplicável).
`adjusted_value`	number \| null	Valor bruto da parcela ajustado por eventos corporativos historicamente.
`adjusted_net_value`	number \| null	Valor líquido da parcela ajustado por eventos corporativos historicamente.
`currency`	string	Moeda da parcela.
`payment_date`	string (ISO 8601) \| null	Data de pagamento da parcela.

Sobre campos ajustados (adjusted_*)

Tudo que é adjusted é ajustado historicamente por eventos corporativos (como desdobramentos, grupamentos, bonificações etc.) para que o valor possa ser comparado de forma consistente com o preço atual da ação.

Exemplo

[
  {
    "approval_date": "2025-02-26T00:00:00.000Z",
    "created_at": "2025-12-02T23:09:19.198Z",
    "prior_ex_date": "2025-04-16T22:00:00.000Z",
    "protocol": "1377546",
    "publish_date": "2025-06-13T00:00:00.000Z",
    "id": "692f72ff409eb94a8273947e",
    "payment_date": null,
    "stock_type": "PS",
    "isin_code": "BRPETRACNPR6",
    "value": 0.70954522,
    "name": "Dividendo",
    "code": "57535",
    "installments": [
      {
        "value": 0.35477261,
        "net_value": 0.35477261,
        "adjusted_value": 0.35477261,
        "adjusted_net_value": 0.35477261,
        "currency": "BRL",
        "payment_date": "2025-05-20T00:00:00.000Z"
      },
      {
        "value": 0.35477261,
        "net_value": 0.35477261,
        "adjusted_value": 0.35477261,
        "adjusted_net_value": 0.35477261,
        "currency": "BRL",
        "payment_date": "2025-06-20T00:00:00.000Z"
      }
    ],
    "net_value": 0.70954522,
    "adjusted_value": 0.70954522,
    "adjusted_net_value": 0.70954522,
    "adjustment_factor": 1,
    "currency": "BRL",
    "source": {
      "visualization_url": "https://www.rad.cvm.gov.br/ENET/frmExibirArquivoIPEExterno.aspx?NumeroProtocoloEntrega=1377546",
      "download_url": "https://www.rad.cvm.gov.br/ENET/frmExibirArquivoIPEExterno.aspx?NumeroProtocoloEntrega=1377546",
      "published_at": "2025-06-13T00:00:00.000Z",
      "retrieved_at": "2025-12-02T23:09:19.198Z",
      "name": "Dividendo (57535 - R$ 0.70954522)"
    }
  },
  {
    "approval_date": "2024-12-09T00:00:00.000Z",
    "created_at": "2025-12-02T23:09:19.198Z",
    "prior_ex_date": "2024-12-23T22:00:00.000Z",
    "protocol": "1334793",
    "publish_date": "2025-03-13T00:00:00.000Z",
    "id": "692f72fe409eb94a8273946b",
    "payment_date": "2025-03-20T13:00:00.000Z",
    "stock_type": "PS",
    "isin_code": "BRPETRACNPR6",
    "value": 0.01053822,
    "name": "Juros sobre capital próprio",
    "code": "55317",
    "net_value": 0.008957486999999998,
    "adjusted_value": 0.01053822,
    "adjusted_net_value": 0.008957486999999998,
    "adjustment_factor": 1,
    "currency": "BRL",
    "source": {
      "visualization_url": "https://www.rad.cvm.gov.br/ENET/frmExibirArquivoIPEExterno.aspx?NumeroProtocoloEntrega=1334793",
      "download_url": "https://www.rad.cvm.gov.br/ENET/frmExibirArquivoIPEExterno.aspx?NumeroProtocoloEntrega=1334793",
      "published_at": "2025-03-13T00:00:00.000Z",
      "retrieved_at": "2025-12-02T23:09:19.198Z",
      "name": "Juros sobre capital próprio (55317 - R$ 0.01053822)"
    }
  }
]

Quando usar​

Parâmetros de requisição​

Resposta​

Formato da resposta​

Estrutura de installments[]​

Exemplo​