Unified Snapshot
GET
/v3/snapshot
Retrieve unified snapshots of market data for multiple asset classes including stocks, options, forex, and cryptocurrencies in a single request. This endpoint consolidates key metrics such as last trade, last quote, open, high, low, close, and volume for a comprehensive view of current market conditions. By aggregating data from various sources into one response, users can efficiently monitor, compare, and act on information spanning multiple markets and asset types.
Use Cases: Cross-market analysis, diversified portfolio monitoring, global market insights, multi-asset trading strategies.
Query Parameters
ticker
string
Search a range of tickers lexicographically.
type
enum (string)
Query by the type of asset.
order
enum (string)
Order results based on the `sort` field.
limit
integer
Limit the number of results returned, default is 10 and max is 250.
sort
enum (string)
Sort field used for ordering.
Response Attributes
next_url
string
optional
If present, this value can be used to fetch the next page of data.
request_id
string
A request id assigned by the server.
results
array (object)
optional
An array of results containing the requested data.
break_even_price
number
optional
The price of the underlying asset for the contract to break even. For a call, this value is (strike price + premium paid). For a put, this value is (strike price - premium paid).
details
object
optional
The details for this contract.
error
string
optional
The error while looking for this ticker.
fmv
number
optional
Fair market value is only available on Business plans. It's it our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security.
For more information, contact us.
greeks
object
optional
The greeks for this contract.
There are certain circumstances where greeks will not be returned, such as options contracts that are deep in the money.
See this article for more information.
implied_volatility
number
optional
The market's forecast for the volatility of the underlying asset, based on this option's current price.
last_quote
object
optional
The most recent quote for this contract. This is only returned if your current plan includes quotes.
last_trade
object
optional
The most recent quote for this contract. This is only returned if your current plan includes trades.
market_status
string
optional
The market status for the market that trades this ticker. Possible values for stocks, options, crypto, and forex snapshots are open, closed, early_trading, or late_trading.
Possible values for indices snapshots are regular_trading, closed, early_trading, and late_trading.
message
string
optional
The error message while looking for this ticker.
name
string
optional
The name of this contract.
open_interest
number
optional
The quantity of this contract held at the end of the last trading day.
session
object
optional
Comprehensive trading session metrics, detailing price changes, trading volume, and key price points (open, close, high, low) for the asset within the current trading day. Includes specific changes during early, regular, and late trading periods to enable detailed performance analysis and trend tracking.
ticker
string
The ticker symbol for the asset.
type
enum (stocks, options, fx, crypto, indices)
optional
The asset class for this ticker.
underlying_asset
object
optional
Information on the underlying stock for this options contract. The market data returned depends on your current stocks plan.
value
number
optional
Value of Index.
status
string
The status of this request's response.