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

# Large Liquidation Orders



## OpenAPI

````yaml openapi.json GET /gateway/v1/market/liquidation/order
openapi: 3.1.0
info:
  title: Hermod
  version: 0.0.1
servers:
  - url: https://api.asksurf.ai
security: []
paths:
  /gateway/v1/market/liquidation/order:
    get:
      tags:
        - Market
      summary: Large Liquidation Orders
      description: >-
        Returns individual large liquidation orders above a USD threshold
        (`min_amount`, default 10000).


        **Filters:** `exchange` and `symbol`.


        For aggregate totals and long/short breakdown by exchange, use
        `/market/liquidation/exchange-list`. For historical liquidation charts,
        use `/market/liquidation/chart`.
      operationId: market-liquidation-order
      parameters:
        - description: >-
            Exchange name. Can be `Binance`, `OKX`, `Bybit`, `Bitget`,
            `Hyperliquid`, `Gate`, `HTX`, `Bitmex`, `Bitfinex`, `CoinEx`,
            `Aster`, or `Lighter`.
          explode: false
          in: query
          name: exchange
          schema:
            default: Binance
            description: >-
              Exchange name. Can be `Binance`, `OKX`, `Bybit`, `Bitget`,
              `Hyperliquid`, `Gate`, `HTX`, `Bitmex`, `Bitfinex`, `CoinEx`,
              `Aster`, or `Lighter`.
            enum:
              - Binance
              - OKX
              - Bybit
              - Bitget
              - Hyperliquid
              - Gate
              - HTX
              - Bitmex
              - Bitfinex
              - CoinEx
              - Aster
              - Lighter
            examples:
              - Binance
            type: string
        - description: Token ticker symbol like `BTC` or `ETH`
          explode: false
          in: query
          name: symbol
          schema:
            default: BTC
            description: Token ticker symbol like `BTC` or `ETH`
            examples:
              - BTC
            type: string
        - description: Minimum liquidation amount in USD
          explode: false
          in: query
          name: min_amount
          schema:
            default: '10000'
            description: Minimum liquidation amount in USD
            examples:
              - '10000'
            type: string
        - description: Filter by liquidation side. Omit to return both.
          explode: false
          in: query
          name: side
          schema:
            description: Filter by liquidation side. Omit to return both.
            enum:
              - long
              - short
            examples:
              - long
            type: string
        - description: Field to sort results by
          explode: false
          in: query
          name: sort_by
          schema:
            default: timestamp
            description: Field to sort results by
            enum:
              - usd_value
              - timestamp
              - price
            type: string
        - description: Sort order
          explode: false
          in: query
          name: order
          schema:
            default: desc
            description: Sort order
            enum:
              - asc
              - desc
            type: string
        - description: >-
            Start of time range. Accepts Unix seconds (`1704067200`) or date
            string (`2024-01-01`)
          explode: false
          in: query
          name: from
          schema:
            description: >-
              Start of time range. Accepts Unix seconds (`1704067200`) or date
              string (`2024-01-01`)
            examples:
              - '2024-01-01'
            type: string
        - description: >-
            End of time range. Accepts Unix seconds (`1706745600`) or date
            string (`2024-02-01`)
          explode: false
          in: query
          name: to
          schema:
            description: >-
              End of time range. Accepts Unix seconds (`1706745600`) or date
              string (`2024-02-01`)
            examples:
              - '2024-02-01'
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimpleListResponseLiquidationOrderItem'
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataAPIError'
          description: Error
      security:
        - AccessToken: []
components:
  schemas:
    SimpleListResponseLiquidationOrderItem:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
            - >-
              https://example.com/schemas/SimpleListResponseLiquidationOrderItem.json
          format: uri
          readOnly: true
          type: string
        data:
          items:
            $ref: '#/components/schemas/LiquidationOrderItem'
          type:
            - array
            - 'null'
        meta:
          $ref: '#/components/schemas/ObjectResponseMeta'
      required:
        - data
        - meta
      type: object
    DataAPIError:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
            - https://example.com/schemas/DataAPIError.json
          format: uri
          readOnly: true
          type: string
        error:
          $ref: '#/components/schemas/DataAPIErrorDetail'
      required:
        - error
      type: object
    LiquidationOrderItem:
      additionalProperties: false
      properties:
        base_asset:
          description: Base token symbol like `BTC`
          type: string
        exchange:
          description: Exchange name like `Binance` or `OKX`
          type: string
        price:
          description: Liquidation execution price (USD)
          format: double
          type: number
        side:
          description: 'Liquidation side: `long` or `short`'
          type: string
        symbol:
          description: Full trading pair like `BTCUSDT`
          type: string
        timestamp:
          description: Unix timestamp in seconds
          format: int64
          type: integer
        usd_value:
          description: Liquidated position size (USD)
          format: double
          type: number
      required:
        - exchange
        - symbol
        - base_asset
        - price
        - usd_value
        - side
        - timestamp
      type: object
    ObjectResponseMeta:
      additionalProperties: false
      properties:
        cached:
          description: Whether this response was served from cache
          type: boolean
        credits_used:
          description: Credits deducted for this request
          format: int64
          type: integer
      required:
        - credits_used
        - cached
      type: object
    DataAPIErrorDetail:
      additionalProperties: false
      properties:
        code:
          type: string
        message:
          type: string
      required:
        - code
        - message
      type: object

````