CLclear-street
Orders

List orders

Changed on

List orders for a given account for the current trading day, filtered on the given query parameters.

get/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

Query parameters

frominteger

Milliseconds since epoch.

tointeger

Milliseconds since epoch.

page_sizeinteger

Number of orders to return per page.

page_tokenstring

Cursor for the page to return.

Response

Successful response

next_page_tokenstring

Cursor for the next page of results.

Example response

{
  "data": [
    {
      "order_id": "12390213",
      "reference_id": "my-order-id-123",
      "version": 1,
      "account_id": "100000",
      "account_number": "ACC0001",
      "symbol": "AAPL",
      "quantity": "100",
      "price": "123.99",
      "stop_price": "123.99",
      "filled_quantity": "100",
      "strategy": {
        "min_percent": 1,
        "max_percent": 35
      },
      "running_position": "100"
    }
  ]
}

Changes

  • 05b4df42c056Revision changes
    • breaking

      the // response's property type changed from no type to string for status

    • warning

      added the new close enum value to the // response property for the response status

    • warning

      added the new open enum value to the // response property for the response status

  • 9deaa48a0d68Revision changes
    • breaking

      the // response's property type changed from string to no type for status

    • info

      removed the close enum value from the // response property for the response status

    • info

      removed the open enum value from the // response property for the response status