Skip to main content
POST
/
v1
/
dividends
/
query
Dividends
curl --request POST \
  --url https://api.bigdata.com/v1/dividends/query \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "identifier": {
    "type": "rp_entity_id",
    "value": "4A6F00"
  },
  "limit": 100
}'
{
  "results": [
    {
      "rp_entity_id": "D8442A",
      "target_identifier_id": "AAPL",
      "fields": [
        "DATE",
        "DIVIDEND",
        "ADJ_DIVIDEND",
        "RECORD_DATE",
        "PAYMENT_DATE",
        "DECLARATION_DATE",
        "YIELD",
        "FREQUENCY"
      ],
      "values": [
        [
          "2023-08-11",
          0.24,
          0.24,
          "2023-08-14",
          "2023-08-17",
          "2023-08-03",
          null,
          "Quarterly"
        ],
        [
          "2023-11-10",
          0.24,
          0.24,
          "2023-11-13",
          "2023-11-16",
          "2023-11-02",
          null,
          "Quarterly"
        ]
      ]
    }
  ],
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "metadata": {
    "request_id": "<string>",
    "timestamp": "<string>"
  }
}

Authorizations

X-API-KEY
string
header
required

Body

application/json
identifier
object
required

Object specifying which identifier you are using to request the dividend data. You must supply one type and its corresponding value. Only one identifier should be provided per request.

limit
integer | null

The maximum number of dividend records to return per entity. Must be between 1 and 1000.

Required range: 1 <= x <= 1000
Examples:

100

Response

200 - application/json

Successful Response

Company Dividends response model.

results
DividendsResults · object[]
required

The main data result

errors
ErrorDetail · object[] | null
metadata
object | null