Positions

List positions

Returns the list of positions held by the account.

Use the offset and limit query parameters to page through results; meta.total_count gives the total number of matching positions.

See the Positions guide (TOL / BYOL) for how to interpret the quantity, locked_for_trading, pending_settlement, available_for_trading, available_for_instruction, and settled_quantity fields.

get/accounts/{account_id}/positions

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/accounts/{account_id}/positions
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: positions:read)

Query parameters

offsetinteger

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

limitinteger

Use the limit argument to specify the maximum number of items returned.

Response

Response

Changes

No recorded changes to this operation across all 25 revisions of this API.