CLclear-street
Inventories

Get inventory

Changed on

Get located inventory for a symbol.

get/accounts/{account_id}/inventories/{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

Account ID for the account.

account_numberstring

Account number for the account.

symbolstring
availablestring

String representation of quantity.

reservedstring

String representation of quantity.

usedstring

String representation of quantity.

Example response

{
  "account_id": "100000",
  "account_number": "ACC0001",
  "symbol": "AAPL",
  "available": "100",
  "reserved": "100",
  "used": "100"
}

Changes