Skip to content
Trade briefs
  1. REST reference
  2. Model outputs
  3. Trade briefs

Get a trade brief

GET/public/v1/briefs/{symbol}

One asset’s brief from the latest run.

PremiumAnnualLifetimeModel 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/briefs/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": {
    "key_drivers": "<array>",
    "brief": "<string>"
  },
  "meta": { "timestamp": "<string>", "request_id": "<string>" }
}

Parameters#

  • symbolstringpathRequired

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

Response fields#

  • sentiment · sentiment_scorestring · number

    Model outputs.

  • key_driversarray

    What the brief rests on.

  • briefstring

    The written brief.

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.

  • 404SYMBOL_NOT_FOUND

    The asset is not in the latest run.

  • 429RATE_LIMIT_EXCEEDED

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

  • 503DATA_UNAVAILABLE

    The analysis cache is unavailable. Retry.