getCorporateActionsByExchange API
getCorporateActionsByExchange
The getCorporateActions API from Barchart OnDemand provides splits or dividends data for US equities, mutual funds and Canadian equities by exchange.
View All APIsContact Us to Get Access
Inputs
typerequired
Type of action for which data is being requested.
Type
enum (A type which includes a list of valid possible values.)
Example
dividend
Valid Values
dividend, split
exchangesrequired
A valid exchange code.
Type
list-enum (A comma or semi-colon delimited string that must match a list of valid possible values.)
Example
NYSE
Valid Values
NYSE, NASDAQ, AMEX, OTC-BB, LSE, TSX, TSX-V, ASX, CNSX, FUND, CADFUNDS
intervaloptional
Set period in days for which the event data should be returned.
Type
enum (A type which includes a list of valid possible values.)
Example
7
Default
7
Valid Values
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30
eventDatesoptional
A comma separated list of dates for which event data should be returned. Dates need to be in [YYYYMMDD] format.
Type
list (A comma or semi-colon delimited string.)
Example
20241121,20241031
Outputs
symbol
always returned
always returned
A symbol or code that identifies a financial instrument.
string
A sequence of characters. (example: GOOG)
A sequence of characters. (example: GOOG)
exchange
always returned
always returned
Exchange code for the marketplace where the financial instruments are listed.
string
A sequence of characters. (example: GOOG)
A sequence of characters. (example: GOOG)
eventDate
always returned
always returned
The date in which the event occurred.
date
A date in the format of YYYY-MM-DD.
A date in the format of YYYY-MM-DD.
eventType
always returned
always returned
The type of event.
string
A sequence of characters. (example: GOOG)
A sequence of characters. (example: GOOG)
value
always returned
always returned
The split ratio, dividend amount or earnings amount.
double
A numeric type defining a number with fractional parts. (example: 2.14)
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/getCorporateActionsByExchange.json?apikey=YOUR_API_KEY&type=dividend&exchanges=NYSE&interval=7&eventDates=20241121%2C20241031
Host: ondemand.websol.barchart.com
POST
POST https://ondemand.websol.barchart.com/getCorporateActionsByExchange.json
Host: ondemand.websol.barchart.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
apikey=YOUR_API_KEY&type=dividend&exchanges=NYSE&interval=7&eventDates=20241121%2C20241031
Response
{
"status": {
"code": 200,
"message": "Success."
},
"results": [
{
"symbol": "ACP",
"exchange": "NYSE",
"eventDate": "2024-11-21",
"eventType": "dividend",
"value": 0.1
},
{
"symbol": "ADM",
"exchange": "NYSE",
"eventDate": "2024-11-21",
"eventType": "dividend",
"value": 0.5
},
{
"symbol": "AGD",
"exchange": "NYSE",
"eventDate": "2024-11-21",
"eventType": "dividend",
"value": 0.12
},
{
"symbol": "AMCR",
"exchange": "NYSE",
"eventDate": "2024-11-21",
"eventType": "dividend",
"value": 0.127
},
{
"symbol": "AOD",
"exchange": "NYSE",
"eventDate": "2024-11-21",
"eventType": "dividend",
"value": 0.1
},
{
"symbol": "ARDC",
"exchange": "NYSE",
"eventDate": "2024-11-21",
"eventType": "dividend",
"value": 0.117
},
{
"symbol": "ASGI",
"exchange": "NYSE",
"eventDate": "2024-11-21",
"eventType": "dividend",
"value": 0.21
},
{
"symbol": "AWP",
"exchange": "NYSE",
"eventDate": "2024-11-21",
"eventType": "dividend",
"value": 0.04
},
{
"symbol": "BGB",
"exchange": "NYSE",
"eventDate": "2024-11-21",
"eventType": "dividend",
"value": 0.093
},
{
"symbol": "BGX",
"exchange": "NYSE",
"eventDate": "2024-11-21",
"eventType": "dividend",
"value": 0.101
},
{
"symbol": "BSL",
"exchange": "NYSE",
"eventDate": "2024-11-21",
"eventType": "dividend",
"value": 0.114
},
{
"symbol": "BWG",
"exchange": "NYSE",
"eventDate": "2024-11-21",
"eventType": "dividend",
"value": 0.08
},
{
"symbol": "CNP",
"exchange": "NYSE",
"eventDate": "2024-11-21",
"eventType": "dividend",
"value": 0.21
},
{
"symbol": "CPAC",
"exchange": "NYSE",
"eventDate": "2024-11-21",
"eventType": "dividend",
"value": 0.495
},
{
"symbol": "DFP",
"exchange": "NYSE",
"eventDate": "2024-11-21",
"eventType": "dividend",
"value": 0.115
},
{
"symbol": "DFS",
"exchange": "NYSE",
"eventDate": "2024-11-21",
"eventType": "dividend",
"value": 0.7
},
{
"symbol": "DINO",
"exchange": "NYSE",
"eventDate": "2024-11-21",
"eventType": "dividend",
"value": 0.5
},
{
"symbol": "DMO",
"exchange": "NYSE",
"eventDate": "2024-11-21",
"eventType": "dividend",
"value": 0.13
},
{
"symbol": "EFR",
"exchange": "NYSE",
"eventDate": "2024-11-21",
"eventType": "dividend",
"value": 0.1
},
{
"symbol": "EFT",
"exchange": "NYSE",
"eventDate": "2024-11-21",
"eventType": "dividend",
"value": 0.103
}
]
}
XML
GET
GET https://ondemand.websol.barchart.com/getCorporateActionsByExchange.xml?apikey=YOUR_API_KEY&type=dividend&exchanges=NYSE&interval=7&eventDates=20241121%2C20241031
Host: ondemand.websol.barchart.com
POST
POST https://ondemand.websol.barchart.com/getCorporateActionsByExchange.xml
Host: ondemand.websol.barchart.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
apikey=YOUR_API_KEY&type=dividend&exchanges=NYSE&interval=7&eventDates=20241121%2C20241031
Response
<?xml version="1.0" encoding="utf-8"?>
<getCorporateActionsByExchange>
<status>
<code>200</code>
<message>Success.</message>
</status>
<item>
<symbol>ACP</symbol>
<exchange>NYSE</exchange>
<eventDate>2024-11-21</eventDate>
<eventType>dividend</eventType>
<value>0.1</value>
</item>
<item>
<symbol>ADM</symbol>
<exchange>NYSE</exchange>
<eventDate>2024-11-21</eventDate>
<eventType>dividend</eventType>
<value>0.5</value>
</item>
<item>
<symbol>AGD</symbol>
<exchange>NYSE</exchange>
<eventDate>2024-11-21</eventDate>
<eventType>dividend</eventType>
<value>0.12</value>
</item>
<item>
<symbol>AMCR</symbol>
<exchange>NYSE</exchange>
<eventDate>2024-11-21</eventDate>
<eventType>dividend</eventType>
<value>0.127</value>
</item>
<item>
<symbol>AOD</symbol>
<exchange>NYSE</exchange>
<eventDate>2024-11-21</eventDate>
<eventType>dividend</eventType>
<value>0.1</value>
</item>
<item>
<symbol>ARDC</symbol>
<exchange>NYSE</exchange>
<eventDate>2024-11-21</eventDate>
<eventType>dividend</eventType>
<value>0.117</value>
</item>
<item>
<symbol>ASGI</symbol>
<exchange>NYSE</exchange>
<eventDate>2024-11-21</eventDate>
<eventType>dividend</eventType>
<value>0.21</value>
</item>
<item>
<symbol>AWP</symbol>
<exchange>NYSE</exchange>
<eventDate>2024-11-21</eventDate>
<eventType>dividend</eventType>
<value>0.04</value>
</item>
<item>
<symbol>BGB</symbol>
<exchange>NYSE</exchange>
<eventDate>2024-11-21</eventDate>
<eventType>dividend</eventType>
<value>0.093</value>
</item>
<item>
<symbol>BGX</symbol>
<exchange>NYSE</exchange>
<eventDate>2024-11-21</eventDate>
<eventType>dividend</eventType>
<value>0.101</value>
</item>
<item>
<symbol>BSL</symbol>
<exchange>NYSE</exchange>
<eventDate>2024-11-21</eventDate>
<eventType>dividend</eventType>
<value>0.114</value>
</item>
<item>
<symbol>BWG</symbol>
<exchange>NYSE</exchange>
<eventDate>2024-11-21</eventDate>
<eventType>dividend</eventType>
<value>0.08</value>
</item>
<item>
<symbol>CNP</symbol>
<exchange>NYSE</exchange>
<eventDate>2024-11-21</eventDate>
<eventType>dividend</eventType>
<value>0.21</value>
</item>
<item>
<symbol>CPAC</symbol>
<exchange>NYSE</exchange>
<eventDate>2024-11-21</eventDate>
<eventType>dividend</eventType>
<value>0.495</value>
</item>
<item>
<symbol>DFP</symbol>
<exchange>NYSE</exchange>
<eventDate>2024-11-21</eventDate>
<eventType>dividend</eventType>
<value>0.115</value>
</item>
<item>
<symbol>DFS</symbol>
<exchange>NYSE</exchange>
<eventDate>2024-11-21</eventDate>
<eventType>dividend</eventType>
<value>0.7</value>
</item>
<item>
<symbol>DINO</symbol>
<exchange>NYSE</exchange>
<eventDate>2024-11-21</eventDate>
<eventType>dividend</eventType>
<value>0.5</value>
</item>
<item>
<symbol>DMO</symbol>
<exchange>NYSE</exchange>
<eventDate>2024-11-21</eventDate>
<eventType>dividend</eventType>
<value>0.13</value>
</item>
<item>
<symbol>EFR</symbol>
<exchange>NYSE</exchange>
<eventDate>2024-11-21</eventDate>
<eventType>dividend</eventType>
<value>0.1</value>
</item>
<item>
<symbol>EFT</symbol>
<exchange>NYSE</exchange>
<eventDate>2024-11-21</eventDate>
<eventType>dividend</eventType>
<value>0.103</value>
</item>
</getCorporateActionsByExchange>
CSV
GET
GET https://ondemand.websol.barchart.com/getCorporateActionsByExchange.csv?apikey=YOUR_API_KEY&type=dividend&exchanges=NYSE&interval=7&eventDates=20241121%2C20241031
Host: ondemand.websol.barchart.com
POST
POST https://ondemand.websol.barchart.com/getCorporateActionsByExchange.csv
Host: ondemand.websol.barchart.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
apikey=YOUR_API_KEY&type=dividend&exchanges=NYSE&interval=7&eventDates=20241121%2C20241031
Response
symbol,exchange,eventDate,eventType,value
"ACP","NYSE","2024-11-21","dividend","0.1"
"ADM","NYSE","2024-11-21","dividend","0.5"
"AGD","NYSE","2024-11-21","dividend","0.12"
"AMCR","NYSE","2024-11-21","dividend","0.127"
"AOD","NYSE","2024-11-21","dividend","0.1"
"ARDC","NYSE","2024-11-21","dividend","0.117"
"ASGI","NYSE","2024-11-21","dividend","0.21"
"AWP","NYSE","2024-11-21","dividend","0.04"
"BGB","NYSE","2024-11-21","dividend","0.093"
"BGX","NYSE","2024-11-21","dividend","0.101"
"BSL","NYSE","2024-11-21","dividend","0.114"
"BWG","NYSE","2024-11-21","dividend","0.08"
"CNP","NYSE","2024-11-21","dividend","0.21"
"CPAC","NYSE","2024-11-21","dividend","0.495"
"DFP","NYSE","2024-11-21","dividend","0.115"
"DFS","NYSE","2024-11-21","dividend","0.7"
"DINO","NYSE","2024-11-21","dividend","0.5"
"DMO","NYSE","2024-11-21","dividend","0.13"
"EFR","NYSE","2024-11-21","dividend","0.1"
"EFT","NYSE","2024-11-21","dividend","0.103"
PHP
<?php
$ondemand = new SoapClient('https://ondemand.websol.barchart.com/service?wsdl');
$params = [
'apikey' => 'YOUR_API_KEY',
'type' => 'dividend',
'exchanges' => 'NYSE',
'interval' => '7',
'eventDates' => '20241121,20241031',
];
$result = $ondemand->getCorporateActionsByExchange($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.getCorporateActionsByExchange("YOUR_API_KEY", "dividend", "NYSE", "7", "20241121,20241031")
Perl
use SOAP::Lite;
use SOAP::WSDL;
my $ondemand = SOAP::Lite
-> service('https://ondemand.websol.barchart.com/service?wsdl');
my $result = $ondemand->getCorporateActionsByExchange('YOUR_API_KEY', 'dividend', 'NYSE', '7', '20241121,20241031');
print $result;
Python
from suds.client import Client
ondemand = Client('https://ondemand.websol.barchart.com/service?wsdl')
result = ondemand.service.getCorporateActionsByExchange('YOUR_API_KEY', 'dividend', 'NYSE', '7', '20241121,20241031')
print(result)
Ruby
require 'savon'
ondemand = Savon.client(wsdl: 'https://ondemand.websol.barchart.com/service?wsdl')
response = ondemand.call(
:getCorporateActionsByExchange,
message: {
apikey: 'YOUR_API_KEY',
type: 'dividend',
exchanges: 'NYSE',
interval: '7',
eventDates: '20241121,20241031',
}
)
response.body