Xtreamly
GithubSwaggerXtreamly's Metamask Snap
Xtreamly
  • 馃Overview
  • 馃USE-CASES
  • 馃殌Build with Xtreamly
  • 1. API
  • 馃捇2. Hedging As_A_Service
  • 3. Agent Workframe
    • Agent Demo
  • Github
  • Linkedin
  • Contact us- Email
Powered by GitBook
On this page

1. API

Provides the flexibility to call Xtreamly model predictions via any digital ecosystem

PreviousBuild with XtreamlyNext2. Hedging As_A_Service

Last updated 3 months ago

Traditional trading signals and execution strategies often fail to adapt to real-time volatility shifts. Xtreamly changes the game by providing AI-driven volatility intelligence that enhances trade signals, execution, and risk management, creating a competitive edge for trading firms, market makers, and quant funds.

More details on our swagger docs:

https://xtreamly.io/api

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
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
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
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
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
Responseany
get
GET / HTTP/1.1
Host: 
Accept: */*
200

Successful Response

No content

  • GETVolatility Predictions
  • GETHistorical Volatility Predictions
  • GETMarket State Predictions
  • GETHistorical Market State Predictions
  • GETHealth