> ## 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.

# Liquidation Metrics

> UTC-aligned long/short liquidation totals for a bounded market time range.



## OpenAPI

````yaml /proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/liquidation-metrics
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/market/pairs/{tradingPairId}/liquidation-metrics:
    get:
      tags:
        - MarketService
        - Market
      summary: Liquidation Metrics
      description: >-
        UTC-aligned long/short liquidation totals for a bounded market time
        range.
      operationId: get_liquidation_metrics
      parameters:
        - name: tradingPairId
          in: path
          required: true
          schema:
            type: string
            default: 893d2add-2f36-4ee7-b660-893d2add2f36
          example: 893d2add-2f36-4ee7-b660-893d2add2f36
        - name: interval
          in: query
          schema:
            type: string
        - name: startTime
          in: query
          schema:
            type: integer
            minimum: 0
            maximum: 4102444800000
            format: int64
          description: Start time as Unix timestamp (milliseconds)
        - name: endTime
          in: query
          schema:
            type: integer
            minimum: 0
            maximum: 4102444800000
            format: int64
          description: End time as Unix timestamp (milliseconds)
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLiquidationMetricsResponse'
        '400':
          description: Invalid interval or out-of-bounds time range
        '404':
          description: Trading pair not found
        '500':
          description: Internal server error
components:
  schemas:
    GetLiquidationMetricsResponse:
      type: object
      properties:
        tradingPairId:
          type: string
          description: Trading pair UUID
          format: uuid
          nullable: true
        quoteAssetSymbol:
          example: USDC
          type: string
          description: Quote asset denomination for mark notionals; no USD FX conversion
          nullable: true
        interval:
          example: 5m
          type: string
          description: UTC-aligned bucket size
          nullable: true
        startTime:
          type: integer
          description: Inclusive selected range start as Unix milliseconds
          format: int64
          minimum: 0
          nullable: true
        endTime:
          type: integer
          description: Exclusive selected range end as Unix milliseconds
          format: int64
          minimum: 0
          nullable: true
        buckets:
          type: array
          items:
            $ref: '#/components/schemas/LiquidationMetricsBucket'
          description: Populated UTC-aligned buckets; intervals with no events are omitted.
          nullable: true
      description: >-
        Populated UTC-aligned buckets of long/short liquidation totals. Buckets
        with no events on either side are omitted.
    LiquidationMetricsBucket:
      type: object
      properties:
        bucketStart:
          example: 1736742000000
          type: integer
          description: UTC-aligned bucket start as Unix milliseconds
          format: int64
          minimum: 0
          nullable: true
        long:
          allOf:
            - $ref: '#/components/schemas/LiquidationSideMetrics'
          description: >-
            Long-side totals; zero-valued when the bucket has no long-side
            events
          nullable: true
        short:
          allOf:
            - $ref: '#/components/schemas/LiquidationSideMetrics'
          description: >-
            Short-side totals; zero-valued when the bucket has no short-side
            events
          nullable: true
    LiquidationSideMetrics:
      type: object
      properties:
        eventCount:
          example: 12
          type: integer
          description: >-
            Number of stored liquidation-event rows for this position side in
            the bucket; not a unique-wallet count
          format: int64
          minimum: 0
          nullable: true
        positionSize:
          example: '3.75'
          type: string
          description: Sum of event position sizes in base-asset units
          nullable: true
        markNotional:
          example: '358163.4375'
          type: string
          description: >-
            Sum of each event's positionSize multiplied by its event-time
            markPrice, in quote-asset units
          nullable: true

````

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