getLeaders API

The getLeaders API provides leaderboard lists for equities, futures, forex, mutual funds and ETFs, including most active, gainers, losers, what's hot and what's not hot.

Pricing is based on the number of monthly queries and fields requested. We offer four packages: Small, Medium, Large, Enterprise. Contact us for additional details.


API Documentation

INPUTS:

exchanges (optional)
Exchange code for the marketplace where the financial instruments are listed. (list-enum)
Valid values: AMEX, CBOT, CBOTM, CME, COMEX, FOREX, GBLX, ICE, ICEFI, ICEUS, WCE, CADFUNDS, FUND, INDEX, INDEX-CBOE, INDEX-DOW, INDEX-NQ, INDEX-NY, INDEX-SP, INDEX-TSX, IOM, IMM, KCBT, LCE, MGEX, NASDAQ, OTHER OTC, RATES, RATE, NYMEX, NYMI, NYSE, NLIF, TSX, TSX-V, SECTOR, CNSX, LIFFE, EUIDX, EUREX, BMF, MATIF, CXMI, HKFE, SPECIAL, INDEX-RL, MATBA, NCDEX, ASX, ROFEX, OTC-BB, SIMEX, CZCE, CROSS, BSE, MNTRL, ECONOMY, TOCOM, MEFF, ENDEX, SAFEX, TIFFE, CASH, MCX, NZX, MDEX, DGCX, NSE, CBOE, DME, OMX, CFE, TURK, TFEX, TAIWA, SHFE, DCE, BATS, LSE, LME, EEX, CFFEX, JPX
Example: NYSE

assetType (required)
The type of asset. Includes: equities ("STK"), mutual funds ("FUNDS"), ETFs ("ETF"), futures ("FUT"), forex ("FOREX") (enum)
Valid values: STK, ETF, FUND, FUT, FOREX
Example: STK

type (required)
The type of leaderboard to display. (enum)
Valid values: active, active_5d, active_1m, active_3m, active_6m, active_9m, active_12m, active_ytd, gainers, gainers_5d, gainers_1m, gainers_3m, gainers_6m, gainers_9m, gainers_12m, gainers_ytd, losers, losers_5d, losers_1m, losers_3m, losers_6m, losers_9m, losers_12m, losers_ytd, hot, hot_daily, hot_weekly, hot_monthly, nothot, nothot_daily, nothot_weekly, nothot_monthly, barchart
Example: hot

maxRecords (optional)
The maximum number of records to show in the return. (int)
Default: 100
Example: 30

period (optional)
A value representing the time period. (enum)
Valid values: 5d, 20d, 65d, 100d, 260d
Default: 260d
Example: 260d

sortDirection (optional)
To determine the sort direction. (string)
Default: ASC
Example:


OUTPUTS:

symbol (always returned)
A symbol or code that identifies a financial instrument. (string)
symbolName (always returned)
The full name of the instrument. (string)
exchange (always returned)
Exchange code for the marketplace where the financial instruments are listed. (string)
country (always returned)
The instrument's country of origin. (string)
sicSector (always returned)
A four-digit code for classifying industries. (string)
industry (always returned)
A code that identifies a group of businesses that produce similar products or services. (string)
subIndustry (always returned)
A more specific group of businesses within an industry that produce similar products or services. (string)
timestamp (always returned)
The time the message was generated on the server. (dateTime)
tradeTimestamp (always returned)
The exchange timestamp for the last traded price. (dateTime)
lastPrice (always returned)
The last price the instrument traded. (double)
priceNetChange (always returned)
The difference between the last price and the previous day's settlement price. (double)
pricePercentChange (always returned)
The difference between the last price and the previous day's settlement price, expressed as a percentage. (double)
previousClose (always returned)
The closing value of the instrument on the previous day. (double)
volume (always returned)
The number of shares or contracts traded. (int)
previousVolume (always returned)
The number of shares or contracts traded for the previous day. (int)
standardDeviation (always returned)
The standard deviation using the past 20-days of data. (double)

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.