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

# Term Structures Richness

> This endpoint returns the term structure richness. The "Term Structure Richness" is the relative "level" of the Contango or Backwardation shape. A reading of 1.00 would be a perfectly flat term structure - as measured by our method - while readings below/above represent Contango/Backwardation respectively. Using the term structure levels enables us to quantify how extended the term structure pricing currently is, at any point in time. The calculation take a ratio of 7-day ATM IV versus, 30-day, 60-day. 90-day and 180-days.



## OpenAPI

````yaml get /analytics/volatility/term-structures/richness
openapi: 3.1.0
info:
  title: derivatives-api
  version: '2'
servers:
  - url: https://api.amberdata.com/markets/derivatives
security:
  - sec0: []
paths:
  /analytics/volatility/term-structures/richness:
    get:
      summary: Term Structures Richness
      description: >-
        This endpoint returns the term structure richness. The "Term Structure
        Richness" is the relative "level" of the Contango or Backwardation
        shape. A reading of 1.00 would be a perfectly flat term structure - as
        measured by our method - while readings below/above represent
        Contango/Backwardation respectively. Using the term structure levels
        enables us to quantify how extended the term structure pricing currently
        is, at any point in time. The calculation take a ratio of 7-day ATM IV
        versus, 30-day, 60-day. 90-day and 180-days.
      operationId: derivatives-volatility-term-structures-richness
      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: >-
            **[Optional]** Payload only includes data after this date
            (inclusive). 

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

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

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

            **[Examples]** `1578531600 | 1578531600000 | 2020-09-01T01:00:00`
          schema:
            type: string
            default: '2024-06-01'
        - 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
        - name: timeInterval
          in: query
          description: >
            **[Optional]** Time interval of data frequency for the selected date
            range. 

            **[Examples]**  `hour | day` 
          schema:
            type: string
            format: date-time
      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: '2019-05-22T00:00:00.000Z'
                              description: The timestamp of the data
                            exchange:
                              type: string
                              example: deribit
                              description: The exchange where the data is from
                            currency:
                              type: string
                              example: BTC
                              description: The underlying currency
                            atm7days:
                              type: number
                              example: 91.25547790527344
                              description: At The Money volatility for 7-day options
                            atm30days:
                              type: number
                              example: 92.43169403076172
                              description: At The Money volatility for 7-day options
                            atm60days:
                              type: number
                              example: 91.62701416015625
                              description: At The Money volatility for 60-day options
                            atm90days:
                              type: number
                              example: 89.92632293701172
                              description: At The Money volatility for 90-day options
                            atm180days:
                              type: number
                              example: 85.50126647949219
                              description: At The Money volatility for 180-day options
                            ratio:
                              type: number
                              example: 10.325310347771273
                              description: The ratio used in the richness calculation
                            counter:
                              type: integer
                              example: 10
                              description: >-
                                The counter value used in the richness
                                calculation
                            richness:
                              type: number
                              example: 1.0325310347771273
                              description: >-
                                The term structure richness value (1.00 = flat,
                                <1 = contango, >1 = backwardation)
              examples:
                Result:
                  value:
                    status: 200
                    title: OK
                    description: Successful request
                    payload:
                      data:
                        - timestamp: '2019-05-22T00:00:00.000Z'
                          exchange: deribit
                          currency: BTC
                          atm7days: 91.25547790527344
                          atm30days: 92.43169403076172
                          atm60days: 91.62701416015625
                          atm90days: 89.92632293701172
                          atm180days: 85.50126647949219
                          ratio: 10.325310347771273
                          counter: 10
                          richness: 1.0325310347771273
                      metadata:
                        api-version: '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

````