GetAccountPositions

Get Account Positions

get

Query parameters

AccountIdintegerRequired

The ID of the account.

OMSIdintegerRequired

The ID of the Order Management System.

IncludePendingbooleanOptional

Include pending positions?

Responses

application/json

object[]OptionalExample: {"omsId":1,"accountId":4,"productSymbol":"BTC","productId":1,"amount":0,"hold":0,"pendingDeposits":0,"pendingWithdraws":0,"totalDayDeposits":0,"totalMonthDeposits":0,"totalYearDeposits":0,"totalYearDepositNotional":0,"totalDayWithdraws":0,"totalMonthWithdraws":0,"totalYearWithdraws":0,"totalYearWithdrawNotional":0,"notionalHoldAmount":0,"notionalRate":0,"totalDayDepositNotional":0,"totalMonthDepositNotional":0,"totalDayWithdrawNotional":0,"totalMonthWithdrawNotional":0}

get

HTTPcURLJavaScriptPython

GET / HTTP/1.1
Host: GetAccountPositions?AccountId=1&OMSId=1
Accept: */*

200

Successful retrieval of account positions.

[
  {
    "omsId": 1,
    "accountId": 4,
    "productSymbol": "BTC",
    "productId": 1,
    "amount": 0,
    "hold": 0,
    "pendingDeposits": 0,
    "pendingWithdraws": 0,
    "totalDayDeposits": 0,
    "totalMonthDeposits": 0,
    "totalYearDeposits": 0,
    "totalYearDepositNotional": 0,
    "totalDayWithdraws": 0,
    "totalMonthWithdraws": 0,
    "totalYearWithdraws": 0,
    "totalYearWithdrawNotional": 0,
    "notionalHoldAmount": 0,
    "notionalRate": 0,
    "totalDayDepositNotional": 0,
    "totalMonthDepositNotional": 0,
    "totalDayWithdrawNotional": 0,
    "totalMonthWithdrawNotional": 0
  }
]