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

# Liquidations Aggregate (Futures and Perpetuals)

> This endpoint returns the total aggregated liquidations for both futures and perpetuals for a selected time interval and exchange venue. The liquidations are split into "Buy-To-Close" and "Sell-To-Close" buckets. The endpoint is dynamic in terms of granularity. 1-day of data returns 5-min, 7-days returns hourly, 30-days returns daily.



## OpenAPI

````yaml get /analytics/futures-perpetuals/liquidations-total
openapi: 3.1.0
info:
  title: derivatives-api
  version: '2'
servers:
  - url: https://api.amberdata.com/markets/derivatives
security:
  - sec0: []
paths:
  /analytics/futures-perpetuals/liquidations-total:
    get:
      summary: Liquidations Aggregate (Futures and Perpetuals)
      description: >-
        This endpoint returns the total aggregated liquidations for both futures
        and perpetuals for a selected time interval and exchange venue. The
        liquidations are split into "Buy-To-Close" and "Sell-To-Close" buckets.
        The endpoint is dynamic in terms of granularity. 1-day of data returns
        5-min, 7-days returns hourly, 30-days returns daily.
      operationId: derivatives-futures-perpetuals-liquidations-aggregates
      parameters:
        - name: asset
          in: query
          description: >-
            **[Required]** The underlying currency for which there are futures
            contracts/instruments. 

            **[Examples]** ` BTC | ETH `
          required: true
          schema:
            type: string
            default: btc
        - name: startDate
          in: query
          description: >-
            **[Required]** Payload only includes data after this date
            (inclusive). 

            **[Formats]** `seconds | milliseconds | iso8601`

            **[Examples]** `1578531600 | 1578531600000 | 2020-09-01T01:00:00`
          required: true
          schema:
            type: string
            format: date-time
            default: '2024-11-01'
        - name: endDate
          in: query
          description: >-
            **[Required]** Payload only includes data before this date
            (exclusive). 

            **[Formats]** `seconds | milliseconds | iso8601`

            **[Examples]** `1578531600 | 1578531600000 | 2020-09-01T01:00:00`
          required: true
          schema:
            type: string
            default: '2024-11-04'
        - name: timeFormat
          in: query
          description: >-
            **[Optional]** Time format of the timestamps in the return payload.

            **[Defaults]** `milliseconds | ms* | iso | iso8601 | hr |
            human_readable`
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    example: 200
                  title:
                    type: string
                    example: OK
                  description:
                    type: string
                    example: Successful request
                  payload:
                    type: object
                    properties:
                      data:
                        type: array
                        items:
                          type: object
                          properties:
                            timestamp:
                              type: string
                              example: 2024-11-05 00:00:00 000
                              description: The timestamp for the liquidation data point
                            exchange:
                              type: string
                              example: binance
                              description: The exchange where the liquidations occurred
                            buyLiquidationsUSD:
                              type: number
                              example: 407
                              description: The total USD value of buy-to-close liquidations
                            sellLiquidationsUSD:
                              type: number
                              example: 0
                              description: >-
                                The total USD value of sell-to-close
                                liquidations
                            averagePrice:
                              type: number
                              example: 67776.44798099755
                              description: The average price during the liquidation period
              examples:
                Result:
                  value:
                    status: 200
                    title: OK
                    description: Successful request
                    payload:
                      data:
                        - timestamp: 2024-11-05 00:00:00 000
                          exchange: binance
                          buyLiquidationsUSD: 407
                          sellLiquidationsUSD: 0
                          averagePrice: 67776.44798099755
                        - timestamp: 2024-11-05 00:00:00 000
                          exchange: bitmex
                          buyLiquidationsUSD: 0
                          sellLiquidationsUSD: 0
                          averagePrice: 67776.44798099755
                        - timestamp: 2024-11-05 00:00:00 000
                          exchange: bybit
                          buyLiquidationsUSD: 407
                          sellLiquidationsUSD: 0
                          averagePrice: 67776.44798099755
                        - timestamp: 2024-11-05 00:00:00 000
                          exchange: deribit
                          buyLiquidationsUSD: 0
                          sellLiquidationsUSD: 0
                          averagePrice: 67776.44798099755
                        - timestamp: 2024-11-05 00:00:00 000
                          exchange: huobi
                          buyLiquidationsUSD: 0
                          sellLiquidationsUSD: 0
                          averagePrice: 67776.44798099755
                        - timestamp: 2024-11-05 00:00:00 000
                          exchange: okex
                          buyLiquidationsUSD: 0
                          sellLiquidationsUSD: 0
                          averagePrice: 67776.44798099755
                        - timestamp: 2024-11-04 23:45:00 000
                          exchange: binance
                          buyLiquidationsUSD: 0
                          sellLiquidationsUSD: 21654
                          averagePrice: 67618.94900542521
                        - timestamp: 2024-11-04 23:45:00 000
                          exchange: bitmex
                          buyLiquidationsUSD: 0
                          sellLiquidationsUSD: 0
                          averagePrice: 67618.94900542521
                        - timestamp: 2024-11-04 23:45:00 000
                          exchange: bybit
                          buyLiquidationsUSD: 0
                          sellLiquidationsUSD: 51032
                          averagePrice: 67618.94900542521
                        - timestamp: 2024-11-04 23:45:00 000
                          exchange: deribit
                          buyLiquidationsUSD: 0
                          sellLiquidationsUSD: 0
                          averagePrice: 67618.94900542521
                        - timestamp: 2024-11-04 23:45:00 000
                          exchange: huobi
                          buyLiquidationsUSD: 0
                          sellLiquidationsUSD: 271
                          averagePrice: 67618.94900542521
                        - timestamp: 2024-11-04 23:45:00 000
                          exchange: okex
                          buyLiquidationsUSD: 0
                          sellLiquidationsUSD: 203
                          averagePrice: 67618.94900542521
                        - timestamp: 2024-11-04 23:30:00 000
                          exchange: binance
                          buyLiquidationsUSD: 0
                          sellLiquidationsUSD: 0
                          averagePrice: 67779.18988764042
                        - timestamp: 2024-11-04 23:30:00 000
                          exchange: bitmex
                          buyLiquidationsUSD: 0
                          sellLiquidationsUSD: 0
                          averagePrice: 67779.18988764042
                        - timestamp: 2024-11-04 23:30:00 000
                          exchange: bybit
                          buyLiquidationsUSD: 0
                          sellLiquidationsUSD: 0
                          averagePrice: 67779.18988764042
                        - timestamp: 2024-11-04 23:30:00 000
                          exchange: deribit
                          buyLiquidationsUSD: 0
                          sellLiquidationsUSD: 0
                          averagePrice: 67779.18988764042
                        - timestamp: 2024-11-04 23:30:00 000
                          exchange: huobi
                          buyLiquidationsUSD: 1970
                          sellLiquidationsUSD: 0
                          averagePrice: 67779.18988764042
                        - timestamp: 2024-11-04 23:30:00 000
                          exchange: okex
                          buyLiquidationsUSD: 0
                          sellLiquidationsUSD: 0
                          averagePrice: 67779.18988764042
                        - timestamp: 2024-11-04 23:15:00 000
                          exchange: binance
                          buyLiquidationsUSD: 4954
                          sellLiquidationsUSD: 2642
                          averagePrice: 67691.32767402376
                        - timestamp: 2024-11-04 23:15:00 000
                          exchange: bitmex
                          buyLiquidationsUSD: 0
                          sellLiquidationsUSD: 0
                          averagePrice: 67691.32767402376
                        - timestamp: 2024-11-04 23:15:00 000
                          exchange: bybit
                          buyLiquidationsUSD: 0
                          sellLiquidationsUSD: 105157
                          averagePrice: 67691.32767402376
                        - timestamp: 2024-11-04 23:15:00 000
                          exchange: deribit
                          buyLiquidationsUSD: 0
                          sellLiquidationsUSD: 0
                          averagePrice: 67691.32767402376
                        - timestamp: 2024-11-04 23:15:00 000
                          exchange: huobi
                          buyLiquidationsUSD: 0
                          sellLiquidationsUSD: 7231
                          averagePrice: 67691.32767402376
                        - timestamp: 2024-11-04 23:15:00 000
                          exchange: okex
                          buyLiquidationsUSD: 0
                          sellLiquidationsUSD: 4066
                          averagePrice: 67691.32767402376
                        - timestamp: 2024-11-04 23:00:00 000
                          exchange: binance
                          buyLiquidationsUSD: 16892
                          sellLiquidationsUSD: 25162
                          averagePrice: 67779.24759519029
                        - timestamp: 2024-11-04 23:00:00 000
                          exchange: bitmex
                          buyLiquidationsUSD: 0
                          sellLiquidationsUSD: 0
                          averagePrice: 67779.24759519029
                        - timestamp: 2024-11-04 23:00:00 000
                          exchange: bybit
                          buyLiquidationsUSD: 0
                          sellLiquidationsUSD: 204
                          averagePrice: 67779.24759519029
                        - timestamp: 2024-11-04 23:00:00 000
                          exchange: deribit
                          buyLiquidationsUSD: 0
                          sellLiquidationsUSD: 0
                          averagePrice: 67779.24759519029
                        - timestamp: 2024-11-04 23:00:00 000
                          exchange: huobi
                          buyLiquidationsUSD: 0
                          sellLiquidationsUSD: 3326
                          averagePrice: 67779.24759519029
                        - timestamp: 2024-11-04 23:00:00 000
                          exchange: okex
                          buyLiquidationsUSD: 0
                          sellLiquidationsUSD: 0
                          averagePrice: 67779.24759519029
                        - timestamp: 2024-11-04 22:45:00 000
                          exchange: binance
                          buyLiquidationsUSD: 307664
                          sellLiquidationsUSD: 0
                          averagePrice: 67746.61886792466
                        - timestamp: 2024-11-04 22:45:00 000
                          exchange: bitmex
                          buyLiquidationsUSD: 2021
                          sellLiquidationsUSD: 0
                          averagePrice: 67746.61886792466
                        - timestamp: 2024-11-04 22:45:00 000
                          exchange: bybit
                          buyLiquidationsUSD: 94311
                          sellLiquidationsUSD: 0
                          averagePrice: 67746.61886792466
                        - timestamp: 2024-11-04 22:45:00 000
                          exchange: deribit
                          buyLiquidationsUSD: 0
                          sellLiquidationsUSD: 0
                          averagePrice: 67746.61886792466
                        - timestamp: 2024-11-04 22:45:00 000
                          exchange: huobi
                          buyLiquidationsUSD: 555200
                          sellLiquidationsUSD: 0
                          averagePrice: 67746.61886792466
                        - timestamp: 2024-11-04 22:45:00 000
                          exchange: okex
                          buyLiquidationsUSD: 507007
                          sellLiquidationsUSD: 0
                          averagePrice: 67746.61886792466
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: {}
              schema:
                type: object
                properties: {}
      deprecated: false
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````