Dividends

Returns historical and upcoming dividend data for companies. Supports stocks and ETFs. Each dividend record includes ex-dividend date, record date, payment date, declaration date, dividend amount, adjusted dividend, yield, and frequency.

POST /v1/dividends/query

Try it

Dividends

cURL

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": "<string>"
  },
  "limit": 100
}
'

200

{
  "results": [
    {
      "rp_entity_id": "D8442A",
      "target_identifier_id": "AAPL",
      "fields": [
        "<string>"
      ],
      "values": [
        [
          "<string>"
        ]
      ]
    }
  ],
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "metadata": {
    "request_id": "<string>",
    "timestamp": "<string>"
  }
}

Authorizations

X-API-KEY · string · header · required

Body

application/json

identifier · SingleIdentifier · 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.

Show child attributes

identifier. type · enum<string> · default: rp_entity_id · required

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

Available options: rp_entity_id

identifier. value · string · required

Bigdata uses the RavenPack Entity identifier (RP_Entity_ID) to uniquely reference entities such as companies. This identifier is a 6-character alphanumeric code (letters and numbers only). Example: Alphabet Inc. (4A6F00)

limit · integer | null

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

Required range: 1 <= x <= 1000

Example:

100

Response

200 - application/json

Successful Response

Company Dividends response model.

results · DividendsResults · object[] · required

The main data result

Show child attributes

results. rp_entity_id · string | null · required

RP Entity identifier

Example:

"D8442A"

results. target_identifier_id · string | null · required

The external identifier ID, such as a symbol

Example:

"AAPL"

results. fields · string[] · required

Column names for the data values

results. values · ((string | number | null)[])[] · required

Dividend records. Each array contains [date, dividend, adjDividend, recordDate, paymentDate, declarationDate, yield, frequency]

errors · ErrorDetail · object[] | null

Show child attributes

errors. message · string | null

metadata · Metadata · object

Show child attributes

metadata. request_id · string · required

metadata. timestamp · string