GET
/
analytics
/
volatility
/
term-structures
/
richness
Term Structures Richness
curl --request GET \
  --url https://api.amberdata.com/markets/derivatives/analytics/volatility/term-structures/richness \
  --header 'x-api-key: <api-key>'
{
  "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"
    }
  }
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
exchange
string
default:deribit
required

[Required] The exchange for which to retrieve the listed option level 1 quotes. [Examples] deribit | okex | bybit

​
currency
string
default:BTC
required

[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)

​
startDate
string<date-time>
default:2024-01-01

[Optional] Payload only includes data after this date (inclusive). [Formats] seconds | milliseconds | iso8601 [Examples] 1578531600 | 1578531600000 | 2020-09-01T01:00:00

​
endDate
string
default:2024-06-01

[Optional] Payload only includes data before this date (exclusive). [Formats] seconds | milliseconds | iso8601 [Examples] 1578531600 | 1578531600000 | 2020-09-01T01:00:00

​
timeFormat
string

[Optional] Time format of the timestamps in the return payload. [Defaults] milliseconds | ms* | iso | iso8601 | hr | human_readable

​
timeInterval
string<date-time>

[Optional] Time interval of data frequency for the selected date range. [Examples] hour | day

Response

200
application/json

200

The response is of type object.