logo
Options

Get account option holdings

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

Returns a list of Options Positions.

Execute an API Request

Path
accountIdstring (format: uuid)required

The ID of the account to fetch options holdings for.

Query
userIdstringrequired

SnapTrade User ID

userSecretstringrequired

SnapTrade User Secret (generated when registering user)

Authorization
Request
Installation
$
npm install snaptrade-typescript-sdk
1
Loading...

Response fields

array of objects
object

Option Holdings

1
[
2
{
3
"symbol": {
4
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
5
"symbol": {
6
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
7
"symbol": "VAB.TO",
8
"raw_symbol": "VAB",
9
"description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",
10
"currency": {
11
"id": "87b24961-b51e-4db8-9226-f198f6518a89",
12
"code": "USD",
13
"name": "US Dollar"
14
},
15
"exchange": {
16
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
17
"code": "TSX",
18
"mic_code": "XTSE",
19
"name": "Toronto Stock Exchange",
20
"timezone": "America/New_York",
21
"start_time": "09:30:00",
22
"close_time": "16:00:00",
23
"suffix": ".TO"
24
},
25
"type": {
26
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
27
"code": "cs",
28
"description": "Common Stock",
29
"is_supported": true
30
},
31
"currencies": [
32
{
33
"id": "87b24961-b51e-4db8-9226-f198f6518a89",
34
"code": "USD",
35
"name": "US Dollar"
36
}
37
],
38
"figi_code": "BBG000B9XRY4",
39
"figi_instrument": {
40
"figi_code": "BBG000B9Y5X2",
41
"figi_share_class": "BBG001S5N8V8"
42
}
43
},
44
"brokerage_authorization": {
45
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
46
"created_date": "2022-01-21T20:11:19.217Z",
47
"updated_date": "2022-01-21T20:11:19.217Z",
48
"brokerage": {
49
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
50
"name": "Questrade",
51
"display_name": "Questrade",
52
"description": "Questrade is an online brokerage firm and wealth management firm based in Canada. It is Canada's largest discount broker.",
53
"aws_s3_logo_url": "https://www.snaptrade.com/questrade.logo",
54
"aws_s3_square_logo_url": "https://www.snaptrade.com/questrade.logo",
55
"open_url": "https://www.brokerage.com",
56
"slug": "QUESTRADE",
57
"url": "https://www.questrade.com/",
58
"enabled": true,
59
"maintenance_mode": true,
60
"allows_fractional_units": true,
61
"allows_trading": true,
62
"has_reporting": true,
63
"is_real_time_connection": true,
64
"allows_trading_through_snaptrade_api": true,
65
"is_scraping_integration": true,
66
"default_currency": "2bcd7cc3-e922-4976-bce1-9858296801c3",
67
"brokerage_type": {
68
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
69
"name": "Traditional Brokerage"
70
},
71
"exchanges": [
72
"2bcd7cc3-e922-4976-bce1-9858296801c3",
73
"4bcd8cc3-c122-4974-dc21-1858296801f4"
74
]
75
},
76
"name": "Connection-1",
77
"type": "trade",
78
"disabled": false,
79
"disabled_date": "2022-01-21T20:11:19.217Z",
80
"meta": {
81
"identifier": 123456
82
}
83
},
84
"description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",
85
"allows_fractional_units": true,
86
"option_symbol": {
87
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
88
"ticker": "SPY 220819P00200000",
89
"option_type": "CALL",
90
"strike_price": 200,
91
"expiration_date": "2017-07-17T15:13:07.177712+00:00",
92
"is_mini_option": false,
93
"underlying_symbol": {
94
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
95
"symbol": "SPY",
96
"description": "SPDR S&P 500 ETF Trust",
97
"currency": {
98
"id": "87b24961-b51e-4db8-9226-f198f6518a89",
99
"code": "USD",
100
"name": "US Dollar"
101
},
102
"exchange": {
103
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
104
"code": "ARCX",
105
"mic_code": "ARCA",
106
"name": "NYSE ARCA",
107
"timezone": "America/New_York",
108
"start_time": "09:30:00",
109
"close_time": "16:00:00",
110
"suffix": "None",
111
"allows_cryptocurrency_symbols": false
112
},
113
"type": {
114
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
115
"code": "cs",
116
"description": "Common Stock",
117
"is_supported": true
118
},
119
"currencies": [
120
{
121
"id": "87b24961-b51e-4db8-9226-f198f6518a89",
122
"code": "USD",
123
"name": "US Dollar"
124
}
125
],
126
"figi_code": "BBG000B9XRY4",
127
"figi_instrument": {
128
"figi_code": "BBG000B9Y5X2",
129
"figi_share_class": "BBG001S5N8V8"
130
}
131
},
132
"local_id": "40817960",
133
"exchange_id": "6e73ee7b-fdf3-44c2-947d-260c3ee72506"
134
}
135
},
136
"price": 31.33,
137
"units": 10,
138
"currency": {
139
"id": "87b24961-b51e-4db8-9226-f198f6518a89",
140
"code": "USD",
141
"name": "US Dollar"
142
},
143
"average_purchase_price": 108.3353
144
}
145
]