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

# Top Trades

> This endpoint contains all the relevant information about the most important trades both on screen and blocked. Besides the usual information this endpoint have some proprietary nuances that helps market watchers to read the flow deeply. Among the others: - "Amberdata Direction" is the metrics we developed for gauging the real initiator of a trade - "Delta Hedge" highlight is a block trade contained a futures leg - The information of the orderbook prior to the trade ("pre" columns) and post ("post" columns)




## OpenAPI

````yaml get /analytics/options-scanner/top-trades
openapi: 3.1.0
info:
  title: derivatives-api
  version: '2'
servers:
  - url: https://api.amberdata.com/markets/derivatives
security:
  - sec0: []
paths:
  /analytics/options-scanner/top-trades:
    get:
      summary: Top Trades
      description: >
        This endpoint contains all the relevant information about the most
        important trades both on screen and blocked. Besides the usual
        information this endpoint have some proprietary nuances that helps
        market watchers to read the flow deeply. Among the others: - "Amberdata
        Direction" is the metrics we developed for gauging the real initiator of
        a trade - "Delta Hedge" highlight is a block trade contained a futures
        leg - The information of the orderbook prior to the trade ("pre"
        columns) and post ("post" columns)
      operationId: derivatives-trades-flow-top-trades
      parameters:
        - name: exchange
          in: query
          description: >
            **[Required]** The exchange for which to retrieve the listed option
            level 1 quotes. **[Examples]** `deribit | okex | bybit`
          required: true
          schema:
            type: string
            default: deribit
        - name: currency
          in: query
          description: >
            **[Required]** The underlying currency for which there are listed
            option instruments. **[Examples]** `BTC | SOL_USDC` Note: inverse
            options have underlying currencies formatted as (BTC, ETH) while
            linear option currency formats include the stable coin in the same
            (SOL_USDC)
          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-05-21'
        - 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-05-22'
        - 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: Successful request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    example: 200
                    default: 0
                  title:
                    type: string
                    example: OK
                  description:
                    type: string
                    example: Successful request
                  payload:
                    type: object
                    properties:
                      data:
                        type: array
                        items:
                          type: object
                          properties:
                            exchange:
                              type: string
                              example: deribit
                            currency:
                              type: string
                              example: BTC
                            exchangeTimestamp:
                              type: integer
                              example: 1717199992528
                            indexPrice:
                              type: number
                              example: 67481.38
                            instrument:
                              type: string
                              example: BTC-7JUN24-71000-C
                            exchangeDirection:
                              type: string
                              example: buy
                            amberdataDirection:
                              type: string
                              example: sell
                            blockTradeId:
                              type: string
                              nullable: true
                              example: null
                            numberOfLegs:
                              type: integer
                              example: 0
                            tradeAmount:
                              type: number
                              example: 0.1
                            blockAmount:
                              type: number
                              nullable: true
                              example: null
                            tradeIv:
                              type: number
                              example: 43.04
                            price:
                              type: number
                              example: 0.0065
                            priceUsd:
                              type: number
                              example: 440.034985
                            openInterestChange:
                              type: number
                              example: 0
                            sizeUSD:
                              type: number
                              example: 44.003498500000006
                            sizeDelta:
                              type: number
                              example: 0.021013000000000004
                            sizeVega:
                              type: number
                              example: 2.5712
                            sizeGamma:
                              type: number
                              example: 0.000007
                            sizeTheta:
                              type: number
                              example: -8.781606
                            hedgeInstrument:
                              type: string
                              nullable: true
                              example: null
                            hedgeIsBuySide:
                              type: boolean
                              nullable: true
                              example: null
                            hedgePrice:
                              type: number
                              nullable: true
                              example: null
                            hedgeVolume:
                              type: number
                              nullable: true
                              example: null
                      metadata:
                        type: object
                        properties:
                          api-version:
                            type: string
                            example: '2023-09-30'
              examples:
                success_response:
                  summary: Top trades response
                  value:
                    status: 200
                    title: OK
                    description: Successful request
                    payload:
                      data:
                        - exchange: deribit
                          currency: BTC
                          exchangeTimestamp: 1717199992528
                          indexPrice: 67481.38
                          instrument: BTC-7JUN24-71000-C
                          exchangeDirection: buy
                          amberdataDirection: sell
                          blockTradeId: null
                          numberOfLegs: 0
                          tradeAmount: 0.1
                          blockAmount: null
                          tradeIv: 43.04
                          price: 0.0065
                          priceUsd: 440.034985
                          openInterestChange: 0
                          sizeUSD: 44.003498500000006
                          sizeDelta: 0.021013000000000004
                          sizeVega: 2.5712
                          sizeGamma: 0.000007
                          sizeTheta: -8.781606
                          hedgeInstrument: null
                          hedgeIsBuySide: null
                          hedgePrice: null
                          hedgeVolume: null
                        - exchange: deribit
                          currency: BTC
                          exchangeTimestamp: 1717199915036
                          indexPrice: 67493.38
                          instrument: BTC-7JUN24-67000-P
                          exchangeDirection: sell
                          amberdataDirection: sell
                          blockTradeId: null
                          numberOfLegs: 0
                          tradeAmount: 0.1
                          blockAmount: null
                          tradeIv: 42.71
                          price: 0.0175
                          priceUsd: 1184.8509750000003
                          openInterestChange: 0
                          sizeUSD: 118.48509750000004
                          sizeDelta: -0.041572
                          sizeVega: 3.4785719999999998
                          sizeGamma: 0.00001
                          sizeTheta: -11.875451
                          hedgeInstrument: null
                          hedgeIsBuySide: null
                          hedgePrice: null
                          hedgeVolume: null
                        - exchange: deribit
                          currency: BTC
                          exchangeTimestamp: 1717199908178
                          indexPrice: 67493.66
                          instrument: BTC-7JUN24-67000-P
                          exchangeDirection: sell
                          amberdataDirection: sell
                          blockTradeId: null
                          numberOfLegs: 0
                          tradeAmount: 0.1
                          blockAmount: null
                          tradeIv: 42.71
                          price: 0.0175
                          priceUsd: 1184.852725
                          openInterestChange: 0
                          sizeUSD: 118.48527250000001
                          sizeDelta: -0.04159
                          sizeVega: 3.478832
                          sizeGamma: 0.00001
                          sizeTheta: -11.876933000000001
                          hedgeInstrument: null
                          hedgeIsBuySide: null
                          hedgePrice: null
                          hedgeVolume: null
                      metadata:
                        api-version: '2023-09-30'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties: {}
              examples:
                error_response:
                  summary: Bad request example
                  value: {}
      deprecated: false
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````