Positions

Retrieve position

Returns the account's position in the given instrument.

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/{instrument_id}

Request

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

Response

Response

account_idstring uuid required

Universally Unique Identifier (UUID) of the account.

quantitystring required
locked_for_tradingstring required

A positive decimal amount, as a string.

pending_settlementstring required

A positive decimal amount, as a string.

available_for_tradingstring required
available_for_instructionstring required
settled_quantitystring required

A positive decimal amount, as a string.

Changes

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