List Exercise and Do-Not-Exercise summary totals by instrument

beta Provide aggregated totals of quantities grouped by request type (EXERCISE, DO_NOT_EXERCISE) at the instrument level. Supports optional filters and date range. By default, requests from today (UTC) are included.

get/accounts/{accountID}/positions/options/requests/summary

Request

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

Path parameters

accountIDstring required

sensitive The user's unique account identifier.

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

sensitive Account ID to summarize requests for.

Query parameters

instrumentIDstring

Filter to summarize requests for an instrument.

startDatestring date

Start date for filtering requests (YYYY-MM-DD in UTC). If not provided, defaults to today's date.

endDatestring date

End date for filtering requests (YYYY-MM-DD in UTC). If not provided, defaults to today's date.

Response

Summary calculated successfully.

Example response

{
  "data": [
    {
      "accountID": "123e4567-e89b-12d3-a456-000000000004.1234567890125",
      "instrumentID": "123e4567-e89b-12d3-a456-000000000006"
    }
  ]
}

Changes

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