Dividend Stocks API
getDividendStocks
The getDividendStocks API returns dividend info for all US instruments.
View All APIsContact Us to Get Access
Inputs
countryoptional
The country code for which the instruments list is to be queried and returned.
Type
string (A sequence of characters. (example: GOOG))
Example
US
Default
US
fieldsoptional
Request additional optional fields to be included in the output.
Type
list (A comma or semi-colon delimited string.)
Example
annualDividend
Outputs
symbol
always returned
always returned
The instrument symbol.
string
A sequence of characters. (example: GOOG)
A sequence of characters. (example: GOOG)
symbolName
always returned
always returned
The instrument name.
string
A sequence of characters. (example: GOOG)
A sequence of characters. (example: GOOG)
exchange
always returned
always returned
The exchange code were the instrument trades.
string
A sequence of characters. (example: GOOG)
A sequence of characters. (example: GOOG)
instrumentType
always returned
always returned
The classification of the instrument.
string
A sequence of characters. (example: GOOG)
A sequence of characters. (example: GOOG)
hasDividends
always returned
always returned
Boolean field indicating whether the instrument has dividends or not.
boolean
A logical type representing the truth of a value as 'true' or 'false'.
A logical type representing the truth of a value as 'true' or 'false'.
annualDividend
as requested
as requested
The annual dividend for the instrument.
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)
annualDividendYield
as requested
as requested
The annual dividend yield for the instrument.
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/getDividendStocks.json?apikey=YOUR_API_KEY&country=US&fields=annualDividend
Host: ondemand.websol.barchart.com
POST
POST https://ondemand.websol.barchart.com/getDividendStocks.json
Host: ondemand.websol.barchart.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
apikey=YOUR_API_KEY&country=US&fields=annualDividend
Response
{
"status": {
"code": 200,
"message": "Success."
},
"results": [
{
"symbol": "ACU",
"symbolName": "Acme United Corp",
"exchange": "AMEX",
"instrumentType": "stock",
"hasDividends": true,
"annualDividend": 0.6
},
{
"symbol": "ACWV",
"symbolName": "Ishares Global Min Vol Factor ETF",
"exchange": "AMEX",
"instrumentType": "etf",
"hasDividends": true,
"annualDividend": 2.47
},
{
"symbol": "AE",
"symbolName": "Adams Resources & Energy",
"exchange": "AMEX",
"instrumentType": "stock",
"hasDividends": true,
"annualDividend": 0.96
},
{
"symbol": "AFK",
"symbolName": "Vaneck Africa Index ETF",
"exchange": "AMEX",
"instrumentType": "etf",
"hasDividends": true,
"annualDividend": 0.31
},
{
"symbol": "AGG",
"symbolName": "US Aggregate Bond Ishares Core ETF",
"exchange": "AMEX",
"instrumentType": "etf",
"hasDividends": true,
"annualDividend": 3.56
},
{
"symbol": "AGZ",
"symbolName": "Agency Bond Ishares ETF",
"exchange": "AMEX",
"instrumentType": "etf",
"hasDividends": true,
"annualDividend": 3.72
},
{
"symbol": "AIRI",
"symbolName": "Air Industries Group Inc",
"exchange": "AMEX",
"instrumentType": "stock",
"hasDividends": true,
"annualDividend": null
},
{
"symbol": "AIVI",
"symbolName": "Wisdomtree International Dividend Top 100 Fund",
"exchange": "AMEX",
"instrumentType": "etf",
"hasDividends": true,
"annualDividend": 1.98
},
{
"symbol": "AMLP",
"symbolName": "Alps Alerian MLP ETF",
"exchange": "AMEX",
"instrumentType": "etf",
"hasDividends": true,
"annualDividend": 3.71
},
{
"symbol": "AMS",
"symbolName": "American Shared Hospital Services",
"exchange": "AMEX",
"instrumentType": "stock",
"hasDividends": true,
"annualDividend": null
},
{
"symbol": "AOA",
"symbolName": "Aggressive Allocation Ishares Core ETF",
"exchange": "AMEX",
"instrumentType": "etf",
"hasDividends": true,
"annualDividend": 1.65
},
{
"symbol": "AOK",
"symbolName": "Conservative Allocation Ishares Core ETF",
"exchange": "AMEX",
"instrumentType": "etf",
"hasDividends": true,
"annualDividend": 1.18
},
{
"symbol": "AOM",
"symbolName": "Moderate Allocation Ishares Core ETF",
"exchange": "AMEX",
"instrumentType": "etf",
"hasDividends": true,
"annualDividend": 1.27
},
{
"symbol": "AOR",
"symbolName": "Growth Allocation Ishares Core ETF",
"exchange": "AMEX",
"instrumentType": "etf",
"hasDividends": true,
"annualDividend": 1.44
},
{
"symbol": "APT",
"symbolName": "Alpha Pro Tech",
"exchange": "AMEX",
"instrumentType": "stock",
"hasDividends": true,
"annualDividend": null
},
{
"symbol": "ARGT",
"symbolName": "GX MSCI Argentina ETF",
"exchange": "AMEX",
"instrumentType": "etf",
"hasDividends": true,
"annualDividend": 0.74
},
{
"symbol": "ARP",
"symbolName": "Inner Circle II Pmv Adaptive Risk Parity ETF",
"exchange": "AMEX",
"instrumentType": "etf",
"hasDividends": true,
"annualDividend": 0.67
},
{
"symbol": "ASEA",
"symbolName": "GX FTSE Southeast Asia ETF",
"exchange": "AMEX",
"instrumentType": "etf",
"hasDividends": true,
"annualDividend": 0.62
},
{
"symbol": "ASM",
"symbolName": "Avino Silver & Gold",
"exchange": "AMEX",
"instrumentType": "stock",
"hasDividends": true,
"annualDividend": null
},
{
"symbol": "ATCH",
"symbolName": "Atlasclear Holdings Inc",
"exchange": "AMEX",
"instrumentType": "stock",
"hasDividends": true,
"annualDividend": null
}
]
}
XML
GET
GET https://ondemand.websol.barchart.com/getDividendStocks.xml?apikey=YOUR_API_KEY&country=US&fields=annualDividend
Host: ondemand.websol.barchart.com
POST
POST https://ondemand.websol.barchart.com/getDividendStocks.xml
Host: ondemand.websol.barchart.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
apikey=YOUR_API_KEY&country=US&fields=annualDividend
Response
<?xml version="1.0" encoding="utf-8"?>
<getDividendStocks>
<status>
<code>200</code>
<message>Success.</message>
</status>
<item>
<symbol>ACU</symbol>
<symbolName>Acme United Corp</symbolName>
<exchange>AMEX</exchange>
<instrumentType>stock</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend>0.6</annualDividend>
</item>
<item>
<symbol>ACWV</symbol>
<symbolName>Ishares Global Min Vol Factor ETF</symbolName>
<exchange>AMEX</exchange>
<instrumentType>etf</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend>2.47</annualDividend>
</item>
<item>
<symbol>AE</symbol>
<symbolName>Adams Resources & Energy</symbolName>
<exchange>AMEX</exchange>
<instrumentType>stock</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend>0.96</annualDividend>
</item>
<item>
<symbol>AFK</symbol>
<symbolName>Vaneck Africa Index ETF</symbolName>
<exchange>AMEX</exchange>
<instrumentType>etf</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend>0.31</annualDividend>
</item>
<item>
<symbol>AGG</symbol>
<symbolName>US Aggregate Bond Ishares Core ETF</symbolName>
<exchange>AMEX</exchange>
<instrumentType>etf</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend>3.56</annualDividend>
</item>
<item>
<symbol>AGZ</symbol>
<symbolName>Agency Bond Ishares ETF</symbolName>
<exchange>AMEX</exchange>
<instrumentType>etf</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend>3.72</annualDividend>
</item>
<item>
<symbol>AIRI</symbol>
<symbolName>Air Industries Group Inc</symbolName>
<exchange>AMEX</exchange>
<instrumentType>stock</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend/>
</item>
<item>
<symbol>AIVI</symbol>
<symbolName>Wisdomtree International Dividend Top 100 Fund</symbolName>
<exchange>AMEX</exchange>
<instrumentType>etf</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend>1.98</annualDividend>
</item>
<item>
<symbol>AMLP</symbol>
<symbolName>Alps Alerian MLP ETF</symbolName>
<exchange>AMEX</exchange>
<instrumentType>etf</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend>3.71</annualDividend>
</item>
<item>
<symbol>AMS</symbol>
<symbolName>American Shared Hospital Services</symbolName>
<exchange>AMEX</exchange>
<instrumentType>stock</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend/>
</item>
<item>
<symbol>AOA</symbol>
<symbolName>Aggressive Allocation Ishares Core ETF</symbolName>
<exchange>AMEX</exchange>
<instrumentType>etf</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend>1.65</annualDividend>
</item>
<item>
<symbol>AOK</symbol>
<symbolName>Conservative Allocation Ishares Core ETF</symbolName>
<exchange>AMEX</exchange>
<instrumentType>etf</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend>1.18</annualDividend>
</item>
<item>
<symbol>AOM</symbol>
<symbolName>Moderate Allocation Ishares Core ETF</symbolName>
<exchange>AMEX</exchange>
<instrumentType>etf</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend>1.27</annualDividend>
</item>
<item>
<symbol>AOR</symbol>
<symbolName>Growth Allocation Ishares Core ETF</symbolName>
<exchange>AMEX</exchange>
<instrumentType>etf</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend>1.44</annualDividend>
</item>
<item>
<symbol>APT</symbol>
<symbolName>Alpha Pro Tech</symbolName>
<exchange>AMEX</exchange>
<instrumentType>stock</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend/>
</item>
<item>
<symbol>ARGT</symbol>
<symbolName>GX MSCI Argentina ETF</symbolName>
<exchange>AMEX</exchange>
<instrumentType>etf</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend>0.74</annualDividend>
</item>
<item>
<symbol>ARP</symbol>
<symbolName>Inner Circle II Pmv Adaptive Risk Parity ETF</symbolName>
<exchange>AMEX</exchange>
<instrumentType>etf</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend>0.67</annualDividend>
</item>
<item>
<symbol>ASEA</symbol>
<symbolName>GX FTSE Southeast Asia ETF</symbolName>
<exchange>AMEX</exchange>
<instrumentType>etf</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend>0.62</annualDividend>
</item>
<item>
<symbol>ASM</symbol>
<symbolName>Avino Silver & Gold</symbolName>
<exchange>AMEX</exchange>
<instrumentType>stock</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend/>
</item>
<item>
<symbol>ATCH</symbol>
<symbolName>Atlasclear Holdings Inc</symbolName>
<exchange>AMEX</exchange>
<instrumentType>stock</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend/>
</item>
</getDividendStocks>
CSV
GET
GET https://ondemand.websol.barchart.com/getDividendStocks.csv?apikey=YOUR_API_KEY&country=US&fields=annualDividend
Host: ondemand.websol.barchart.com
POST
POST https://ondemand.websol.barchart.com/getDividendStocks.csv
Host: ondemand.websol.barchart.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
apikey=YOUR_API_KEY&country=US&fields=annualDividend
Response
symbol,symbolName,exchange,instrumentType,hasDividends,annualDividend
"ACU","Acme United Corp","AMEX","stock","1","0.6"
"ACWV","Ishares Global Min Vol Factor ETF","AMEX","etf","1","2.47"
"AE","Adams Resources & Energy","AMEX","stock","1","0.96"
"AFK","Vaneck Africa Index ETF","AMEX","etf","1","0.31"
"AGG","US Aggregate Bond Ishares Core ETF","AMEX","etf","1","3.56"
"AGZ","Agency Bond Ishares ETF","AMEX","etf","1","3.72"
"AIRI","Air Industries Group Inc","AMEX","stock","1",""
"AIVI","Wisdomtree International Dividend Top 100 Fund","AMEX","etf","1","1.98"
"AMLP","Alps Alerian MLP ETF","AMEX","etf","1","3.71"
"AMS","American Shared Hospital Services","AMEX","stock","1",""
"AOA","Aggressive Allocation Ishares Core ETF","AMEX","etf","1","1.65"
"AOK","Conservative Allocation Ishares Core ETF","AMEX","etf","1","1.18"
"AOM","Moderate Allocation Ishares Core ETF","AMEX","etf","1","1.27"
"AOR","Growth Allocation Ishares Core ETF","AMEX","etf","1","1.44"
"APT","Alpha Pro Tech","AMEX","stock","1",""
"ARGT","GX MSCI Argentina ETF","AMEX","etf","1","0.74"
"ARP","Inner Circle II Pmv Adaptive Risk Parity ETF","AMEX","etf","1","0.67"
"ASEA","GX FTSE Southeast Asia ETF","AMEX","etf","1","0.62"
"ASM","Avino Silver & Gold","AMEX","stock","1",""
"ATCH","Atlasclear Holdings Inc","AMEX","stock","1",""
PHP
<?php
$ondemand = new SoapClient('https://ondemand.websol.barchart.com/service?wsdl');
$params = [
'apikey' => 'YOUR_API_KEY',
'country' => 'US',
'fields' => 'annualDividend',
];
$result = $ondemand->getDividendStocks($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.getDividendStocks("YOUR_API_KEY", "US", "annualDividend")
Perl
use SOAP::Lite;
use SOAP::WSDL;
my $ondemand = SOAP::Lite
-> service('https://ondemand.websol.barchart.com/service?wsdl');
my $result = $ondemand->getDividendStocks('YOUR_API_KEY', 'US', 'annualDividend');
print $result;
Python
from suds.client import Client
ondemand = Client('https://ondemand.websol.barchart.com/service?wsdl')
result = ondemand.service.getDividendStocks('YOUR_API_KEY', 'US', 'annualDividend')
print(result)
Ruby
require 'savon'
ondemand = Savon.client(wsdl: 'https://ondemand.websol.barchart.com/service?wsdl')
response = ondemand.call(
:getDividendStocks,
message: {
apikey: 'YOUR_API_KEY',
country: 'US',
fields: 'annualDividend',
}
)
response.body