getHighsLows API

The getHighsLows API provides lists for new 52-week highs or 52-week lows based on exchange and asset type.

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,NASDAQ

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, BARCHART
Example: STK

type (optional)
The type of high/low list to return. (enum)
Valid values: high, low
Example: low

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

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

offset (optional)
A value denoting where to start results from. (int)
Default: 0
Example: 20


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)
timestamp (always returned)
The exchange time of the last traded priced. (int)
tradeTime (always returned)
The exchange time of the last traded priced. (dateTime)
lastPrice (always returned)
The most recent price at which a stock or security 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)
selectedPeriodHighPrice (always returned)
The high price for the selected period (double)
selectedPeriodHighPercent (always returned)
The high percent change for the selected period (double)
selectedPeriodLowPrice (always returned)
The low price for the selected period (double)
selectedPeriodLowPercent (always returned)
The low percent change for the selected period (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.