For the complete documentation index, see llms.txt. This page is also available as Markdown.

API Swagger

Volatility Predictions

get

Returns current predicted volatility for 1-minute and 60-minute horizons.

Query parameters
symbolstringOptional

The token to predict volatility for, e.g. 'ETH'

Default: ETH
horizonstring · enumOptionalPossible values:
Responses
200

Successful Response

application/json
timestampintegerOptional

The UTC timestamp (in milliseconds) indicating when the prediction was made.

Default: 1738604596657
timestamp_strstring · date-timeOptional

The UTC timestamp indicating when the prediction was made.

Default: 2025-02-03T17:43:16.657871Z
volatilitynumberOptional

The predicted volatility.

Default: 0.0003897691785823554
get/volatility_prediction
GET /volatility_prediction HTTP/1.1
Accept: */*
{
  "timestamp": 1738604596657,
  "timestamp_str": "2025-02-03T17:43:16.657871Z",
  "volatility": 0.0003897691785823554
}

Historical Volatility Predictions

get

Returns historical predicted volatility for 1-minute and 60-minute horizons.

Query parameters
symbolstringOptional

The token to predict volatility for, e.g. 'ETH'

Default: ETH
horizonstring · enumOptionalPossible values:
start_dateinteger · nullableOptional

Start date in milliseconds (1738167569855) for filtering historical volatility prediction data

end_dateinteger · nullableOptional

End date in milliseconds (1738171094977) for filtering historical volatility prediction data

Responses
200

Successful Response

application/json
timestampintegerOptional

The UTC timestamp (in milliseconds) indicating when the prediction was made.

Default: 1738604596657
timestamp_strstring · date-timeOptional

The UTC timestamp indicating when the prediction was made.

Default: 2025-02-03T17:43:16.657871Z
volatilitynumberOptional

The predicted volatility.

Default: 0.0003897691785823554
get/volatility_historical
GET /volatility_historical HTTP/1.1
Accept: */*
[
  {
    "timestamp": 1738604596657,
    "timestamp_str": "2025-02-03T17:43:16.657871Z",
    "volatility": 0.0003897691785823554
  }
]

Market State Predictions

get

Provides the current market classification (high, medium, low).

Query parameters
symbolstringOptional

The token to predict volatility for, e.g. 'ETH'

Default: ETH
Responses
200

Successful Response

application/json
timestampintegerOptional

The UTC timestamp (in milliseconds) indicating when the prediction was made.

Default: 1738604596657
timestamp_strstring · date-timeOptional

The UTC timestamp indicating when the prediction was made.

Default: 2025-02-03T17:43:16.657871Z
classificationstringOptional

The volatility status of the market.

Default: highvol
classification_descriptionstringOptional

A detailed description of the volatility status of the market.

Default: ETH price in highly volatile short momentum, requiring protective measures and caution.
get/state_recognize
GET /state_recognize HTTP/1.1
Accept: */*
{
  "timestamp": 1738604596657,
  "timestamp_str": "2025-02-03T17:43:16.657871Z",
  "classification": "highvol",
  "classification_description": "ETH price in highly volatile short momentum, requiring protective measures and caution."
}

Historical Market State Predictions

get

Provides the historical market classification (high, medium, low

Query parameters
symbolstringOptional

The token to predict volatility for, e.g. 'ETH'

Default: ETH
start_dateinteger · nullableOptional

Start date in milliseconds (1738167569855) for filtering historical volatility prediction data

end_dateinteger · nullableOptional

End date in milliseconds (1738171094977) for filtering historical volatility prediction data

Responses
200

Successful Response

application/json
timestampintegerOptional

The UTC timestamp (in milliseconds) indicating when the prediction was made.

Default: 1738604596657
timestamp_strstring · date-timeOptional

The UTC timestamp indicating when the prediction was made.

Default: 2025-02-03T17:43:16.657871Z
classificationstringOptional

The volatility status of the market.

Default: highvol
classification_descriptionstringOptional

A detailed description of the volatility status of the market.

Default: ETH price in highly volatile short momentum, requiring protective measures and caution.
get/state_historical
GET /state_historical HTTP/1.1
Accept: */*
[
  {
    "timestamp": 1738604596657,
    "timestamp_str": "2025-02-03T17:43:16.657871Z",
    "classification": "highvol",
    "classification_description": "ETH price in highly volatile short momentum, requiring protective measures and caution."
  }
]

Health

get
Responses
200

Successful Response

application/json
anyOptional
get/
GET / HTTP/1.1
Accept: */*
200

Successful Response

No content

Last updated