US Classification
Filter US classification List
Request: GET http://45.55.149.131:8002/api/v1.0/lists?filter=esg Response: { "data": [ { "AsofDate": "20180306", "AverageDailyVolumeSixMonth": 2.74603, "CompositeName": "Barclays Return on Disability ETN", "CompositeTicker": "RODI", "NetAssets": 37958697, "NetExpenseRatio": 0.0045, "OneMonthReturnSplitAndDividend": 0, "OneYearReturnSplitAndDividend": 0.261905, "Sponsor": "Barclays" }, { "AsofDate": "20180306", "AverageDailyVolumeSixMonth": 4305.06, "CompositeName": "Etho Climate Leadership US ETF", "CompositeTicker": "ETHO", "NetAssets": 28056000, "NetExpenseRatio": 0.0049, "OneMonthReturnSplitAndDividend": 0.00114548, "OneYearReturnSplitAndDividend": 0.201511, "Sponsor": "ETF Managers Group" } ], "message": null, "status": true }
Pre-Filtered Categories are
esg
leveraged_inverse
low_vol_risk_wei
sector_industry
emerging_bond
etn
corporate_bond
currency_hedged
active_non_index
dividend
Sample Filter calls
http://45.55.149.131:8002/api/v1.0/lists?filter=esg http://45.55.149.131:8002/api/v1.0/lists?filter=sector_industry http://45.55.149.131:8002/api/v1.0/lists?filter=active_non_index
US ETF Object
{ "AgriculturalType": "Not Applicable", "AsiaSubGroup": "Not Applicable", "AssetClass": "Equities (Stocks)", "AverageMaturity": "Not Applicable", "BaseCurrency": "USD", "BloombergSymbol": "AADR:US", "BondCurrencyDenomination": "Not Applicable", "BondType": "Not Applicable", "BroaderIndexFamily": "Not Applicable", "ChinaListingLocation": "Not Applicable", "CleanEnergyType": "Not Applicable", "CommodityTypes": "Not Applicable", "CompositeName": "AdvisorShares Dorsey Wright ADR ETF", "CompositeTicker": "AADR", "Continent": "Not Applicable", "CreditQuality": "Not Applicable", "CrossSectorTheme": "Not Applicable", "CurrencyHedged": "No", "CurrencyPair": "Not Applicable", "DerivativesBased": "Not Primarily Derivatives Based", "DevelopedEmerging": "Funds Combining Developed & Emerging Exposure", "DividendType": "Not Applicable", "DividendWeightingType": "Not Applicable", "Domicile": "US", "DynamicFuturesRoll": "", "ETFDescription": "The AdvisorShares Dorsey Wright ADR ETF (NYSE Arca: AADR) seeks long-term capital appreciation above international benchmarks such as the MSCI EAFE Index and the BNY Mellon Classic ADR Index." , "ETFTypeSpecific": "Global or ExUS Equities - Factor & Thematic", "ETNIssuingBank": "", "ETNMaturityDate": "", "EnergyType": "Not Applicable", "EuropeSubGroup": "Not Applicable", "ExchangeCode": "ARCX", "ExchangeName": "NYSE Arca", "FloatingRate": "Not Applicable", "FundFamily": "Advisor Shares Funds", "FundListingDate": "", "FundamentalWeightingType": "Not Applicable", "GovernmentBondTypes": "Not Applicable", "GrowthType": "Pure Growth", "GrowthValueTilt": "Growth", "HedgeFundType": "Not Applicable", "ISIN": "US00768Y2063", "InceptionDate": "07/20/2010", "IndexFamily": "Not Applicable", "IndexLinked": "Active", "IndexName": "Not Applicable", "IndexProvider": "Not Applicable", "IndexProviderCode": "Not Applicable", "IndexWeightingScheme": "Not Applicable", "Industry": "Not Applicable", "InverseLeveraged": "Not Applicable", "IssuingEntity": "", "IssuingEntityCountryCode": "US", "LatinAmericaSubGroup": "Not Applicable", "LegalStructure": "ETF (Open end fund)", "ListingCountryCode": "US", "ListingCurrency": "USD", "MarketCapWeightingType": "Not Applicable", "MetalType": "Not Applicable", "MunicipalBondRegion": "Not Applicable", "NetExpenseRatio": "0.0127", "OtherAssetTypes": "Not Applicable", "ParentIndex": "Not Applicable", "QuantStrategiesType": "Not Applicable", "RealEstate": "Not Applicable", "ReplicationStructure": "", "Sector": "Not Applicable", "Share_Class_FIGI": "BBG001T9B1Y4", "SmartBetaType": "", "SocialEnvironmentalType": "Not Applicable", "SpecializedRegion": "Not Applicable", "SpecificCountry": "Not Applicable", "SpecificMaturityYear": "Not Applicable", "Sponsor": "Advisor Shares", "SubIndustry": "Not Applicable", "TargetDateMultiAssetType": "Not Applicable", "UCITS": "No", "USBondTaxStatus": "Not Applicable", "USorExUS": "International", "ValueType": "Not Applicable" }
Listing API
This API returns the possible values taken by a query-able field in the US ETF Object. For example, querying the 'ExchangeCode' field will return a list of all exchange codes. The Filter API specifies which fields can be queried.
Request: GET /api/v1.0/us/list?field=ExchangeCode Response: { "data": [ "ARCX", "XNAS", "BATS" ], "message": null, "status": true }
Filter API
This API returns all the fields in the US ETF Object for specified input values. The input values must be from one of the query-able fields specified below.
CompositeTicker
Sponsor
BloombergSymbol
LegalStructure
ExchangeName
ExchangeCode
AssetClass
ETFType
To get a list of the possible values for a query-able field, use the Listing API
Request: GET /api/v1.0/us/filter?field=ExchangeCode&value=ARCX&count=100&offset=10 Response: { "data" : [List of US ETF objects], "status" : true, "message" : null }
The default value for count is 100 and offset is 0.
The max value for count is 100.
Search API
The Search API does a simple text search on CompositeTicker, CompositeName and Sponsor fields.
Request: GET /api/v1.0/us/search?kw=adviso Response: { "data": [ { "CompositeName": "AdvisorShares Dorsey Wright ADR ETF", "CompositeTicker": "AADR", "ISIN": "US00768Y2063", "Sponsor": "Advisor Shares" }, { "CompositeName": "AdvisorShares Morgan Creek Global Tactical ETF", "CompositeTicker": "GTAA", "ISIN": "US00768Y8003", "Sponsor": "Advisor Shares" } ], "message": null, "status": true }
If the keyword is less than 3 characters, the search will only function on CompositeTicker. For 3 or more characters, search will work on CompositeTickers, Sponsor, CompositeName.