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

# Get apiv1positions risk



## OpenAPI

````yaml /proto-openapi/api/openapi.yaml get /api/v1/positions/{positionId}/risk
openapi: 3.0.3
info:
  title: Monaco Protocol API
  description: REST API for the Monaco Protocol hybrid CLOB exchange.
  version: 1.0.0
servers:
  - url: https://staging.apimonaco.xyz
    description: Staging server (Testnet)
security: []
tags:
  - name: AccountsService
  - name: ApplicationsService
  - name: AuthService
  - name: BuildercodeRewardsService
  - name: CopyTradingService
  - name: DelegatedAgentsService
  - name: FaucetService
  - name: FeesService
  - name: HealthService
  - name: ManagedMarketsService
    description: |-
      Wallet-authenticated maker assignments. The signed session must match both
       configured maker user and application. Owner IDs are process fences, never auth.
       Only wallet sessions are supported; delegated-agent sessions receive 403.
  - name: MarginAccountsService
    description: |-
      Current public isolated-margin semantics:
       - a user has one parent margin account per application scope
       - opening orders create or reuse isolated position buckets under that parent
       - parent account creation is handled internally by margin workflows
  - name: MarketService
  - name: OrderbookService
  - name: OrdersService
  - name: PositionsService
    description: |-
      Current public isolated-margin semantics:
       - positions link to a parent margin account and, when applicable, a bucket id
       - opening orders create or reuse isolated position buckets under the parent
       - users can open another isolated position by reusing the parent account with a different market bucket
  - name: PulseService
  - name: SweeperService
  - name: TraderCodeService
  - name: TradesService
  - name: WhitelistService
  - name: WithdrawalsService
paths:
  /api/v1/positions/{positionId}/risk:
    get:
      tags:
        - PositionsService
      operationId: get_position_risk
      parameters:
        - name: positionId
          in: path
          required: true
          schema:
            type: string
            default: 2b1a5f9c-0000-4000-8000-000000000002
          example: 2b1a5f9c-0000-4000-8000-000000000002
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPositionRiskResponse'
        '429':
          description: >-
            Read rate limit exceeded — every authenticated read draws one
            request from the account's read budget; retry after the interval in
            details.retryAfter
      security:
        - monacoSignature: []
        - monacoHttpSignature: []
components:
  schemas:
    GetPositionRiskResponse:
      type: object
      properties:
        positionId:
          type: string
          nullable: true
        markPrice:
          type: string
          nullable: true
        indexPrice:
          type: string
          nullable: true
        unrealizedPnl:
          type: string
          nullable: true
        liquidationPrice:
          type: string
          description: |-
            Liquidation mark-price threshold. In ISOLATED mode, this is the
             position/risk-bucket threshold. In CROSS mode, it is conditional: it varies
             only this position's mark while all other marks in the cross risk bucket
             remain unchanged. Other position marks, funding, realized PnL,
             fees/reserves, and collateral can change it. Treat an absent or blank value
             as unavailable, never as zero.
          nullable: true
        marginRatio:
          type: string
          description: >-
            Account distress ratio: maintenance margin required divided by
            equity
             (higher is closer to liquidation). Equity that is zero or negative has no
             meaningful quotient, so an account that still owes a maintenance requirement
             reports the maximum-decimal sentinel (79228162514264337593543950335,
             maximal distress) rather than zero or a negative value, and an account with
             no open maintenance requirement reports zero. Clamp the sentinel before
             display.
          nullable: true
        maintenanceMarginRequired:
          type: string
          description: |-
            Maintenance margin required by this position at mark_price using the
             market maintenance-margin rate. Zero when the position has no open exposure.
          nullable: true
        initialMarginRequired:
          type: string
          description: >-
            Initial margin required by this position at mark_price, honoring
            both its
             effective leverage and the market initial-margin floor. Zero when the
             position has no open exposure.
          nullable: true
        updatedAt:
          type: string
          description: |-
            RFC 3339 instant at which this position was last MUTATED — a fill,
             collateral transfer, funding settlement or close — as the producer that
             owns the position recorded it. It is NOT the instant the response was
             built: polling an unchanged position returns the same value, and an oracle
             reprice does not move it. For an OPEN position every surface reports the
             same instant — the list, the detail read, the risk read, the WebSocket
             positions snapshot, and the live position_update frames.

             A TERMINAL row carries the instant the matching engine emitted the
             close, which can differ slightly from the close instant on the live
             position_update frame; older terminal rows may instead carry the
             persistence clock, trailing the close by the persistence lag. Any
             position read after a matching-engine restart also comes from the
             persistence clock and differs from the matching engine's by that lag.
             Accurate to that lag, not to the microsecond.

             A third case is not lag-bounded: an OPEN row read while the matching
             engine is unreachable falls back to the row's own lifecycle columns
             (close, then last funding, then open), so a position filled repeatedly
             since it opened reports its opening instant until funding settles. The
             live position_update frame is unaffected.

             Display metadata. `version` is the reconciliation key; ordering position
             state by this field is never correct.
          nullable: true
  securitySchemes:
    monacoSignature:
      type: apiKey
      description: >-
        Ed25519 session-key request signing. Every authenticated request carries
        three headers: `X-Monaco-PublicKey` (64-char lowercase-hex session
        public key), `X-Monaco-Timestamp` (Unix milliseconds, within 30s of
        server time), and `X-Monaco-Signature` (hex ed25519 signature). The
        signature is over `METHOD\npath?query\ntimestamp_ms\nSHA256_hex(body)`,
        where the body hash is the SHA-256 of the empty byte string when there
        is no body. Obtain the session keypair from `POST
        /api/v1/auth/challenge` followed by `POST /api/v1/auth/verify`.
      name: X-Monaco-Signature
      in: header
    monacoHttpSignature:
      type: apiKey
      description: >-
        RFC 9421 Ed25519 session-key request signatures. Send Signature-Input,
        Signature, and Content-Digest together; never combine them with
        X-Monaco-* credentials. The monaco signature covers @method, @path,
        @query, and content-digest in that order, with created (Unix seconds
        within 30s of server time), keyid (registered lowercase-hex session
        public key), and alg=ed25519 parameters. Content-Digest uses RFC 9530
        sha-256 over the exact body bytes, including the empty body. Query
        coverage retains ordering and percent encoding. Timestamp freshness does
        not reject repeated identical requests; use endpoint idempotency where
        supported. Existing legacy signing remains supported during server-first
        migration; SDK RFC 9421 signing is opt-in. See
        https://docs.0xmonaco.com/reference/http-message-signatures for the
        complete profile and trust model.
      name: Signature
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.