StudioOlympus
API Reference

Create order

post
https://api.clearstreet.io/studio/v2/accounts//orders

Creates a new 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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 1 and 256

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

Body Params
string
length between 1 and 256

An ID that you provide.

string
enum
required

The type of order, 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
  • stop: A stop order will result in a market order when the market price reaches the specified stop price
  • stop-limit: A stop limit order will result in a limit order when the market price reaches the specified stop price
Allowed:
string
enum
required

Buy, sell, sell-short indicator.

Allowed:
string
required
length between 1 and 16

The maximum quantity to be executed.

string
length between 1 and 16

The price to execute at-or-better for limit orders.

string
length between 1 and 16

The price at which stop orders become marketable.

string
enum
required

The lifecycle enforcement of this order.

  • day: The order will exist for the duration of the current trading session
  • ioc: The order will immediately be executed or cancelled
  • day-plus: The order will exist only for the duration the current trading session plus extended hours, if applicable
  • at-open: The order will exist only for the opening auction of the next session
  • at-close: The order will exist only for the closing auction of the current session
Allowed:
string
length between 1 and 256

If you're short-selling and using an away broker for a locate, provide the broker name here.

string
required
length between 1 and 32

The symbol this order is for. See symbol_format for supported symbol formats.

string
enum
Defaults to cms

Denotes the format of the provided symbol field.

Allowed:
strategy

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

string
enum

Open/Close indicator for option orders.

Allowed:
Responses

Updated 2 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 2 months ago