getDividendsCalendar API

getDividendsCalendar

The getDividendsCalendar API provides the total number of upcoming dividends by date. And will also return the dividends data for the requested date. Please note that the output of this API will change based on the type of data requested. When requesting 'totals' (default type), it will return the date and total dividends for that date. And when requesting 'dividends' it will return dividend data for all symbols for the requested start date.

View All APIs

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

exchange^required

The exchange(s) for which the data is requested. US-ALL and CA-ALL will query for all permitted US and Canadian exchanges for your account.

Type

enum (A type which includes a list of valid possible values.)

Default

US-ALL

Valid Values

US-ALL, CA-ALL, AMEX, NASDAQ, NYSE, OTHER OTC, TSX, TSX-V, CNSX

type^required

A boolean parameter that when set to true, will return all dividends data for the requested start date. If no start date is passed, it will return the data for the current date.

Type

enum (A type which includes a list of valid possible values.)

Default

totals

Valid Values

totals, dividends

startDate^optional

The start date for dividends total and the date for which the dividends information will be returned.

Type

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

Default

2024-10-19

endDate^optional

The end date for dividends total. This input parameter is ignored when requesting the actual dividends information.

Type

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

Default

2024-10-29

Outputs

date
always returned

The date for the data is returned.

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

totalDividends
always returned

The total number of dividends data for the day.

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

symbol
as requested

A symbol or code that identifies a financial instrument.

string
A sequence of characters. (example: GOOG)

name
as requested

The name of the entity that the symbol or code represents.

string
A sequence of characters. (example: GOOG)

exchange
as requested

N/A

string
A sequence of characters. (example: GOOG)

amount
as requested

The dollar amount of the dividend.

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

yield
as requested

Indicates how much a company pays out in dividends each year relative to its share price. Dividend yield% can be calculated by dividing the dollar value of dividends paid in a given year per share of stock held by the dollar value of one share of stock.

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

exDivDate
as requested

Normally two business days before the recorded payable date. If you purchase a stock on or after its ex-dividend date, you will not receive the next dividend payment.

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

payableDate
as requested

The date on which the dividend is payable.

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

Status Code Responses

200

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/getDividendsCalendar.json?apikey=YOUR_API_KEY
Host: ondemand.websol.barchart.com

POST

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

apikey=YOUR_API_KEY

Response

{
    "status": {
        "code": 200,
        "message": "Success."
    },
    "results": [
        {
            "date": "2024-10-21",
            "totalDividends": 12
        },
        {
            "date": "2024-10-22",
            "totalDividends": 10
        },
        {
            "date": "2024-10-23",
            "totalDividends": 7
        },
        {
            "date": "2024-10-24",
            "totalDividends": 4
        },
        {
            "date": "2024-10-25",
            "totalDividends": 19
        },
        {
            "date": "2024-10-28",
            "totalDividends": 12
        },
        {
            "date": "2024-10-29",
            "totalDividends": 5
        }
    ]
}

XML

GET

GET https://ondemand.websol.barchart.com/getDividendsCalendar.xml?apikey=YOUR_API_KEY
Host: ondemand.websol.barchart.com

POST

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

apikey=YOUR_API_KEY

Response

<?xml version="1.0" encoding="utf-8"?>
<getDividendsCalendar>
  <status>
    <code>200</code>
    <message>Success.</message>
  </status>
  <item>
    <date>2024-10-21</date>
    <totalDividends>12</totalDividends>
  </item>
  <item>
    <date>2024-10-22</date>
    <totalDividends>10</totalDividends>
  </item>
  <item>
    <date>2024-10-23</date>
    <totalDividends>7</totalDividends>
  </item>
  <item>
    <date>2024-10-24</date>
    <totalDividends>4</totalDividends>
  </item>
  <item>
    <date>2024-10-25</date>
    <totalDividends>19</totalDividends>
  </item>
  <item>
    <date>2024-10-28</date>
    <totalDividends>12</totalDividends>
  </item>
  <item>
    <date>2024-10-29</date>
    <totalDividends>5</totalDividends>
  </item>
</getDividendsCalendar>

CSV

GET

GET https://ondemand.websol.barchart.com/getDividendsCalendar.csv?apikey=YOUR_API_KEY
Host: ondemand.websol.barchart.com

POST

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

apikey=YOUR_API_KEY

Response

date,totalDividends
"2024-10-21","12"
"2024-10-22","10"
"2024-10-23","7"
"2024-10-24","4"
"2024-10-25","19"
"2024-10-28","12"
"2024-10-29","5"

PHP

<?php

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

$params = [
    'apikey' => 'YOUR_API_KEY',
];

$result = $ondemand->getDividendsCalendar($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.getDividendsCalendar("YOUR_API_KEY")

Perl

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

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

my $result = $ondemand->getDividendsCalendar('YOUR_API_KEY');

print $result;

Python

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

result = ondemand.service.getDividendsCalendar('YOUR_API_KEY')

print(result)

Ruby

require 'savon'

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

response = ondemand.call(
    :getDividendsCalendar,
    message: {
        apikey: 'YOUR_API_KEY',
    }
)

response.body