Skip to main content
POST
List current instruments in a book.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Body

Required BookName; StartRow and EndRow are signed 32-bit integers that default to 0, have no declared range constraint, and currently have no effect.

Book selection and accepted row-boundary values for listing its current instrument positions.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Book.ApiListBookInstrumentsRequest, Derivitec.Web.Core
book_name
string | null

Organisation-scoped name of the book to select. The value must not be null or empty.

Example:

"Example book"

start_row
integer<int32>

Accepted starting-row value; the current listing does not use it to limit the returned holdings. Defaults to 0.

Example:

0

end_row
integer<int32>

Accepted ending-row value; the current listing does not use it to limit the returned holdings. Defaults to 0.

Example:

0

Response

Returns instrument rows, or an unsuccessful envelope when display information is unavailable.

Current instrument positions held by the selected book.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Book.ApiListBookInstrumentsResponse, Derivitec.Web.Core
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.

instruments
object[] | null

Current, non-archived instrument positions in the selected book; an empty collection is valid.