Positions

GET /v2/accounts/{account_id}/positions/

This endpoint allows to retrieve the most recent positions within a given account.

Positions Headers

Authorization required	The access token.

Positions Parameters

account_id string, required	ID of the account.
page integer	Desired page number, default is 0.
page_size integer	Desired number of entries per page, defaults is 100, max value is 1000.

Positions Response Object Fields

id string, required	The ID of the position.
cusip string, required	CUSIP Identifier
symbol string, required	Symbol
description string	Security Description
long_short_indicator string	The long/short indicator.
currency_code string, required	the international 3-digit currency code (upon ISO 4217). For example, USD.
quantity number, required	The total quantity of the position.
as_of_date string, required	The latest date of an update.
security_type string	Security type. Possible values ETF FI OPTION TBILL INDEX EQ WARRANT CASH MBS MUTUAL CD EQUITY UNIT OTHER
market_value number	The total value of the position.

GET /api/v1/positions/{account_id} (deprecating soon)

This endpoint gets a list of the most recent positions for/within a given account.

Positions Headers

Authorization required	The access token.

Positions Parameters

account_id string, required	ID of the account.
page integer	Desired page number, default is 0.
page_size integer	Desired number of entries per page, defaults is 100, max value is 1000.

Positions Response Object Fields

id string, required	The ID of the position.
cusip string, required	CUSIP Identifier
symbol string, required	Symbol
description string	Security Description
security_type string	Security Type. Possible values ETF FI OPTION TBILL INDEX EQ WARRANT CASH MBS MUTUAL CD EQUITY UNIT OTHER
currency_code string, required	the international 3-digit currency code (upon ISO 4217). For example, USD.
quantity number, required	The total quantity of the position.
market_value number	The total value of the position.
as_of_date string, required	Date of the record.