CLclear-street
Orders

Create order

Changed on

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.

post/accounts/{account_id}/orders

Request

  • Base URL
    https://api.clearstreet.io/studio/v2
  • Auth
    HTTP bearer

Path parameters

account_idstring required

Account ID for the account.

Example:100000

Request body

reference_idstring

An ID that you provide.

order_type'limit' | 'market' | 'stop' | 'stop-limit' 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
side'buy' | 'sell' | 'sell-short' required

Buy, sell, sell-short indicator.

quantitystring required

String representation of quantity.

pricestring

String representation of a price.

stop_pricestring

String representation of a price.

time_in_force'day' | 'ioc' | 'day-plus' | 'at-open' | 'at-close' 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
locate_brokerstring

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

symbolstring required
symbol_format'cms' | 'osi'

Denotes the format of the provided symbol field.

open_close_indicator'open' | 'close'

Example request

{
  "reference_id": "my-order-id-123",
  "quantity": "100",
  "price": "123.99",
  "stop_price": "123.99",
  "symbol": "AAPL",
  "strategy": {
    "min_percent": 1,
    "max_percent": 35
  }
}

Response

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

order_idstring required

An internally generated unique ID for this order.

Example response

{
  "order_id": "234usdfa3"
}

Changes

  • 05b4df42c056Revision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      the request property type changed from no type to string

    • info

      added the new close enum value to the request property

    • info

      added the new open enum value to the request property

  • 9deaa48a0d68Revision changes
    • breaking

      removed the enum value close of the request property

    • breaking

      removed the enum value open of the request property

    • breaking

      the request property type changed from string to no type