Skip to content
Volatility
  1. REST reference
  2. Model outputs
  3. Volatility

Get the volatility forecast

GET/public/v1/volatility/{symbol}

The session volatility forecast for an asset the forecast pipeline covers.

PremiumAnnualLifetimeNo on-demand analysisModel output · reference

Model output · reference only. This route returns TradeEasy model scores, probabilities or levels. Its fields are documented by name and type; the docs show no sample values. Educational research, not investment advice.

Request

curl "https://api.tradeeasyai.net/public/v1/volatility/XAUUSD" \
  -H "X-API-Key: $TRADEEASY_API_KEY"

Response shape · reference only

Field names and types; no sample values.

200 · application/json
{
  "success": true,
  "data": {
    "asset_forecast": { … }
  },
  "meta": { "timestamp": "<string>", "request_id": "<string>" }
}

Parameters#

  • symbolstringpathRequired

    TradeEasy symbol, for example XAUUSD or EURUSD. Up to 32 characters.

Response fields#

  • forecast_date · sessionstring

    Which forecast.

  • market_composite_score · market_levelnumber · string

    Model outputs.

  • asset_forecastobject

    The asset’s entry.

Errors#

  • 400INVALID_SYMBOL

    The symbol is empty or longer than 32 characters.

  • 401detail

    Missing, invalid or revoked key, or a locked account. FastAPI {"detail": …} body, not the envelope.

  • 403detail

    The plan does not include the REST API, or the subscription is not active.

  • 404NOT_AVAILABLE_FOR_ASSET

    The forecast does not cover the asset.

  • 429RATE_LIMIT_EXCEEDED

    Per-key minute or day bucket spent. Honour Retry-After.

  • 500FETCH_FAILED

    Unexpected read failure. Retry with backoff.