getDividendData API

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

All APIs

Contact Us to Get Access

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

Name / Requirement
Description
Type
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)
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)

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": "2017-10-31",
            "exDividendDate": "2017-11-09",
            "recordDate": "2017-11-10",
            "paymentDate": "2017-12-09",
            "dividend": 1.5,
            "dividendYield": 0.0408,
            "frequency": 4,
            "indicatedAnnualDividend": 6
        },
        {
            "symbol": "AAPL",
            "announcementDate": "2017-11-02",
            "exDividendDate": "2017-11-10",
            "recordDate": "2017-11-13",
            "paymentDate": "2017-11-16",
            "dividend": 0.63,
            "dividendYield": 0.0149,
            "frequency": 4,
            "indicatedAnnualDividend": 2.52
        },
        {
            "symbol": "GOOG",
            "announcementDate": null,
            "exDividendDate": null,
            "recordDate": null,
            "paymentDate": null,
            "dividend": null,
            "dividendYield": 0,
            "frequency": null,
            "indicatedAnnualDividend": null
        }
    ]
}

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>2017-10-31</announcementDate>
   <exDividendDate>2017-11-09</exDividendDate>
   <recordDate>2017-11-10</recordDate>
   <paymentDate>2017-12-09</paymentDate>
   <dividend>1.5</dividend>
   <dividendYield>0.0408</dividendYield>
   <frequency>4</frequency>
   <indicatedAnnualDividend>6</indicatedAnnualDividend>
  </item>
  <item>
   <symbol>AAPL</symbol>
   <announcementDate>2017-11-02</announcementDate>
   <exDividendDate>2017-11-10</exDividendDate>
   <recordDate>2017-11-13</recordDate>
   <paymentDate>2017-11-16</paymentDate>
   <dividend>0.63</dividend>
   <dividendYield>0.0149</dividendYield>
   <frequency>4</frequency>
   <indicatedAnnualDividend>2.52</indicatedAnnualDividend>
  </item>
  <item>
   <symbol>GOOG</symbol>
   <announcementDate></announcementDate>
   <exDividendDate></exDividendDate>
   <recordDate></recordDate>
   <paymentDate></paymentDate>
   <dividend></dividend>
   <dividendYield>0</dividendYield>
   <frequency></frequency>
   <indicatedAnnualDividend></indicatedAnnualDividend>
  </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,frequency,indicatedAnnualDividend
"IBM","2017-10-31","2017-11-09","2017-11-10","2017-12-09","1.5","0.0408","4","6"
"AAPL","2017-11-02","2017-11-10","2017-11-13","2017-11-16","0.63","0.0149","4","2.52"
"GOOG","","","","","","0","",""


PHP

<?php

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

$params = [
    '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("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('IBM,AAPL,GOOG');

print $result;

Python

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

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

print result

Ruby

require 'savon'

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

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

response.body