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

# Depth Dashboard

> This endpoint provides the average order book depth across exchanges and currency pairs over a specified time period. To retrieve the average depth for the past 24 hours, set the hourAgo parameter to 24. The response includes depth measurements at various basis point levels from the BBO.



## OpenAPI

````yaml get /depth/dashboard
openapi: 3.1.0
info:
  title: spot-analytics
  version: '2'
servers:
  - url: https://api.amberdata.com/markets/spot/analytics
security:
  - sec0: []
paths:
  /depth/dashboard:
    get:
      summary: Depth Dashboard
      description: >-
        This endpoint provides the average order book depth across exchanges and
        currency pairs over a specified time period. To retrieve the average
        depth for the past 24 hours, set the hourAgo parameter to 24. The
        response includes depth measurements at various basis point levels from
        the BBO.
      operationId: spot-analytics-order-book-depth-dashboard
      parameters:
        - name: exchange
          in: query
          description: |-
            **[Required]** The exchange for which to retrieve liquidity depth.
            **[Examples]** ` gdax | okex | binance | binanceus`
          required: true
          schema:
            type: string
            default: gdax
        - name: pair
          in: query
          description: |-
            **[Optional]** The currency pair to retrieve liquidity depth.
            **[Examples]** ` btc_usd | btc_usdc | eth_usd `
          schema:
            type: string
        - name: hoursAgo
          in: query
          description: >-
            **[Required]** Payload only includes data going back this number of
            hours up to now.

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

            **[Examples]** `1 | 24 | 168`
          required: true
          schema:
            type: string
            default: '1'
        - 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
            default: hr
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value:
                    status: 200
                    title: OK
                    description: Successful request
                    payload:
                      data:
                        - basisPoints005Avg: 9.401234543928572
                          basisPoints005UsdMillion: 0.8362791425902734
                          basisPoints010Avg: 33.4589952475
                          basisPoints010UsdMillion: 2.977331789492856
                          basisPoints015Avg: 48.26654494428573
                          basisPoints015UsdMillion: 4.295080580089795
                          basisPoints020Avg: 60.502773086249995
                          basisPoints020UsdMillion: 5.383912833758577
                          basisPoints025Avg: 72.67447120107144
                          basisPoints025UsdMillion: 6.467176793384661
                          basisPoints050Avg: 107.73277508214282
                          basisPoints050UsdMillion: 9.586148396668023
                          basisPoints075Avg: 131.27418873642856
                          basisPoints075UsdMillion: 11.68077021486782
                          basisPoints100Avg: 149.33848501964283
                          basisPoints100UsdMillion: 13.288344480691334
                          basisPoints125Avg: 156.1712182948214
                          basisPoints125UsdMillion: 13.89561970593318
                          basisPoints150Avg: 159.06672667392849
                          basisPoints150UsdMillion: 14.152776714523336
                          basisPoints175Avg: 162.1023070374999
                          basisPoints175UsdMillion: 14.422205970560144
                          basisPoints200Avg: 163.636911395357
                          basisPoints200UsdMillion: 14.558796552896421
                          basisPoints225Avg: 168.5982969091071
                          basisPoints225UsdMillion: 15.001013535304601
                          basisPoints250Avg: 174.94764086875006
                          basisPoints250UsdMillion: 15.566209884819328
                          basisPoints275Avg: 179.26595198482138
                          basisPoints275UsdMillion: 15.950231329138596
                          basisPoints300Avg: 183.3951665717857
                          basisPoints300UsdMillion: 16.3172551153197
                          basisPoints325Avg: 188.75657228053555
                          basisPoints325UsdMillion: 16.794767513487276
                          basisPoints350Avg: 195.12496656714276
                          basisPoints350UsdMillion: 17.361693638792417
                          basisPoints375Avg: 203.70150304749993
                          basisPoints375UsdMillion: 18.125329138233376
                          basisPoints400Avg: 224.07660832410696
                          basisPoints400UsdMillion: 19.940580871428985
                          basisPoints425Avg: 245.53254425642817
                          basisPoints425UsdMillion: 21.850674019291123
                          basisPoints450Avg: 268.9725459998209
                          basisPoints450UsdMillion: 23.935951474578236
                          basisPoints475Avg: 284.06341766303456
                          basisPoints475UsdMillion: 25.277041027641026
                          basisPoints500Avg: 298.445947001427
                          basisPoints500UsdMillion: 26.556690917608318
                          exchange: gdax
                          pair: btc_usd
                          side: ask
                        - basisPoints005Avg: 10.787776116964285
                          basisPoints005UsdMillion: 0.9603206933466637
                          basisPoints010Avg: 32.997112661785714
                          basisPoints010UsdMillion: 2.9364426954190725
                          basisPoints015Avg: 47.464132261071434
                          basisPoints015UsdMillion: 4.223595252379741
                          basisPoints020Avg: 59.663405261964286
                          basisPoints020UsdMillion: 5.309160456228423
                          basisPoints025Avg: 68.76697274125
                          basisPoints025UsdMillion: 6.119256539282075
                          basisPoints050Avg: 98.74593045946428
                          basisPoints050UsdMillion: 8.78632199575771
                          basisPoints075Avg: 125.9904346496429
                          basisPoints075UsdMillion: 11.209914603176367
                          basisPoints100Avg: 152.6229010428572
                          basisPoints100UsdMillion: 13.578242795297774
                          basisPoints125Avg: 172.79567598107153
                          basisPoints125UsdMillion: 15.373685351653338
                          basisPoints150Avg: 187.33424776267861
                          basisPoints150UsdMillion: 16.667557260857322
                          basisPoints175Avg: 201.1325491351786
                          basisPoints175UsdMillion: 17.89581405996473
                          basisPoints200Avg: 213.77307337482142
                          basisPoints200UsdMillion: 19.020518676666864
                          basisPoints225Avg: 224.1634065199999
                          basisPoints225UsdMillion: 19.944477842338227
                          basisPoints250Avg: 238.76315926910706
                          basisPoints250UsdMillion: 21.24411061084825
                          basisPoints275Avg: 249.31504905392845
                          basisPoints275UsdMillion: 22.18400659751382
                          basisPoints300Avg: 256.21995993107123
                          basisPoints300UsdMillion: 22.79808261203308
                          basisPoints325Avg: 263.6064879801783
                          basisPoints325UsdMillion: 23.455003753408526
                          basisPoints350Avg: 272.6028786167854
                          basisPoints350UsdMillion: 24.255617937881052
                          basisPoints375Avg: 281.8979424932139
                          basisPoints375UsdMillion: 25.083445153214658
                          basisPoints400Avg: 288.2444660867854
                          basisPoints400UsdMillion: 25.647089540450402
                          basisPoints425Avg: 298.02978690535696
                          basisPoints425UsdMillion: 26.516905314952048
                          basisPoints450Avg: 311.6647462498213
                          basisPoints450UsdMillion: 27.729906912213323
                          basisPoints475Avg: 328.1130076466067
                          basisPoints475UsdMillion: 29.195136775790168
                          basisPoints500Avg: 334.3264517832139
                          basisPoints500UsdMillion: 29.74844577831809
                          exchange: gdax
                          pair: btc_usd
                          side: bid
                      metadata:
                        api-version: '2023-09-30'
              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:
                            basisPointsXXXAvg:
                              type: number
                              example: 9.401234543928572
                              description: >-
                                The average depth in coin (base) for xxx bps
                                from BBO
                            basisPointsXXXUsdMillion:
                              type: number
                              example: 0.8362791425902734
                              description: >-
                                The average depth in quote (often USD) for xxx
                                bps from BBO, in millions
                            exchange:
                              type: string
                              example: gdax
                              description: The subject exchange
                            pair:
                              type: string
                              example: btc_usd
                              description: The subject pair
                            side:
                              type: string
                              example: ask
                              description: The ask or bid side of the depth
                      metadata:
                        type: object
                        properties:
                          api-version:
                            type: string
                            example: '2023-09-30'
        '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

````