CLclear-street
Positions

List positions

Changed on

List current positions for a given account.

get/accounts/{account_id}/positions

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

page_sizeinteger

Number of positions 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": [
    {
      "account_id": "100000",
      "account_number": "ACC0001",
      "symbol": "AAPL",
      "quantity": "100"
    }
  ]
}

Changes

  • f04f51a2adbaRevision changes
    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      added the required property // to the response with the status

  • 507601d53317Revision changes
    • info

      added the optional property // to the response with the status