API Swagger

https://github.com/Xtreamly-Team/xtreamly-acp-agent/

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

horizonall ofOptional

The prediction horizon for the volatility prediction

Default: 1min

string · enumOptionalPossible values:

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/volatility_prediction

HTTPcURLJavaScriptPython

GET /volatility_prediction HTTP/1.1
Host: 
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

horizonall ofOptional

The prediction horizon for the volatility prediction

Default: 1min

string · enumOptionalPossible values:

start_dateany ofOptional

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

integerOptional

or

nullOptional

end_dateany ofOptional

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

integerOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/volatility_historical

HTTPcURLJavaScriptPython

GET /volatility_historical HTTP/1.1
Host: 
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

422

Validation Error

application/json

get

/state_recognize

HTTPcURLJavaScriptPython

GET /state_recognize HTTP/1.1
Host: 
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_dateany ofOptional

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

integerOptional

or

nullOptional

end_dateany ofOptional

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

integerOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/state_historical

HTTPcURLJavaScriptPython

GET /state_historical HTTP/1.1
Host: 
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

get

/

HTTPcURLJavaScriptPython

GET / HTTP/1.1
Host: 
Accept: */*

200

Successful Response

No content