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

# Get Positions

> Retrieve your open positions.



## OpenAPI

````yaml GET /v1/account/positions
openapi: 3.1.0
info:
  title: Options API
  version: 1.0.0
  description: >-
    REST endpoints for Rails Options. Base URLs vary by environment — see the
    Environments page. Authorize with the access token obtained from the Auth
    API.
servers:
  - url: https://api-options.sandbox.rails.xyz
security:
  - bearerAuth: []
paths:
  /v1/account/positions:
    get:
      summary: Get Positions
      description: Returns your open options positions.
      operationId: getOptionsPositions
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  positions:
                    type: array
                    items:
                      type: object
                      properties:
                        contract:
                          type: string
                          description: Contract name.
                        side:
                          type: string
                          description: '`long` or `short`.'
                        optionType:
                          type: string
                          enum:
                            - C
                            - P
                          description: '`C` (call) or `P` (put), matching the contract name.'
                        qty:
                          type: string
                          description: >-
                            Signed position quantity — negative for short
                            positions. `side` carries the same direction.
                        value:
                          type: string
                          description: >-
                            Position value at entry, signed (negative for short
                            positions).
                        entryPrice:
                          type: string
                          description: Average entry price.
                        markPrice:
                          type: string
                          description: Current mark price.
                        markIV:
                          type: string
                          description: Mark implied volatility.
                        underlyingPrice:
                          type: string
                          description: Underlying index price.
                        liqPrice:
                          type: string
                          description: Always `--`.
                        breakEvenPrice:
                          type: string
                          description: >-
                            Underlying price at expiry where the position's PnL
                            is zero, net of the premium and opening fees.
                        initialMargin:
                          type: string
                          description: >-
                            Initial margin for short positions; `--` for long
                            positions.
                        realizedPnl:
                          type: string
                          description: Realized PnL.
                        unrealizedPnl:
                          type: string
                          description: >-
                            Unrealized PnL, signed; `0` when the mark price is
                            unavailable.
                        notionalValue:
                          type: string
                          description: >-
                            Notional value of the position, signed (negative for
                            short positions); `0` when the mark price is
                            unavailable.
              example:
                positions:
                  - contract: BTC-3JUL26-62000-C
                    side: long
                    optionType: C
                    qty: '2'
                    value: '240'
                    entryPrice: '120'
                    markPrice: '149.16'
                    markIV: '0.3035'
                    underlyingPrice: '61650'
                    liqPrice: '--'
                    breakEvenPrice: '62120'
                    initialMargin: '--'
                    realizedPnl: '0'
                    unrealizedPnl: '58.32'
                    notionalValue: '298.32'
                  - contract: BTC-3JUL26-60000-P
                    side: short
                    optionType: P
                    qty: '-3'
                    value: '-45'
                    entryPrice: '15'
                    markPrice: '12.19'
                    markIV: '0.3925'
                    underlyingPrice: '61650'
                    liqPrice: '--'
                    breakEvenPrice: '59985'
                    initialMargin: '22829.07'
                    realizedPnl: '0'
                    unrealizedPnl: '8.43'
                    notionalValue: '-36.57'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````