List all cash corporate actions
GET https://data.partnr.ai/v2/companies/[companyIdentifier]/cash-corporate-actions
Returns cash corporate actions (such as dividends) for a specific company.
Request Parameters
Parameter | Location | Description | Required |
---|---|---|---|
companyIdentifier | Path parameter | Company Identifier of the company to be queried. | Required |
current | Query parameter | Boolean. If true, returns only the current version of the corporate actions. Defaults to true. | Optional |
start_date | Query parameter | ISO 8601 date string. Filter actions with payment_date from this date onwards. | Optional |
end_date | Query parameter | ISO 8601 date string. Filter actions with payment_date up to this date. | Optional |
stock_type | Query parameter | Stock type filter. Valid values: CS, PS, PSB, PSC, PSD, UNIT. | Optional |
Company Identifier
The companyIdentifier
can be one of the following:
- symbol: the company's symbol. Example: PETR (Petrobras' Symbol)
- company_id: the company's ID (CNPJ). Example: 33000167000101 (Petrobras' CNPJ)
- ticker: the company's ticker. Example: PETR3 (Petrobras' Ticker for common stock)
caution
If you specify a ticker, corporate actions that are specific to each type of stock will be filtered to return only the ones specific to that type of stock.
For example, if you specify the ticker PETR3
, the corporate actions will be filtered to return only the ones specific to Petrobras' common stock.
Response
Code | Description |
---|---|
200 | Returns cash corporate actions. |
401 | Unauthorized. |
404 | Company not found. |
Response Schema
Field | Type | Description |
---|---|---|
id | string | Unique identifier for the corporate action. |
approval_date | string | ISO 8601 date when the action was approved. |
ex_date | string | ISO 8601 date when the stock goes ex-dividend. |
publish_date | string | ISO 8601 date when the action was published. |
payment_date | string | ISO 8601 date when payment is made (null if not yet disclosed). |
protocol | string | CVM protocol number. |
stock_type | string | Type of stock (CS, PS, PSB, PSC, PSD, UNIT). |
isin_code | string | ISIN code for the security. |
name | string | Name of the corporate action as reported (e.g., "Dividendo"). |
code | string | Corporate action code. |
value | number | Total value of the corporate action. |
net_value | number | Net value after taxes. |
currency | string | Currency code (e.g., "BRL"). |
installments | array | Array of installment objects for multi-payment actions. |
created_at | string | ISO 8601 date when the record was created. |
source | object | Source information object. |
Installment Schema
Field | Type | Description |
---|---|---|
value | number | Value of this installment. |
net_value | number | Net value of this installment after taxes. |
currency | string | Currency code (e.g., "BRL"). |
payment_date | string | ISO 8601 date when this installment is paid. |
Source Schema
Field | Type | Description |
---|---|---|
name | string | Descriptive name of the source document. |
visualization_url | string | URL to view the source document. |
download_url | string | URL to download the source document. |
published_at | string | ISO 8601 date when the source was published. |
retrieved_at | string | ISO 8601 date when the source was retrieved. |
Names
The name referes to how the corporate action was reported to the regulatory organ (CVM in Brazil, for example). Currently observed names are:
- Dividendo
- Juros sobre capital próprio
- Juros - renda fixa
- Prêmio - renda fixa
- Resgate total - renda fixa
- Amortização - renda fixa
- Resgate total - renda variável
- Restituição de capital em dinheiro
- Bonificação em dinheiro
Example
[
{
"approval_date": "2024-03-07T00:00:00.000Z",
"created_at": "2025-08-26T18:26:40.945Z",
"ex_date": "2024-04-25T22:00:00.000Z",
"protocol": "1204672",
"publish_date": "2024-06-14T00:00:00.000Z",
"id": "68adfdb745471b3b1eebd19a",
"payment_date": null,
"stock_type": "PS",
"isin_code": "BRPETRACNPR6",
"value": 1.10031574,
"name": "Dividendo",
"code": "49200",
"installments": [
{
"value": 0.55015787,
"net_value": 0.55015787,
"currency": "BRL",
"payment_date": "2024-05-20T00:00:00.000Z"
},
{
"value": 0.55015787,
"net_value": 0.55015787,
"currency": "BRL",
"payment_date": "2024-06-20T00:00:00.000Z"
}
],
"net_value": 1.10031574,
"currency": "BRL",
"source": {
"visualization_url": "https://www.rad.cvm.gov.br/ENET/frmExibirArquivoIPEExterno.aspx?NumeroProtocoloEntrega=1204672",
"download_url": "https://www.rad.cvm.gov.br/ENET/frmExibirArquivoIPEExterno.aspx?NumeroProtocoloEntrega=1204672",
"published_at": "2024-06-14T00:00:00.000Z",
"retrieved_at": "2025-08-26T18:26:40.945Z",
"name": "Dividendo (49200 - R$ 1.10031574000)"
}
}
]
info
Cash corporate actions include dividends, interest on capital, and other cash distributions to shareholders. The installments
array is used for actions that are paid in multiple installments over time.