Create options strategy / SnapTrade

Create options strategy

post

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

Creates an option strategy object that will be used to place an option strategy order.

Execute an API Request

Path

accountIdstring (format: uuid)required

The ID of the account to create the option strategy object in.

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)

Request Body

underlying_symbol_idstring (format: uuid)required

legsarray of objectsrequired

strategy_typestringrequired

Authorization

clientId

consumerKey

Request

Installation

GitHub npm

npm install snaptrade-typescript-sdk

1
Loading...

Response fields

object

strategyobject

open_pricenumber or null

Trade Price if limit or stop limit order

bid_pricenumber or null

Trade Price if limit or stop limit order

ask_pricenumber or null

Trade Price if limit or stop limit order

volatilitynumber

greekobject

1
{
2
  "strategy": {
3
    "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
4
    "underlying_symbol_id": {
5
      "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
6
      "symbol": "VAB.TO",
7
      "raw_symbol": "VAB",
8
      "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",
9
      "currency": {
10
        "id": "87b24961-b51e-4db8-9226-f198f6518a89",
11
        "code": "USD",
12
        "name": "US Dollar"
13
      },
14
      "exchange": {
15
        "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
16
        "code": "TSX",
17
        "mic_code": "XTSE",
18
        "name": "Toronto Stock Exchange",
19
        "timezone": "America/New_York",
20
        "start_time": "09:30:00",
21
        "close_time": "16:00:00",
22
        "suffix": ".TO"
23
      },
24
      "type": {
25
        "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
26
        "code": "cs",
27
        "description": "Common Stock",
28
        "is_supported": true
29
      },
30
      "currencies": [
31
        {
32
          "id": "87b24961-b51e-4db8-9226-f198f6518a89",
33
          "code": "USD",
34
          "name": "US Dollar"
35
        }
36
      ],
37
      "figi_code": "BBG000B9XRY4",
38
      "figi_instrument": {
39
        "figi_code": "BBG000B9Y5X2",
40
        "figi_share_class": "BBG001S5N8V8"
41
      }
42
    },
43
    "strategy_type": "BUTTERFLY",
44
    "number_of_legs": 2,
45
    "legs": [
46
      {
47
        "option_symbol_id": "AAPLC20221111",
48
        "index": 1,
49
        "action": "BUY_TO_OPEN",
50
        "quantity": 10
51
      }
52
    ]
53
  },
54
  "open_price": 31.33,
55
  "bid_price": 31.33,
56
  "ask_price": 31.33,
57
  "volatility": 0.141,
58
  "greek": {
59
    "delta": 0.1,
60
    "gamma": 0.1,
61
    "theta": 0.1,
62
    "vega": 0.1,
63
    "rho": 0.1
64
  }
65
}

Made with Konfig