> ## Documentation Index
> Fetch the complete documentation index at: https://docs.activeviam.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List current instruments in a book.

> Lists current non-deleted, non-archived position entries in an accessible book with tradable identifier,
display name, and quantity. This is read-only. Although `StartRow` and `EndRow` are accepted,
they are not currently applied, so this operation is not paginated.



## OpenAPI

````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/Books/ListBookInstruments
openapi: 3.0.4
info:
  title: Derivitec Api 1.0
  version: '1.0'
servers:
  - url: https://api.riskportal.activeviam.com
security:
  - oauth2: []
  - apikey: []
tags:
  - name: AdminUser
  - name: AtotiReport
  - name: AtotiSession
  - name: BloombergOAuth
  - name: Bond
  - name: BondYieldCurvePage
  - name: BookAccess
  - name: Books
  - name: Commodity
  - name: Counterparties
  - name: Currencies
  - name: Equity
  - name: EquityDividend
  - name: EquityPage
  - name: FeatureFlag
  - name: Fx
  - name: FxPage
  - name: GroupAccess
  - name: Home
  - name: LegacyPosition
  - name: MarketData
  - name: MarketDataProvider
  - name: MarketDataProviderAccess
  - name: Meta
  - name: Notification
  - name: Organisation
  - name: PnLReport
  - name: PortfolioAccess
  - name: Portfolios
  - name: Position
  - name: PositionFilter
  - name: PricingEnvironment
  - name: PricingEnvironmentAccess
  - name: RateAsset
  - name: RateAssetPage
  - name: Report
  - name: ReportDefinition
  - name: ReportHistoryLauncherQuery
  - name: ReportLauncher
  - name: ReportQuery
  - name: ReportQueryViewUser
  - name: ReportRestriction
  - name: ReportView
  - name: RiskReport
  - name: Tradable
  - name: TradeBooking
  - name: User
  - name: VarReport
  - name: VarReportQuery
  - name: YieldCurvePage
paths:
  /api/Books/ListBookInstruments:
    post:
      tags:
        - Books
      summary: List current instruments in a book.
      description: >-
        Lists current non-deleted, non-archived position entries in an
        accessible book with tradable identifier,

        display name, and quantity. This is read-only. Although `StartRow` and
        `EndRow` are accepted,

        they are not currently applied, so this operation is not paginated.
      operationId: ListBookInstruments
      requestBody:
        description: >-
          Required `BookName`; `StartRow` and `EndRow` are signed 32-bit
          integers that default to 0, have no declared range constraint, and
          currently have no effect.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ApiListBookInstrumentsRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ApiListBookInstrumentsRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApiListBookInstrumentsRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApiListBookInstrumentsRequest'
      responses:
        '200':
          description: >-
            Returns instrument rows, or an unsuccessful envelope when display
            information is unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiListBookInstrumentsResponse'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - oauth2: []
        - apikey: []
components:
  schemas:
    ApiListBookInstrumentsRequest:
      required:
        - $type
      type: object
      properties:
        book_name:
          type: string
          description: >-
            Organisation-scoped name of the book to select. The value must not
            be null or empty.
          nullable: true
          example: Example book
        start_row:
          type: integer
          description: >-
            Accepted starting-row value; the current listing does not use it to
            limit the returned holdings. Defaults to 0.
          format: int32
          example: 0
        end_row:
          type: integer
          description: >-
            Accepted ending-row value; the current listing does not use it to
            limit the returned holdings. Defaults to 0.
          format: int32
          example: 0
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.Book.ApiListBookInstrumentsRequest,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Book selection and accepted row-boundary values for listing its current
        instrument positions.
    ApiListBookInstrumentsResponse:
      required:
        - $type
      type: object
      properties:
        is_success:
          type: boolean
          description: >-
            Whether the operation completed successfully. The default is `true`;
            error outcomes set it to `false`.
          example: true
        error_messages:
          type: array
          items:
            type: string
          description: >-
            Messages explaining operation-level failures. The collection is
            empty by default.
          nullable: true
        instruments:
          type: array
          items:
            $ref: '#/components/schemas/BookTradeInfo'
          description: >-
            Current, non-archived instrument positions in the selected book; an
            empty collection is valid.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.Book.ApiListBookInstrumentsResponse,
              Derivitec.Web.Core
      additionalProperties: false
      description: Current instrument positions held by the selected book.
    BookTradeInfo:
      required:
        - $type
      type: object
      properties:
        id:
          type: string
          description: Risk Portal tradable identifier for the book holding.
          nullable: true
        display_name:
          type: string
          description: Client-visible label of the tradable held in the book.
          nullable: true
        quantity:
          type: number
          description: >-
            Position quantity reported for the tradable; this contract declares
            no common unit across instrument types.
          format: double
        $type:
          type: string
          enum:
            - Derivitec.Web.Core.Book.BookTradeInfo, Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Tradable identifier, display label, and position quantity for one book
        holding.
  securitySchemes:
    oauth2:
      type: oauth2
      description: >-
        OAuth2 access-token requested from AWS Cognito and provided as a Auth
        Bearer header
      flows:
        implicit:
          authorizationUrl: https://auth.riskportal.derivitec.com/oauth2/authorize
          scopes: {}
    apikey:
      type: apiKey
      description: API-Key requested via the site and provided as a header
      name: x-api-key
      in: header

````