Dividend Data API

getDividendData

The getDividendData API provides the most recent dividend data for requested instruments.

View All APIs

Contact Us to Get Access

First Name^*

Last Name^*

Email Address^*

Phone^*

Company^*

Role^*

Industry^*

Country^*

What you are looking for?^*

Please provide as much information as possible (e.g. exchanges, markets or other data sources), the APIs you are interested in (e.g. getQuote, getHistory, getChart, getCorporateActions, etc.), and your use case.

Here are some examples: Example #1, Example #2, Example #3.

By submitting this form you are opting in to receive email communications from Barchart for related product, service or company information, updates and announcements. You can unsubscribe at anytime. View our Privacy Policy.

Inputs

symbols^required

A symbol or code that identifies a financial instrument. Multiple symbols separated by a comma may be used.

Type

list (A comma or semi-colon delimited string.)

Example

IBM,AAPL,GOOG

Outputs

symbol
always returned

The instrument symbol.

string
A sequence of characters. (example: GOOG)

announcementDate
always returned

The date of announcement.

date
A date in the format of YYYY-MM-DD.

exDividendDate
always returned

The ex-dividend date.

date
A date in the format of YYYY-MM-DD.

recordDate
always returned

The date of the record.

date
A date in the format of YYYY-MM-DD.

paymentDate
always returned

The date of the payment of the dividend.

date
A date in the format of YYYY-MM-DD.

dividend
always returned

The dividend to be paid.

double
A numeric type defining a number with fractional parts. (example: 2.14)

dividendYield
always returned

The dividend yield.

double
A numeric type defining a number with fractional parts. (example: 2.14)

dividendYieldPct
always returned

Dividend yield as a percentage.

double
A numeric type defining a number with fractional parts. (example: 2.14)

frequency
always returned

The frequency of the dividend payout. The frequency numbers represent: 0: None, 1: Annual, 2: Bi-Annual, 3: Thrice Annual, 4: Quarterly, 5: Monthly, 6: Bi-Monthly, 7: To Be Determined, 8: Variable, 9: Not Available

int
A numeric type defining a whole number. (example: 2)

indicatedAnnualDividend
always returned

the indicated annual dividend per share.

double
A numeric type defining a number with fractional parts. (example: 2.14)

dividendRateForward
always returned

The forward dividend rate.

double
A numeric type defining a number with fractional parts. (example: 2.14)

Status Code Responses

200

OK

Success

400

Bad Request

The request was invalid, please see the message for more information.

500

Internal Server Error

Something is not working correctly, please contact support.

JSON

GET

GET https://ondemand.websol.barchart.com/getDividendData.json?apikey=YOUR_API_KEY&symbols=IBM%2CAAPL%2CGOOG
Host: ondemand.websol.barchart.com

POST

POST https://ondemand.websol.barchart.com/getDividendData.json
Host: ondemand.websol.barchart.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

apikey=YOUR_API_KEY&symbols=IBM%2CAAPL%2CGOOG

Response

{
    "status": {
        "code": 200,
        "message": "Success."
    },
    "results": [
        {
            "symbol": "IBM",
            "announcementDate": "2024-10-30",
            "exDividendDate": "2024-11-12",
            "recordDate": "2024-11-12",
            "paymentDate": "2024-12-10",
            "dividend": 1.67,
            "dividendYield": 0.0303,
            "dividendYieldPct": 3.03,
            "frequency": 4,
            "indicatedAnnualDividend": 6.68,
            "dividendRateForward": 1.67
        },
        {
            "symbol": "AAPL",
            "announcementDate": "2024-10-31",
            "exDividendDate": "2024-11-08",
            "recordDate": "2024-11-11",
            "paymentDate": "2024-11-14",
            "dividend": 0.25,
            "dividendYield": 0.004,
            "dividendYieldPct": 0.4,
            "frequency": 4,
            "indicatedAnnualDividend": 1,
            "dividendRateForward": 0.25
        },
        {
            "symbol": "GOOG",
            "announcementDate": "2024-10-28",
            "exDividendDate": "2024-12-09",
            "recordDate": "2024-12-09",
            "paymentDate": "2024-12-16",
            "dividend": 0.2,
            "dividendYield": 0.0042,
            "dividendYieldPct": 0.42,
            "frequency": 4,
            "indicatedAnnualDividend": 0.8,
            "dividendRateForward": 0.2
        }
    ]
}

XML

GET

GET https://ondemand.websol.barchart.com/getDividendData.xml?apikey=YOUR_API_KEY&symbols=IBM%2CAAPL%2CGOOG
Host: ondemand.websol.barchart.com

POST

POST https://ondemand.websol.barchart.com/getDividendData.xml
Host: ondemand.websol.barchart.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

apikey=YOUR_API_KEY&symbols=IBM%2CAAPL%2CGOOG

Response

<?xml version="1.0" encoding="utf-8"?>
<getDividendData>
  <status>
    <code>200</code>
    <message>Success.</message>
  </status>
  <item>
    <symbol>IBM</symbol>
    <announcementDate>2024-10-30</announcementDate>
    <exDividendDate>2024-11-12</exDividendDate>
    <recordDate>2024-11-12</recordDate>
    <paymentDate>2024-12-10</paymentDate>
    <dividend>1.67</dividend>
    <dividendYield>0.0303</dividendYield>
    <dividendYieldPct>3.03</dividendYieldPct>
    <frequency>4</frequency>
    <indicatedAnnualDividend>6.68</indicatedAnnualDividend>
    <dividendRateForward>1.67</dividendRateForward>
  </item>
  <item>
    <symbol>AAPL</symbol>
    <announcementDate>2024-10-31</announcementDate>
    <exDividendDate>2024-11-08</exDividendDate>
    <recordDate>2024-11-11</recordDate>
    <paymentDate>2024-11-14</paymentDate>
    <dividend>0.25</dividend>
    <dividendYield>0.004</dividendYield>
    <dividendYieldPct>0.4</dividendYieldPct>
    <frequency>4</frequency>
    <indicatedAnnualDividend>1</indicatedAnnualDividend>
    <dividendRateForward>0.25</dividendRateForward>
  </item>
  <item>
    <symbol>GOOG</symbol>
    <announcementDate>2024-10-28</announcementDate>
    <exDividendDate>2024-12-09</exDividendDate>
    <recordDate>2024-12-09</recordDate>
    <paymentDate>2024-12-16</paymentDate>
    <dividend>0.2</dividend>
    <dividendYield>0.0042</dividendYield>
    <dividendYieldPct>0.42</dividendYieldPct>
    <frequency>4</frequency>
    <indicatedAnnualDividend>0.8</indicatedAnnualDividend>
    <dividendRateForward>0.2</dividendRateForward>
  </item>
</getDividendData>

CSV

GET

GET https://ondemand.websol.barchart.com/getDividendData.csv?apikey=YOUR_API_KEY&symbols=IBM%2CAAPL%2CGOOG
Host: ondemand.websol.barchart.com

POST

POST https://ondemand.websol.barchart.com/getDividendData.csv
Host: ondemand.websol.barchart.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

apikey=YOUR_API_KEY&symbols=IBM%2CAAPL%2CGOOG

Response

symbol,announcementDate,exDividendDate,recordDate,paymentDate,dividend,dividendYield,dividendYieldPct,frequency,indicatedAnnualDividend,dividendRateForward
"IBM","2024-10-30","2024-11-12","2024-11-12","2024-12-10","1.67","0.0303","3.03","4","6.68","1.67"
"AAPL","2024-10-31","2024-11-08","2024-11-11","2024-11-14","0.25","0.004","0.4","4","1","0.25"
"GOOG","2024-10-28","2024-12-09","2024-12-09","2024-12-16","0.2","0.0042","0.42","4","0.8","0.2"

PHP

<?php

$ondemand = new SoapClient('https://ondemand.websol.barchart.com/service?wsdl');

$params = [
    'apikey' => 'YOUR_API_KEY',
    'symbols' => 'IBM,AAPL,GOOG',
];

$result = $ondemand->getDividendData($params);
var_dump($result);

Classic ASP

Dim ondemand
Dim result

Set ondemand = Server.CreateObject("MSSOAP.SoapClient30")
ondemand.ClientProperty("ServerHTTPRequest") = True
ondemand.MSSoapInit("https://ondemand.websol.barchart.com/service?wsdl")

Set result = ondemand.getDividendData("YOUR_API_KEY", "IBM,AAPL,GOOG")

Perl

use SOAP::Lite;
use SOAP::WSDL;

my $ondemand = SOAP::Lite
    -> service('https://ondemand.websol.barchart.com/service?wsdl');

my $result = $ondemand->getDividendData('YOUR_API_KEY', 'IBM,AAPL,GOOG');

print $result;

Python

from suds.client import Client
ondemand = Client('https://ondemand.websol.barchart.com/service?wsdl')

result = ondemand.service.getDividendData('YOUR_API_KEY', 'IBM,AAPL,GOOG')

print(result)

Ruby

require 'savon'

ondemand = Savon.client(wsdl: 'https://ondemand.websol.barchart.com/service?wsdl')

response = ondemand.call(
    :getDividendData,
    message: {
        apikey: 'YOUR_API_KEY',
        symbols: 'IBM,AAPL,GOOG',
    }
)

response.body