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": "AE",
"symbolName": "Adams Resources & Energy",
"exchange": "AMEX",
"instrumentType": "stock",
"hasDividends": true,
"annualDividend": 0.96
},
{
"symbol": "AEON",
"symbolName": "Aeon Biopharma Inc",
"exchange": "AMEX",
"instrumentType": "stock",
"hasDividends": true,
"annualDividend": null
},
{
"symbol": "AIM",
"symbolName": "Aim Immunotech Inc",
"exchange": "AMEX",
"instrumentType": "stock",
"hasDividends": true,
"annualDividend": null
},
{
"symbol": "AIRI",
"symbolName": "Air Industries Group Inc",
"exchange": "AMEX",
"instrumentType": "stock",
"hasDividends": true,
"annualDividend": null
},
{
"symbol": "AMBI",
"symbolName": "Ambipar Emergency Response Cl A",
"exchange": "AMEX",
"instrumentType": "stock",
"hasDividends": true,
"annualDividend": null
},
{
"symbol": "AMBO",
"symbolName": "Ambow Education Holding Ltd ADR",
"exchange": "AMEX",
"instrumentType": "stock",
"hasDividends": true,
"annualDividend": null
},
{
"symbol": "AMS",
"symbolName": "American Shared Hospital Services",
"exchange": "AMEX",
"instrumentType": "stock",
"hasDividends": true,
"annualDividend": null
},
{
"symbol": "APT",
"symbolName": "Alpha Pro Tech",
"exchange": "AMEX",
"instrumentType": "stock",
"hasDividends": true,
"annualDividend": null
},
{
"symbol": "AREN",
"symbolName": "The Arena Group Holdings Inc",
"exchange": "AMEX",
"instrumentType": "stock",
"hasDividends": true,
"annualDividend": null
},
{
"symbol": "ARMN",
"symbolName": "Aris Mining Corp",
"exchange": "AMEX",
"instrumentType": "stock",
"hasDividends": true,
"annualDividend": null
},
{
"symbol": "ARMP",
"symbolName": "Armata Pharmaceuticals Inc",
"exchange": "AMEX",
"instrumentType": "stock",
"hasDividends": true,
"annualDividend": null
},
{
"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
},
{
"symbol": "ATNM",
"symbolName": "Actinium Pharmaceuticals Inc",
"exchange": "AMEX",
"instrumentType": "stock",
"hasDividends": true,
"annualDividend": null
},
{
"symbol": "AUMN",
"symbolName": "Golden Minerals Company",
"exchange": "AMEX",
"instrumentType": "stock",
"hasDividends": true,
"annualDividend": null
},
{
"symbol": "AUST",
"symbolName": "Austin Gold Corp",
"exchange": "AMEX",
"instrumentType": "stock",
"hasDividends": true,
"annualDividend": null
},
{
"symbol": "AWX",
"symbolName": "Avalon Holdings Corp",
"exchange": "AMEX",
"instrumentType": "stock",
"hasDividends": true,
"annualDividend": null
},
{
"symbol": "AXIL",
"symbolName": "Axil Brands Inc",
"exchange": "AMEX",
"instrumentType": "stock",
"hasDividends": true,
"annualDividend": null
},
{
"symbol": "AZTR",
"symbolName": "Azitra 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>AE</symbol>
<symbolName>Adams Resources & Energy</symbolName>
<exchange>AMEX</exchange>
<instrumentType>stock</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend>0.96</annualDividend>
</item>
<item>
<symbol>AEON</symbol>
<symbolName>Aeon Biopharma Inc</symbolName>
<exchange>AMEX</exchange>
<instrumentType>stock</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend/>
</item>
<item>
<symbol>AIM</symbol>
<symbolName>Aim Immunotech Inc</symbolName>
<exchange>AMEX</exchange>
<instrumentType>stock</instrumentType>
<hasDividends>1</hasDividends>
<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>AMBI</symbol>
<symbolName>Ambipar Emergency Response Cl A</symbolName>
<exchange>AMEX</exchange>
<instrumentType>stock</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend/>
</item>
<item>
<symbol>AMBO</symbol>
<symbolName>Ambow Education Holding Ltd ADR</symbolName>
<exchange>AMEX</exchange>
<instrumentType>stock</instrumentType>
<hasDividends>1</hasDividends>
<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>APT</symbol>
<symbolName>Alpha Pro Tech</symbolName>
<exchange>AMEX</exchange>
<instrumentType>stock</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend/>
</item>
<item>
<symbol>AREN</symbol>
<symbolName>The Arena Group Holdings Inc</symbolName>
<exchange>AMEX</exchange>
<instrumentType>stock</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend/>
</item>
<item>
<symbol>ARMN</symbol>
<symbolName>Aris Mining Corp</symbolName>
<exchange>AMEX</exchange>
<instrumentType>stock</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend/>
</item>
<item>
<symbol>ARMP</symbol>
<symbolName>Armata Pharmaceuticals Inc</symbolName>
<exchange>AMEX</exchange>
<instrumentType>stock</instrumentType>
<hasDividends>1</hasDividends>
<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>
<item>
<symbol>ATNM</symbol>
<symbolName>Actinium Pharmaceuticals Inc</symbolName>
<exchange>AMEX</exchange>
<instrumentType>stock</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend/>
</item>
<item>
<symbol>AUMN</symbol>
<symbolName>Golden Minerals Company</symbolName>
<exchange>AMEX</exchange>
<instrumentType>stock</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend/>
</item>
<item>
<symbol>AUST</symbol>
<symbolName>Austin Gold Corp</symbolName>
<exchange>AMEX</exchange>
<instrumentType>stock</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend/>
</item>
<item>
<symbol>AWX</symbol>
<symbolName>Avalon Holdings Corp</symbolName>
<exchange>AMEX</exchange>
<instrumentType>stock</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend/>
</item>
<item>
<symbol>AXIL</symbol>
<symbolName>Axil Brands Inc</symbolName>
<exchange>AMEX</exchange>
<instrumentType>stock</instrumentType>
<hasDividends>1</hasDividends>
<annualDividend/>
</item>
<item>
<symbol>AZTR</symbol>
<symbolName>Azitra 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"
"AE","Adams Resources & Energy","AMEX","stock","1","0.96"
"AEON","Aeon Biopharma Inc","AMEX","stock","1",""
"AIM","Aim Immunotech Inc","AMEX","stock","1",""
"AIRI","Air Industries Group Inc","AMEX","stock","1",""
"AMBI","Ambipar Emergency Response Cl A","AMEX","stock","1",""
"AMBO","Ambow Education Holding Ltd ADR","AMEX","stock","1",""
"AMS","American Shared Hospital Services","AMEX","stock","1",""
"APT","Alpha Pro Tech","AMEX","stock","1",""
"AREN","The Arena Group Holdings Inc","AMEX","stock","1",""
"ARMN","Aris Mining Corp","AMEX","stock","1",""
"ARMP","Armata Pharmaceuticals Inc","AMEX","stock","1",""
"ASM","Avino Silver & Gold","AMEX","stock","1",""
"ATCH","Atlasclear Holdings Inc","AMEX","stock","1",""
"ATNM","Actinium Pharmaceuticals Inc","AMEX","stock","1",""
"AUMN","Golden Minerals Company","AMEX","stock","1",""
"AUST","Austin Gold Corp","AMEX","stock","1",""
"AWX","Avalon Holdings Corp","AMEX","stock","1",""
"AXIL","Axil Brands Inc","AMEX","stock","1",""
"AZTR","Azitra 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