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
}
'import requests
url = "https://api.bigdata.com/v1/dividends/query"
payload = {
"identifier": {
"type": "rp_entity_id",
"value": "4A6F00"
},
"limit": 100
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({identifier: {type: 'rp_entity_id', value: '4A6F00'}, limit: 100})
};
fetch('https://api.bigdata.com/v1/dividends/query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bigdata.com/v1/dividends/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'identifier' => [
'type' => 'rp_entity_id',
'value' => '4A6F00'
],
'limit' => 100
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bigdata.com/v1/dividends/query"
payload := strings.NewReader("{\n \"identifier\": {\n \"type\": \"rp_entity_id\",\n \"value\": \"4A6F00\"\n },\n \"limit\": 100\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bigdata.com/v1/dividends/query")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"identifier\": {\n \"type\": \"rp_entity_id\",\n \"value\": \"4A6F00\"\n },\n \"limit\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bigdata.com/v1/dividends/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"identifier\": {\n \"type\": \"rp_entity_id\",\n \"value\": \"4A6F00\"\n },\n \"limit\": 100\n}"
response = http.request(request)
puts response.read_body{
"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>"
},
"sources": [
{
"id": "CA9FA3",
"name": "Corporate Fundamentals"
}
],
"usage": {}
}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.
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
}
'import requests
url = "https://api.bigdata.com/v1/dividends/query"
payload = {
"identifier": {
"type": "rp_entity_id",
"value": "4A6F00"
},
"limit": 100
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({identifier: {type: 'rp_entity_id', value: '4A6F00'}, limit: 100})
};
fetch('https://api.bigdata.com/v1/dividends/query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bigdata.com/v1/dividends/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'identifier' => [
'type' => 'rp_entity_id',
'value' => '4A6F00'
],
'limit' => 100
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bigdata.com/v1/dividends/query"
payload := strings.NewReader("{\n \"identifier\": {\n \"type\": \"rp_entity_id\",\n \"value\": \"4A6F00\"\n },\n \"limit\": 100\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bigdata.com/v1/dividends/query")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"identifier\": {\n \"type\": \"rp_entity_id\",\n \"value\": \"4A6F00\"\n },\n \"limit\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bigdata.com/v1/dividends/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"identifier\": {\n \"type\": \"rp_entity_id\",\n \"value\": \"4A6F00\"\n },\n \"limit\": 100\n}"
response = http.request(request)
puts response.read_body{
"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>"
},
"sources": [
{
"id": "CA9FA3",
"name": "Corporate Fundamentals"
}
],
"usage": {}
}Authorizations
Body
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
Show child attributes
{ "type": "rp_entity_id", "value": "4A6F00" }
The maximum number of dividend records to return per entity. Must be between 1 and 1000.
1 <= x <= 1000100
Response
Successful Response
Company Dividends response model.
The main data result
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The content catalog sources the response was built from, one entry per source. Empty when no catalog source contributed.
Show child attributes
Show child attributes
Tokens the request consumed, per content tier. Present only for API keys billed in tokens.
Show child attributes
Show child attributes
Was this page helpful?