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

Get sentiment

GET/public/v1/sentiment/{symbol}

The asset’s entry from the latest analysis run. A stale entry is returned at once with meta.stale and refreshed in the background.

PremiumAnnualLifetimeOn-demand: 202 for new symbolsModel 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/sentiment/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": {
    "sentiment": "<string>",
    "sentiment_score": "<number>",
    "confidence": "<number>"
  },
  "meta": { "timestamp": "<string>", "request_id": "<string>" }
}

Parameters#

  • symbolstringpathRequired

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

Response fields#

  • sentimentstring

    The run’s direction label.

  • sentiment_scorenumber

    Model score.

  • confidencenumber | string

    Model confidence.

  • meta.stale · meta.age_secondsboolean · integer

    Present when the entry is older than the freshness window.

The run’s reasoning and factors for the asset.

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.

  • 403WATCHLIST_LIMIT_REACHED

    Queuing a new asset would pass your plan’s tracked-asset cap.

  • 404SYMBOL_NOT_FOUND

    The ticker could not be validated.

  • 429ON_DEMAND_RATE_LIMIT

    Too many new-asset triggers in a minute.

  • 429RATE_LIMIT_EXCEEDED

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

  • 502UPSTREAM_UNAVAILABLE

    Ticker validation could not reach the market-data provider. Retry.

  • 503DATA_UNAVAILABLE

    The analysis cache is unavailable. Retry.