Create order

post

https://api.clearstreet.io/studio/v2/accounts/{account_id}/digital-assets/orders

Creates a digital asset order for the account. The order is processed asynchronously; a successful response indicates the order was received and is pending further processing, not that it has been accepted by the venue. Use the list orders and list trades endpoints to observe order lifecycle and fills.

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

A digital asset order to create. The order notional (price × quantity) must be at
least the minimum notional. Orders that violate the symbol's tick size, quantity
increment, or minimum notional are rejected.

Contact support for information on supported assets and asset configuration like
tick size, minimum notional and quantity increment.

reference_id

string

length between 1 and 256

An ID that you provide.

order_type

string

enum

required

The order type.

limit - Executes at the limit price or better. Requires price and
quantity.

Allowed:

side

string

enum

required

Either buy or sell side.

Allowed:

quantity

string

required

length between 1 and 16

The quantity in base-asset units. Must be a positive multiple of the symbol's quantity increment.

price

string

length between 1 and 16

The limit price. Required for limit orders. Must be a positive multiple of the tick size.

time_in_force

string

enum

required

The time-in-force policy for the order.

gtc - Good till canceled.
ioc - Immediate or cancel.
fok - Fill or kill.

Allowed:

symbol

string

required

length between 1 and 64

The digital asset symbol.

Responses

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

defaultError response