Liquidations

List accounts liquidations

Returns a paginated list of account liquidation requests for the authenticated client.

See the Liquidations guide (TOL / BYOL) for implementation details.

get/accounts/{account_id}/liquidations

Request

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

Query parameters

sort'id'

Sort the result by id.

order'ASC'

Sort order of the result list if the sort parameter is specified. By default, only ASC for ascending sort.

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.

start_datestring

Returns accounts liquidations created starting from and including this date (UTC)

end_datestring

Returns accounts liquidations created up until this date (UTC)

Response

Accounts liquidations

Changes

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