List account option positions / SnapTrade

List account option positions

get

https://api.snaptrade.com/accounts/{accountId}/options

Deprecated

Refrain from usage of this operation

Deprecated. Use the newer unified positions endpoint instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures.

Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the positions endpoint.

Check your API key on the Customer Dashboard billing page to see if you have real-time data access:

If you do, this endpoint returns real-time data.
If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the manual refresh endpoint.

Execute an API Request

Authentication Method

Use commercial authentication when acting on behalf of your application and passing end-user credentials with requests that require them.

Credentials

clientId

consumerKey

userId

userSecret

Path

accountIdstring (format: uuid)required

Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.

Request

Installation

GitHub npm

npm install snaptrade-typescript-sdk

1
import {
2
  Snaptrade,
3
  SnaptradeAuth,
4
} from "snaptrade-typescript-sdk";
5

6
const snaptrade = new Snaptrade({
7
  auth: SnaptradeAuth.commercialApiKey({
8
    consumerKey: "CONSUMER_KEY",
9
    clientId: "CLIENT_ID",
10
  }),
11
});
12

13
const response =
14
  await snaptrade.options.listOptionHoldings({
15
    accountId:
16
      "917c8734-8470-4a3e-a18f-57c3f2ee6631",
17
    userId: "USER_ID",
18
    userSecret: "USER_SECRET",
19
  });
20
console.log(response.data);

Response fields

array of objects

object

Describes a single option position in an account.

symbolobject

Uniquely 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.

option_symbolobject

Uniquely 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.

tickerstring

The OCC symbol for the option.

option_typestring

The type of option. Either "CALL" or "PUT".

strike_pricenumber

The option strike price.

expiration_datestring (format: date)

The option expiration date.

is_mini_optionboolean

Whether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100.

underlying_symbolobject

Symbol 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.

symbolstring

The 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_symbolstring

The raw symbol is symbol with the exchange suffix removed. For example, if symbol is "VAB.TO", then raw_symbol is "VAB".

descriptionstring or null

A human-readable description of the security. This is usually the company name or ETF name.

currencyobject

The currency in which the security is traded.

exchangeobject

The exchange on which the security is listed and traded.

typeobject

The type of security. For example, "Common Stock" or "ETF".

figi_codestring or null

This 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 null

Financial Instrument Global Identifier (FIGI) information for the security. See OpenFIGI for more information.

currenciesarray of objects

Deprecated

Refrain from usage of this field

This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid use case for this.

idstring (format: uuid)

Deprecated

Refrain from usage of this field

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.

descriptionstring

Deprecated

Refrain from usage of this field

This field is deprecated and the caller should use the option_symbol child property's description instead.

pricenumber or null

Last 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.

unitsnumber

The number of contracts for this option position. A positive number indicates a long position, while a negative number indicates a short position.

average_purchase_pricenumber or null

Cost 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).

currencyobject or null

The 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.

1
[
2
  {
3
    "symbol": {
4
      "option_symbol": {
5
        "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
6
        "ticker": "AAPL  261218C00240000",
7
        "option_type": "CALL",
8
        "strike_price": 240,
9
        "expiration_date": "2026-12-18T00:00:00.000Z",
10
        "is_mini_option": false,
11
        "underlying_symbol": {
12
          "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
13
          "symbol": "SPY",
14
          "raw_symbol": "VAB",
15
          "description": "SPDR S&P 500 ETF Trust",
16
          "currency": {
17
            "id": "87b24961-b51e-4db8-9226-f198f6518a89",
18
            "code": "USD",
19
            "name": "US Dollar"
20
          },
21
          "exchange": {
22
            "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
23
            "code": "ARCX",
24
            "mic_code": "ARCA",
25
            "name": "NYSE ARCA",
26
            "timezone": "America/New_York",
27
            "start_time": "09:30:00",
28
            "close_time": "16:00:00",
29
            "suffix": "None",
30
            "allows_cryptocurrency_symbols": false
31
          },
32
          "type": {
33
            "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
34
            "code": "cs",
35
            "description": "Common Stock",
36
            "is_supported": true
37
          },
38
          "figi_code": "BBG000B9XRY4",
39
          "figi_instrument": {
40
            "figi_code": "BBG000B9Y5X2",
41
            "figi_share_class": "BBG001S5N8V8"
42
          },
43
          "currencies": [
44
            {
45
              "id": "87b24961-b51e-4db8-9226-f198f6518a89",
46
              "code": "USD",
47
              "name": "US Dollar"
48
            }
49
          ]
50
        }
51
      },
52
      "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
53
      "description": "SPY CALL 7/17 200"
54
    },
55
    "price": 38.4,
56
    "units": -50,
57
    "average_purchase_price": 4126,
58
    "currency": {
59
      "id": "87b24961-b51e-4db8-9226-f198f6518a89",
60
      "code": "USD",
61
      "name": "US Dollar"
62
    }
63
  }
64
]

Made with Konfig