getETFDetails API

The getETFDetails API provides ETF profile information including descriptions, fund family, underlying index, inception date, alpha, beta, shares outstanding, management fee, assets under management, top 10 holdings and more.

All APIs

Contact Us to Get Access

Inputs

symbols optional

A valid equity symbol. Multiple symbols separated by a comma may be used.

Type
list (A comma or semi-colon delimited string.) 
Example
SPY 

categories optional

A valid asset class value. Multiple asset classes separated by a comma may be used.

Type
list (A comma or semi-colon delimited string.) 
Example
Equity 

subCategories optional

A valid sub-category (classification) value. Multiple values separated by a comma may be used.

Type
list (A comma or semi-colon delimited string.) 
Example
Global 

Outputs

Name / Requirement
Description
Type
symbol
always returned
A symbol or code that identifies a financial instrument. Multiple symbols separated by a comma may be used.
string
A sequence of characters. (example: GOOG)
name
always returned
The name of the ETF.
string
A sequence of characters. (example: GOOG)
fundFamily
always returned
The family of funds the ETF belongs to
string
A sequence of characters. (example: GOOG)
underlyingIndex
always returned
The underlying index the ETF belongs to
string
A sequence of characters. (example: GOOG)
description
always returned
An overview of the ETF
string
A sequence of characters. (example: GOOG)
assetClass
always returned
The type of assets the ETF invests in
string
A sequence of characters. (example: GOOG)
classification
always returned
The classification for the ETF.
enum
A type which includes a list of valid possible values.
sector
always returned
Sectors the ETF is part of
string
A sequence of characters. (example: GOOG)
inceptionDate
always returned
The launch date of the ETF
date
A date in the format of YYYY-MM-DD.
firstTradeDate
always returned
The first day the ETF traded
date
A date in the format of YYYY-MM-DD.
leverage
always returned
The leverage strategy of the ETF
string
A sequence of characters. (example: GOOG)
alpha
always returned
The alpha of the ETF
double
A numeric type defining a number with fractional parts. (example: 2.14)
beta
always returned
The beta of the ETF
double
A numeric type defining a number with fractional parts. (example: 2.14)
standardDeviation
always returned
The standard deviation of the ETF
double
A numeric type defining a number with fractional parts. (example: 2.14)
sharesOutstanding
always returned
The number of shares outstanding
double
A numeric type defining a number with fractional parts. (example: 2.14)
managedAssets
always returned
The amount of assets invested in the ETF
double
A numeric type defining a number with fractional parts. (example: 2.14)
netAssetValue
always returned
The net assets value of the ETF
double
A numeric type defining a number with fractional parts. (example: 2.14)
firstTradePrice
always returned
The first traded price of the ETF
double
A numeric type defining a number with fractional parts. (example: 2.14)
peRatio
always returned
The p/e ratio of the ETF
double
A numeric type defining a number with fractional parts. (example: 2.14)
managementFee
always returned
The management fee of the ETF
double
A numeric type defining a number with fractional parts. (example: 2.14)
options
always returned
If options are listed on the ETF
string
A sequence of characters. (example: GOOG)
latestDividend
always returned
The latest dividend amount of the ETF
double
A numeric type defining a number with fractional parts. (example: 2.14)
dividendDate
always returned
The date of the latest dividend for the ETF
date
A date in the format of YYYY-MM-DD.
annualDividend
always returned
The amount of the annual dividend for the ETF
double
A numeric type defining a number with fractional parts. (example: 2.14)
annualDividendYield
always returned
The annual dividend yield of the ETF
double
A numeric type defining a number with fractional parts. (example: 2.14)
latestSplit
always returned
The latest split ratio for the ETF
string
A sequence of characters. (example: GOOG)
splitDate
always returned
The date of the latest split
date
A date in the format of YYYY-MM-DD.
ytdReturn
always returned
The year-to-date return on the ETF
double
A numeric type defining a number with fractional parts. (example: 2.14)
OneyearReturn
always returned
The one year return on the ETF
double
A numeric type defining a number with fractional parts. (example: 2.14)
ThreeyearReturn
always returned
The three year return on the ETF
double
A numeric type defining a number with fractional parts. (example: 2.14)
FiveyearReturn
always returned
The five year return on the ETF
double
A numeric type defining a number with fractional parts. (example: 2.14)
TenyearReturn
always returned
The ten year return on the ETF
double
A numeric type defining a number with fractional parts. (example: 2.14)
totalHoldings
always returned
Total number of holdings for the given symbol.
integer
A numeric type defining a whole number. (example: 2)
topHoldings1
always returned
The symbol for the number one holding
string
A sequence of characters. (example: GOOG)
topHoldings1Name
always returned
The name of the holding
string
A sequence of characters. (example: GOOG)
topHoldings1Percent
always returned
The percent of holdings
double
A numeric type defining a number with fractional parts. (example: 2.14)
topHoldings2
always returned
The symbol for the number two holding
string
A sequence of characters. (example: GOOG)
topHoldings2Name
always returned
The name of the holding
string
A sequence of characters. (example: GOOG)
topHoldings2Percent
always returned
The percent of holdings
double
A numeric type defining a number with fractional parts. (example: 2.14)
topHoldings3
always returned
The symbol for the number three holding
string
A sequence of characters. (example: GOOG)
topHoldings3Name
always returned
The name of the holding
string
A sequence of characters. (example: GOOG)
topHoldings3Percent
always returned
The percent of holdings
double
A numeric type defining a number with fractional parts. (example: 2.14)
topHoldings4
always returned
The symbol for the number four holding
string
A sequence of characters. (example: GOOG)
topHoldings4Name
always returned
The name of the holding
string
A sequence of characters. (example: GOOG)
topHoldings4Percent
always returned
The percent of holdings
double
A numeric type defining a number with fractional parts. (example: 2.14)
topHoldings5
always returned
The symbol for the number five holding
string
A sequence of characters. (example: GOOG)
topHoldings5Name
always returned
The name of the holding
string
A sequence of characters. (example: GOOG)
topHoldings5Percent
always returned
The percent of holdings
double
A numeric type defining a number with fractional parts. (example: 2.14)
topHoldings6
always returned
The symbol for the number six holding
string
A sequence of characters. (example: GOOG)
topHoldings6Name
always returned
The name of the holding
string
A sequence of characters. (example: GOOG)
topHoldings6Percent
always returned
The percent of holdings
double
A numeric type defining a number with fractional parts. (example: 2.14)
topHoldings7
always returned
The symbol for the number seven holding
string
A sequence of characters. (example: GOOG)
topHoldings7Name
always returned
The name of the holding
string
A sequence of characters. (example: GOOG)
topHoldings7Percent
always returned
The percent of holdings
double
A numeric type defining a number with fractional parts. (example: 2.14)
topHoldings8
always returned
The symbol for number eight holding
string
A sequence of characters. (example: GOOG)
topHoldings8Name
always returned
The name of the holding
string
A sequence of characters. (example: GOOG)
topHoldings8Percent
always returned
The percent of holdings
double
A numeric type defining a number with fractional parts. (example: 2.14)
topHoldings9
always returned
The symbol for the number nine holding
string
A sequence of characters. (example: GOOG)
topHoldings9Name
always returned
The name of the holding
string
A sequence of characters. (example: GOOG)
topHoldings9Percent
always returned
The percent of holdings
double
A numeric type defining a number with fractional parts. (example: 2.14)
topHoldings10
always returned
The symbol for number ten holding
string
A sequence of characters. (example: GOOG)
topHoldings10Name
always returned
The name of the holding
string
A sequence of characters. (example: GOOG)
topHoldings10Percent
always returned
The percent of holdings
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/getETFDetails.json?apikey=<YOUR API KEY>&symbols=SPY&categories=Equity&subCategories=Global
Host: ondemand.websol.barchart.com

POST

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

apikey=<YOUR API KEY>&symbols=SPY&categories=Equity&subCategories=Global

Response

{
    "status": {
        "code": 200,
        "message": "Success."
    },
    "results": [
        {
            "symbol": "SPY",
            "name": "SPDR S&P 500 ETF",
            "fundFamily": "State Street Global Advisors",
            "underlyingIndex": "S&P 500 Index",
            "description": "The SPDR SP 500 ETF Trust seeks to provide investment results that, before expenses, correspond generally to the price and yield performance of the SP 500 Index.",
            "assetClass": "Equity",
            "classification": {
                "region": "North America",
                "country": "US",
                "sector": "Multi-Sector",
                "equity_index": "S&P 500",
                "leveraged_family": "SPY"
            },
            "sector": "Large Cap",
            "inceptionDate": "1993-01-29",
            "firstTradeDate": "1993-01-29",
            "leverage": "Long",
            "alpha": -0.08,
            "beta": 1,
            "standardDeviation": 11.42,
            "sharesOutstanding": 964082.1,
            "managedAssets": 244057376,
            "netAssetValue": 253.15,
            "firstTradePrice": 43.97,
            "peRatio": 18.67,
            "managementFee": 0.09,
            "options": "Yes",
            "latestDividend": 1.235,
            "dividendDate": "2017-09-15",
            "annualDividend": 4.78,
            "annualDividendYield": 1.89,
            "latestSplit": null,
            "splitDate": null,
            "ytdReturn": 16.43,
            "OneyearReturn": 17.92,
            "ThreeyearReturn": 25.37,
            "FiveyearReturn": 82.72,
            "TenyearReturn": 74.73,
            "totalHoldings": "508",
            "topHoldings1": "AAPL",
            "topHoldings1Name": "Apple Inc",
            "topHoldings1Percent": 4.01,
            "topHoldings2": "MSFT",
            "topHoldings2Name": "Microsoft Corp",
            "topHoldings2Percent": 2.89,
            "topHoldings3": "AMZN",
            "topHoldings3Name": "Amazon.com Inc",
            "topHoldings3Percent": 2.03,
            "topHoldings4": "FB",
            "topHoldings4Name": "Facebook Inc",
            "topHoldings4Percent": 1.93,
            "topHoldings5": "JNJ",
            "topHoldings5Name": "Johnson & Johnson",
            "topHoldings5Percent": 1.66,
            "topHoldings6": "BRK.B",
            "topHoldings6Name": "Berkshire Hathaway Inc",
            "topHoldings6Percent": 1.58,
            "topHoldings7": "JPM",
            "topHoldings7Name": "JPMorgan Chase & Co",
            "topHoldings7Percent": 1.56,
            "topHoldings8": "XOM",
            "topHoldings8Name": "Exxon Mobil Corp",
            "topHoldings8Percent": 1.53,
            "topHoldings9": "GOOG",
            "topHoldings9Name": "Google Inc",
            "topHoldings9Percent": 1.4,
            "topHoldings10": "GOOGL",
            "topHoldings10Name": "Google Inc",
            "topHoldings10Percent": 1.4
        }
    ]
}

XML

GET

GET https://ondemand.websol.barchart.com/getETFDetails.xml?apikey=<YOUR API KEY>&symbols=SPY&categories=Equity&subCategories=Global
Host: ondemand.websol.barchart.com

POST

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

apikey=<YOUR API KEY>&symbols=SPY&categories=Equity&subCategories=Global

Response


<?xml version="1.0" encoding="utf-8"?>
 <getETFDetails>
  <status>
   <code>200</code>
   <message>Success.</message>
  </status>
  <item>
   <symbol>SPY</symbol>
   <name>SPDR S&P 500 ETF</name>
   <fundFamily>State Street Global Advisors</fundFamily>
   <underlyingIndex>S&P 500 Index</underlyingIndex>
   <description>The SPDR SP 500 ETF Trust seeks to provide investment results that, before expenses, correspond generally to the price and yield performance of the SP 500 Index.</description>
   <assetClass>Equity</assetClass>
   <classification>
    <region>North America</region>
    <country>US</country>
    <sector>Multi-Sector</sector>
    <equity_index>S&P 500</equity_index>
    <leveraged_family>SPY</leveraged_family>
   </classification>
   <sector>Large Cap</sector>
   <inceptionDate>1993-01-29</inceptionDate>
   <firstTradeDate>1993-01-29</firstTradeDate>
   <leverage>Long</leverage>
   <alpha>-0.08</alpha>
   <beta>1</beta>
   <standardDeviation>11.42</standardDeviation>
   <sharesOutstanding>964082.1</sharesOutstanding>
   <managedAssets>244057376</managedAssets>
   <netAssetValue>253.15</netAssetValue>
   <firstTradePrice>43.97</firstTradePrice>
   <peRatio>18.67</peRatio>
   <managementFee>0.09</managementFee>
   <options>Yes</options>
   <latestDividend>1.235</latestDividend>
   <dividendDate>2017-09-15</dividendDate>
   <annualDividend>4.78</annualDividend>
   <annualDividendYield>1.89</annualDividendYield>
   <latestSplit></latestSplit>
   <splitDate></splitDate>
   <ytdReturn>16.43</ytdReturn>
   <OneyearReturn>17.92</OneyearReturn>
   <ThreeyearReturn>25.37</ThreeyearReturn>
   <FiveyearReturn>82.72</FiveyearReturn>
   <TenyearReturn>74.73</TenyearReturn>
   <totalHoldings>508</totalHoldings>
   <topHoldings1>AAPL</topHoldings1>
   <topHoldings1Name>Apple Inc</topHoldings1Name>
   <topHoldings1Percent>4.01</topHoldings1Percent>
   <topHoldings2>MSFT</topHoldings2>
   <topHoldings2Name>Microsoft Corp</topHoldings2Name>
   <topHoldings2Percent>2.89</topHoldings2Percent>
   <topHoldings3>AMZN</topHoldings3>
   <topHoldings3Name>Amazon.com Inc</topHoldings3Name>
   <topHoldings3Percent>2.03</topHoldings3Percent>
   <topHoldings4>FB</topHoldings4>
   <topHoldings4Name>Facebook Inc</topHoldings4Name>
   <topHoldings4Percent>1.93</topHoldings4Percent>
   <topHoldings5>JNJ</topHoldings5>
   <topHoldings5Name>Johnson & Johnson</topHoldings5Name>
   <topHoldings5Percent>1.66</topHoldings5Percent>
   <topHoldings6>BRK.B</topHoldings6>
   <topHoldings6Name>Berkshire Hathaway Inc</topHoldings6Name>
   <topHoldings6Percent>1.58</topHoldings6Percent>
   <topHoldings7>JPM</topHoldings7>
   <topHoldings7Name>JPMorgan Chase & Co</topHoldings7Name>
   <topHoldings7Percent>1.56</topHoldings7Percent>
   <topHoldings8>XOM</topHoldings8>
   <topHoldings8Name>Exxon Mobil Corp</topHoldings8Name>
   <topHoldings8Percent>1.53</topHoldings8Percent>
   <topHoldings9>GOOG</topHoldings9>
   <topHoldings9Name>Google Inc</topHoldings9Name>
   <topHoldings9Percent>1.4</topHoldings9Percent>
   <topHoldings10>GOOGL</topHoldings10>
   <topHoldings10Name>Google Inc</topHoldings10Name>
   <topHoldings10Percent>1.4</topHoldings10Percent>
  </item>
 </getETFDetails>

CSV

GET

GET https://ondemand.websol.barchart.com/getETFDetails.csv?apikey=<YOUR API KEY>&symbols=SPY&categories=Equity&subCategories=Global
Host: ondemand.websol.barchart.com

POST

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

apikey=<YOUR API KEY>&symbols=SPY&categories=Equity&subCategories=Global

Response

symbol,name,fundFamily,underlyingIndex,description,assetClass,classification,sector,inceptionDate,firstTradeDate,leverage,alpha,beta,standardDeviation,sharesOutstanding,managedAssets,netAssetValue,firstTradePrice,peRatio,managementFee,options,latestDividend,dividendDate,annualDividend,annualDividendYield,latestSplit,splitDate,ytdReturn,OneyearReturn,ThreeyearReturn,FiveyearReturn,TenyearReturn,totalHoldings,topHoldings1,topHoldings1Name,topHoldings1Percent,topHoldings2,topHoldings2Name,topHoldings2Percent,topHoldings3,topHoldings3Name,topHoldings3Percent,topHoldings4,topHoldings4Name,topHoldings4Percent,topHoldings5,topHoldings5Name,topHoldings5Percent,topHoldings6,topHoldings6Name,topHoldings6Percent,topHoldings7,topHoldings7Name,topHoldings7Percent,topHoldings8,topHoldings8Name,topHoldings8Percent,topHoldings9,topHoldings9Name,topHoldings9Percent,topHoldings10,topHoldings10Name,topHoldings10Percent
"SPY","SPDR S&P 500 ETF","State Street Global Advisors","S&P 500 Index","The SPDR SP 500 ETF Trust seeks to provide investment results that, before expenses, correspond generally to the price and yield performance of the SP 500 Index.","Equity","region:North America,country:US,sector:Multi-Sector,equity_index:S&P 500,leveraged_family:SPY","Large Cap","1993-01-29","1993-01-29","Long","-0.08","1","11.42","964082.1","244057376","253.15","43.97","18.67","0.09","Yes","1.235","2017-09-15","4.78","1.89","","","16.43","17.92","25.37","82.72","74.73","508","AAPL","Apple Inc","4.01","MSFT","Microsoft Corp","2.89","AMZN","Amazon.com Inc","2.03","FB","Facebook Inc","1.93","JNJ","Johnson & Johnson","1.66","BRK.B","Berkshire Hathaway Inc","1.58","JPM","JPMorgan Chase & Co","1.56","XOM","Exxon Mobil Corp","1.53","GOOG","Google Inc","1.4","GOOGL","Google Inc","1.4"


PHP

<?php

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

$params = [
    'symbols' => 'SPY',
    'categories' => 'Equity',
    'subCategories' => 'Global',
];

$result = $ondemand->getETFDetails($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.getETFDetails("SPY", "Equity", "Global")

Perl

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

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

my $result = $ondemand->getETFDetails('SPY', 'Equity', 'Global');

print $result;

Python

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

result = client.service.getETFDetails('SPY', 'Equity', 'Global')

print result

Ruby

require 'savon'

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

response = ondemand.call(
    :getETFDetails,
    message: {
        symbols: 'SPY',
        categories: 'Equity',
        subCategories: 'Global',
    }
)

response.body