getQuote API

The getQuote API is used to request price data, either real-time, delayed or end-of-day, by symbol. In addition to Last Price or Settlement, other fields such as Open, High, Low, Close, Bid, Ask, 52-week high and low, and more are available.

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:

symbols (required)
A symbol or code that identifies a financial instrument. Multiple symbols separated by a comma may be used. For futures, notation such as <root_symbol*0> for the active contract or <root_symbol*1> for the first nearby is supported, as is <root_symbol^F> for all futures contracts for a given root symbol, as is <root_symbol^O> for all options contracts for a given underlying futures symbol. (list)
Example: AAPL,GOOG

fields (optional)
The fields requested. (list)
Example: fiftyTwoWkHigh,fiftyTwoWkHighDate,fiftyTwoWkLow,fiftyTwoWkLowDate

mode (required)
Parameter to change quote type to real-time ("R"), delayed ("I") or end-of-day ("D") if available. (list)
Default: I
Example: I


OUTPUTS:

symbol (always returned)
A symbol or code that identifies a financial instrument. (string)
name (always returned)
The type of symbol used. (string)
dayCode (always returned)
The day code for the session. Day codes are "1-9" for days 1 through 9, "0" (zero) for the 10th of the month, and "A - U" for days 11 through 31. (string)
serverTimestamp (always returned)
The time the message was generated on the server. (dateTime)
mode (always returned)
An indicator representing if the quote is real-time ("R"), delayed ("I") or end-of-day ("D"). (string)
lastPrice (always returned)
The last price the instrument traded. (double)
tradeSize (as requested)
The size of the last traded price / transaction. (int)
tradeTimestamp (always returned)
The exchange timestamp for the last traded price. (dateTime)
netChange (always returned)
The difference between the last traded price and the previous close. (double)
percentChange (always returned)
The percent difference between the last traded price and the previous close. (double)
tick (as requested)
An indicator representing whether the last traded price was up ("+"), the same (".") or below ("-") the previous last price. (string)
previousLastPrice (as requested)
The price previous to the current last price. (double)
previousTimestamp (as requested)
The exchange timestamp of the previous last price. (date)
bid (as requested)
The current bid price. (double)
bidSize (as requested)
The size (quantity) of the current bid price. (int)
ask (as requested)
The current ask price. (double)
askSize (as requested)
The size (quantity) of the current ask price. (int)
unitCode (always returned)
open (always returned)
The opening (first) price for the session. (double)
high (always returned)
The highest traded price for the session. (double)
low (always returned)
The lowest traded price for the session. (double)
close (always returned)
The last traded price for the session. (double)
numTrades (always returned)
The number of individual transactions over the course of a trading session. (int)
dollarVolume (always returned)
flag (always returned)
If present, can be one of the following: "c" meaning that the market is closed for this instrument. "p" meaning that the market is in a pre-open state. This occurs when there are bids and offers being placed, but no trade has occured yet. This is normally seen shortly before the official opening time for busy markets, but can also be seen throughout the day for lightly traded markets. "s" meaning that the instrument has settled, and that this is the final, settlement price. (string)
previousClose (as requested)
The last traded price for the previous session. (double)
settlement (as requested)
The settlement price determined by the exchange. (double)
previousSettlement (as requested)
The settlement price for the previous session. (double)
volume (always returned)
The quantity of shares or contracts traded. (int)
previousVolume (always returned)
The quantity of shares or contracts traded from the previous day. (int)
openInterest (as requested)
The quantity of open interest for futures. (double)
fiftyTwoWkHigh (as requested)
The highest price over the past 52 weeks. (double)
fiftyTwoWkHighDate (as requested)
The date in which the high price was reached over the past 52 weeks. (date)
fiftyTwoWkLow (as requested)
The low price over the past 52 weeks. (double)
fiftyTwoWkLowDate (as requested)
The date in which the low price was reached over the past 52 weeks. (date)
avgVolume (as requested)
The average daily volume. (int)
sharesOutstanding (as requested)
The total number of shares outstanding. In thousands (int)
dividendRateAnnual (as requested)
The total dividend payout over one year. (float)
dividendYieldAnnual (as requested)
The annual dividend divided by the current share price. (float)
exDividendDate (as requested)
The last possible date to have owned shares of a stock and still be entitled to the associated dividend. (date)
impliedVolatility (as requested)
twentyDayAvgVol (as requested)
month (as requested)
Contract month returned for futures. (string)
year (as requested)
Contract year returned for futures. (string)
expirationDate (as requested)
The expiration date for the futures contract. Only returns a value for futures. (date)
lastTradingDay (as requested)
The last trading day of the futures contract. Only returns a value for futures. (string)
twelveMnthPct (as requested)
twelveMnthPctDate (as requested)
preMarketPrice (as requested)
The pre market price for the instrument (double)
preMarketNetChange (as requested)
The pre market net change for the instrument (double)
preMarketPercentChange (as requested)
The pre market percent change for the instrument (double)
preMarketTimestamp (as requested)
The pre market price for the instrument (dateTime)
afterHoursPrice (as requested)
The after hour price for the instrument (double)
afterHoursNetChange (as requested)
The after hour net change for the instrument (double)
afterHoursPercentChange (as requested)
The after hour percent change for the instrument (double)
afterHoursTimestamp (as requested)
The after hour price for the instrument (dateTime)
averageWeeklyVolume (as requested)
The average volume for the last five trading days. (int)
averageMonthlyVolume (as requested)
The average one month volume. (int)
averageQuarterlyVolume (as requested)
The average 3 month volume. (int)
exchangeMargin (as requested)
The margin maintenance required for the future. (string)
oneMonthHigh (as requested)
The highest price over the last month. (double)
oneMonthHighDate (as requested)
The date when the high price was reached over the last month. (date)
oneMonthLow (as requested)
The lowest price over the last month. (double)
oneMonthLowDate (as requested)
The date when the low price was reached over the last month. (date)
threeMonthHigh (as requested)
The highest price over the last 3 month. (double)
threeMonthHighDate (as requested)
The date when the high price was reached over the last 3 month. (date)
threeMonthLow (as requested)
The lowest price over the last 3 month. (double)
threeMonthLowDate (as requested)
The date when the low price was reached over the last 3 month. (date)
sixMonthHigh (as requested)
The highest price over the last 6 month. (double)
sixMonthHighDate (as requested)
The date when the high price was reached over the last 6 month. (date)
sixMonthLow (as requested)
The lowest price over the last 6 month. (double)
sixMonthLowDate (as requested)
The date when the low price was reached over the last 6 month. (date)

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.