CLclear-street
Positions

Get position

Changed on

Get current position for a given account for a given symbol.

get/accounts/{account_id}/positions/{symbol}

Request

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

Path parameters

account_idstring required

Account ID for the account.

Example:100000
symbolstring required
Example:AAPL

Response

Successful response

account_idstring required

Account ID for the account.

account_numberstring required

Account number for the account.

symbolstring required
quantitystring required

String representation of quantity.

average_costnumber double required

The average cost of the position.

Example response

{
  "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