Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-0175184292.5 KB
Trading

Place option order

Places a multi-leg option order. Only supported on certain option trading brokerages. https://support.snaptrade.com/brokerages has information on brokerage trading support

post/accounts/{accountId}/trading/options

Path parameters

accountIdstring uuid required

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

Example:917c8734-8470-4a3e-a18f-57c3f2ee6631

Query parameters

userIdstring required

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.

Example:snaptrade-user-123
userSecretstring required

SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the rotate user secret endpoint.

Example:adf2aa34-8219-40f7-a6b3-60156985cc61

Request body

order_type'MARKET' | 'LIMIT' | 'STOP_LOSS_MARKET' | 'STOP_LOSS_LIMIT' required

The type of order to place.

time_in_force'FOK' | 'Day' | 'GTC' | 'IOC' required

The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values:

  • Day - Day. The order is valid only for the trading day on which it is placed.
  • GTC - Good Til Canceled. The order is valid until it is executed or canceled.
  • FOK - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely.
  • IOC - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled.
limit_pricestring decimal nullable

The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT.

stop_pricestring decimal nullable

The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT.

price_effect'CREDIT' | 'DEBIT' | 'EVEN'

The desired price_effect for LIMIT and STOP_LOSS_LIMIT orders. Values are CREDIT, DEBIT, EVEN

Example request

{
  "order_type": "MARKET",
  "time_in_force": "Day",
  "price_effect": "DEBIT",
  "legs": [
    {
      "instrument": {
        "symbol": "PBI   250718C00006000"
      },
      "action": "BUY_TO_OPEN",
      "units": 1
    }
  ]
}

Response

OK

brokerage_order_idstring required

Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.

Example response

{
  "brokerage_order_id": "66a033fa-da74-4fcf-b527-feefdec9257e",
  "orders": [
    {
      "brokerage_order_id": "66a033fa-da74-4fcf-b527-feefdec9257e",
      "brokerage_group_order_id": "1234567890",
      "order_role": "TRIGGER",
      "universal_symbol": {
        "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
        "symbol": "VAB.TO",
        "raw_symbol": "VAB",
        "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",
        "currency": {
          "id": "87b24961-b51e-4db8-9226-f198f6518a89",
          "code": "USD",
          "name": "US Dollar"
        },
        "exchange": {
          "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
          "code": "TSX",
          "mic_code": "XTSE",
          "name": "Toronto Stock Exchange",
          "timezone": "America/New_York",
          "start_time": "09:30:00",
          "close_time": "16:00:00",
          "suffix": ".TO"
        },
        "type": {
          "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
          "code": "cs",
          "description": "Common Stock",
          "is_supported": true
        },
        "figi_code": "BBG000B9XRY4",
        "figi_instrument": {
          "figi_code": "BBG000B9Y5X2",
          "figi_share_class": "BBG001S5N8V8"
        },
        "currencies": [
          {
            "id": "87b24961-b51e-4db8-9226-f198f6518a89",
            "code": "USD",
            "name": "US Dollar"
          }
        ]
      },
      "option_symbol": {
        "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
        "ticker": "AAPL  261218C00240000",
        "option_type": "CALL",
        "strike_price": 240,
        "expiration_date": "2026-12-18",
        "underlying_symbol": {
          "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
          "symbol": "SPY",
          "raw_symbol": "VAB",
          "description": "SPDR S&P 500 ETF Trust",
          "currency": {
            "id": "87b24961-b51e-4db8-9226-f198f6518a89",
            "code": "USD",
            "name": "US Dollar"
          },
          "exchange": {
            "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
            "code": "ARCX",
            "mic_code": "ARCA",
            "name": "NYSE ARCA",
            "timezone": "America/New_York",
            "start_time": "09:30:00",
            "close_time": "16:00:00",
            "suffix": "None"
          },
          "type": {
            "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
            "code": "cs",
            "description": "Common Stock",
            "is_supported": true
          },
          "figi_code": "BBG000B9XRY4",
          "figi_instrument": {
            "figi_code": "BBG000B9Y5X2",
            "figi_share_class": "BBG001S5N8V8"
          },
          "currencies": [
            {
              "id": "87b24961-b51e-4db8-9226-f198f6518a89",
              "code": "USD",
              "name": "US Dollar"
            }
          ]
        }
      },
      "quote_universal_symbol": {
        "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
        "symbol": "VAB.TO",
        "raw_symbol": "VAB",
        "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",
        "currency": {
          "id": "87b24961-b51e-4db8-9226-f198f6518a89",
          "code": "USD",
          "name": "US Dollar"
        },
        "exchange": {
          "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
          "code": "TSX",
          "mic_code": "XTSE",
          "name": "Toronto Stock Exchange",
          "timezone": "America/New_York",
          "start_time": "09:30:00",
          "close_time": "16:00:00",
          "suffix": ".TO"
        },
        "type": {
          "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
          "code": "cs",
          "description": "Common Stock",
          "is_supported": true
        },
        "figi_code": "BBG000B9XRY4",
        "figi_instrument": {
          "figi_code": "BBG000B9Y5X2",
          "figi_share_class": "BBG001S5N8V8"
        },
        "currencies": [
          {
            "id": "87b24961-b51e-4db8-9226-f198f6518a89",
            "code": "USD",
            "name": "US Dollar"
          }
        ]
      },
      "quote_currency": {
        "id": "87b24961-b51e-4db8-9226-f198f6518a89",
        "code": "USD",
        "name": "US Dollar"
      },
      "total_quantity": "100",
      "open_quantity": "10",
      "canceled_quantity": "10",
      "filled_quantity": "80",
      "execution_price": "12.34",
      "limit_price": "12.34",
      "stop_price": "12.50",
      "trailing_stop": {
        "amount": "0.60"
      },
      "order_type": "Market",
      "time_placed": "2024-07-30T22:51:49.746270Z",
      "time_updated": "2024-08-05T00:05:57.409000Z",
      "time_executed": "2024-08-05T00:05:57.409000Z",
      "expiry_date": "2024-08-05T00:05:57.409000Z",
      "symbol": "2bcd7cc3-e922-4976-bce1-9858296801c3",
      "child_brokerage_order_ids": {
        "take_profit_order_id": "12345678",
        "stop_loss_order_id": "12345678"
      }
    }
  ]
}