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. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.

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
"description": "SPY CALL 7/17 200",
6
"option_symbol": {
7
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
8
"ticker": "SPY 220819P00200000",
9
"option_type": "CALL",
10
"strike_price": 200,
11
"expiration_date": "2017-07-17T15:13:07.177712+00:00",
12
"is_mini_option": false,
13
"underlying_symbol": {
14
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
15
"symbol": "SPY",
16
"description": "SPDR S&P 500 ETF Trust",
17
"currency": {
18
"id": "87b24961-b51e-4db8-9226-f198f6518a89",
19
"code": "USD",
20
"name": "US Dollar"
21
},
22
"exchange": {
23
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
24
"code": "ARCX",
25
"mic_code": "ARCA",
26
"name": "NYSE ARCA",
27
"timezone": "America/New_York",
28
"start_time": "09:30:00",
29
"close_time": "16:00:00",
30
"suffix": "None",
31
"allows_cryptocurrency_symbols": false
32
},
33
"type": {
34
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
35
"code": "cs",
36
"description": "Common Stock",
37
"is_supported": true
38
},
39
"currencies": [
40
{
41
"id": "87b24961-b51e-4db8-9226-f198f6518a89",
42
"code": "USD",
43
"name": "US Dollar"
44
}
45
],
46
"figi_code": "BBG000B9XRY4",
47
"figi_instrument": {
48
"figi_code": "BBG000B9Y5X2",
49
"figi_share_class": "BBG001S5N8V8"
50
}
51
},
52
"local_id": "40817960",
53
"exchange_id": "6e73ee7b-fdf3-44c2-947d-260c3ee72506"
54
}
55
},
56
"price": 31.33,
57
"units": 10,
58
"currency": {
59
"id": "87b24961-b51e-4db8-9226-f198f6518a89",
60
"code": "USD",
61
"name": "US Dollar"
62
},
63
"average_purchase_price": 108.3353
64
}
65
]