Positions

List Account Positions

Retrives a list of Account Positions by accountID

get/accounts/{accountID}/summary/positions

Request

  • Base URL
    https://bo-api.drivewealth.io/back-office
  • URL
    https://bo-api.drivewealth.io/back-office/accounts/{accountID}/summary/positions
  • Auth
    HTTP bearer

Path parameters

accountIDstring required

sensitive The user's unique account identifier.

Example:123e4567-e89b-12d3-a456-000000000004.1234567890125

sensitive

Response

Retrieving an Account's Positions by accountID was Successful.

accountIDstring

sensitive The user's unique account identifier.

accountNostring

sensitive The user's unique account number, that is human readable.

tradingType'CASH' | 'MARGIN'

The type of trading the account will participate in.

updatedstring

Time of last update.

equityValuenumber double

The current total market value of the account's open equity positions.

optionsValuenumber double

The current total market value of the account's open option positions.

debtValuenumber double

The current total market value of the account's open debt positions.

positionsValuenumber double

The current total market value of the account's open positions.

Example response

{
  "accountID": "123e4567-e89b-12d3-a456-000000000004.1234567890125",
  "accountNo": "FFFF000005",
  "tradingType": "CASH",
  "updated": "2017-06-16T15:35:30.617Z",
  "equityValue": 34275565.44,
  "optionsValue": 12345.67,
  "debtValue": 12345.67,
  "positionsValue": 34287911.11,
  "equityPositions": [
    {
      "symbol": "MS",
      "instrumentID": "123e4567-e89b-12d3-a456-000000000006",
      "ISIN": "US023135BX34",
      "instrumentType": "EQUITY",
      "openQty": 31.65120151,
      "costBasis": 975.98,
      "marketValue": 4540.36,
      "side": "B",
      "priorClose": 144.29,
      "availableForTradingQty": 31.65120151,
      "avgPrice": 30.84,
      "mktPrice": 143.45,
      "unrealizedPL": 3564.38,
      "unrealizedDayPLPercent": -0.58,
      "unrealizedDayPL": -26.59
    }
  ],
  "optionsPositions": [
    {
      "symbol": "MS",
      "instrumentID": "123e4567-e89b-12d3-a456-000000000006",
      "ISIN": "US023135BX34",
      "instrumentType": "EQUITY",
      "openQty": 31.65120151,
      "costBasis": 975.98,
      "marketValue": 4540.36,
      "side": "B",
      "priorClose": 144.29,
      "availableForTradingQty": 31.65120151,
      "avgPrice": 30.84,
      "mktPrice": 440.75,
      "unrealizedPL": 14.24,
      "unrealizedDayPLPercent": 1.65,
      "unrealizedDayPL": 0.54
    }
  ],
  "mutualFundsPositions": [
    {
      "symbol": "MS",
      "instrumentID": "123e4567-e89b-12d3-a456-000000000006",
      "ISIN": "US023135BX34",
      "instrumentType": "EQUITY",
      "openQty": 31.65120151,
      "costBasis": 975.98,
      "marketValue": 4540.36,
      "side": "B",
      "priorClose": 144.29,
      "availableForTradingQty": 31.65120151,
      "avgPrice": 30.84
    }
  ],
  "debtPositions": [
    {
      "symbol": "MS",
      "instrumentID": "123e4567-e89b-12d3-a456-000000000006",
      "ISIN": "US023135BX34",
      "instrumentType": "EQUITY",
      "openQty": 31.65120151,
      "costBasis": 975.98,
      "marketValue": 4540.36,
      "side": "B",
      "priorClose": 144.29,
      "availableForTradingQty": 31.65120151,
      "avgPrice": 30.84,
      "unrealizedPL": 3564.38
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.