Response fields
array of objectsobjectDescribes a single option position in an account.
symbolobjectUniquely describes a security for the option position within an account. The distinction between this and the option_symbol child property is that this object is specific to a position within an account, while the option_symbol child property is universal across all brokerage accounts. The caller should rely on the option_symbol child property for most use cases.
idstring (format: uuid)A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change.
descriptionstringThis field is deprecated and the caller should use the option_symbol child property's description instead.
option_symbolobjectUniquely describes an option security + exchange combination across all brokerages.
idstring (format: uuid)Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
tickerstringThe OCC symbol for the option.
option_typestringThe type of option. Either "CALL" or "PUT".
strike_pricenumberThe option strike price.
expiration_datestring (format: date)The option expiration date.
is_mini_optionbooleanWhether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100.
underlying_symbolobjectSymbol object for the underlying security of an option.
idstring (format: uuid)Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
symbolstringThe security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the Yahoo Finance ticker format(click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix.
raw_symbolstringThe raw symbol is symbol with the exchange suffix removed. For example, if symbol is "VAB.TO", then raw_symbol is "VAB".
descriptionstring or nullA human-readable description of the security. This is usually the company name or ETF name.
currencyobjectThe currency in which the security is traded.
idstring (format: uuid)Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
codestringThe ISO-4217 currency code for the currency.
namestringA human-friendly name of the currency.
exchangeobjectThe exchange on which the security is listed and traded.
idstring (format: uuid)codestringmic_codestringnamestringtimezonestringstart_timestringclose_timestringsuffixstring or nullallows_cryptocurrency_symbolsbooleantypeobjectThe type of security. For example, "Common Stock" or "ETF".
idstring (format: uuid)Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls.
codestringA short code representing the security type. For example, "cs" for Common Stock. Here are some common values: ad - ADR bnd - Bond cs - Common Stock cef - Closed End Fund et - ETF oef - Open Ended Fund ps - Preferred Stock rt - Right struct - Structured Product ut - Unit wi - When Issued wt - Warrant
descriptionstringA human-readable description of the security type. For example, "Common Stock" or "ETF".
is_supportedbooleanThis field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
currenciesarray of objectsThis field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
idstring (format: uuid)Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
codestringThe ISO-4217 currency code for the currency.
namestringA human-friendly name of the currency.
figi_codestring or nullThis identifier is unique per security per trading venue. See section 1.4.1 of the FIGI Standard for more information. This value should be the same as the figi_code in the figi_instrument child property.
figi_instrumentobject or nullFinancial Instrument Global Identifier (FIGI) information for the security. See OpenFIGI for more information.
figi_codestring or nullThis identifier is unique per security per trading venue. See section 1.4.1 of the FIGI Standard for more information.
figi_share_classstring or nullThis enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, AAPL has a different FIGI for each exchange/trading venue it is traded on. The figi_share_class is the same for all of these FIGIs. See section 1.4.3 of the FIGI Standard for more information.
pricenumber or nullLast known market price per share of the option contract. The freshness of this price depends on the brokerage. Some brokerages provide real-time prices, while others provide delayed prices. It is recommended that you rely on your own third-party market data provider for most up to date prices.
unitsnumberThe number of contracts for this option position. A positive number indicates a long position, while a negative number indicates a short position.
currencyobject or nullThe currency of the price. This field is deprecated and will be removed in a future version. The currency of the price is determined by the currency of the underlying security.
idstring (format: uuid)Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
codestringThe ISO-4217 currency code for the currency.
namestringA human-friendly name of the currency.
average_purchase_pricenumber or nullCost basis per contract of this option position. To get the cost basis per share, divide this value by the number of shares per contract (usually 100).
1[2{3"symbol": {4"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",5"description": "SPY CALL 7/17 200",6"option_symbol": {7"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",8"ticker": "AAPL 261218C00240000",9"option_type": "CALL",10"strike_price": 240,11"expiration_date": "2026-12-18",12"is_mini_option": false,13"underlying_symbol": {14"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",15"symbol": "SPY",16"raw_symbol": "VAB",17"description": "SPDR S&P 500 ETF Trust",18"currency": {19"id": "87b24961-b51e-4db8-9226-f198f6518a89",20"code": "USD",21"name": "US Dollar"22},23"exchange": {24"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",25"code": "ARCX",26"mic_code": "ARCA",27"name": "NYSE ARCA",28"timezone": "America/New_York",29"start_time": "09:30:00",30"close_time": "16:00:00",31"suffix": "None",32"allows_cryptocurrency_symbols": false33},34"type": {35"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",36"code": "cs",37"description": "Common Stock",38"is_supported": true39},40"currencies": [41{42"id": "87b24961-b51e-4db8-9226-f198f6518a89",43"code": "USD",44"name": "US Dollar"45}46],47"figi_code": "BBG000B9XRY4",48"figi_instrument": {49"figi_code": "BBG000B9Y5X2",50"figi_share_class": "BBG001S5N8V8"51}52}53}54},55"price": 38.4,56"units": -50,57"currency": {58"id": "87b24961-b51e-4db8-9226-f198f6518a89",59"code": "USD",60"name": "US Dollar"61},62"average_purchase_price": 412663}64]