Create multi-leg order

post

https://api.clearstreet.io/studio/v2/accounts/{account_id}/multi-leg-orders

Creates a new multi-leg order and sends to our internal systems for execution. Note that a successful call to this endpoint does not necessarily mean your order has been accepted, e.g. a downstream venue might reject your order. You should therefore utilize our WebSocket APIs to listen for changes in order lifecycle events.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

string

required

length between 1 and 256

The account ID or account number to create the order for.

Body Params

reference_id

string

length between 1 and 256

An ID that you provide.

order_type

string

enum

required

The type of order for multi-leg orders, can be one of the following:

limit: A limit order will execute at-or-better than the limit price you specify
market: An order that will execute at the prevailing market prices

Allowed:

quantity

string

required

length between 1 and 16

The strategy quantity.

price

string

length between 1 and 16

Net package price for the order. Positive values indicate a debit; negative values indicate a credit.

route_type

string

enum

Defaults to sor

The routing method to use for this order. If not provided, our smart order-router will handle execution for your order.

sor: Smart order router (default)
desk: Trade desk routed

Allowed:

legs

array of objects

required

length between 2 and 4

legs*

instructions

string

For desk-routed orders, specific instructions for the desk.

is_swap

boolean

Defaults to false

For desk-routed orders, whether the order is a swap.

Responses

201Order received. Indicates the the order was received and is pending further processing.

defaultError response