- REST reference
- Model outputs
- Market regime
Get the market regime
GET/public/v1/market-regime
The current US risk environment from the latest analysis run.
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/market-regime" \
-H "X-API-Key: $TRADEEASY_API_KEY"Response shape · reference only
Field names and types; no sample values.
{
"success": true,
"data": {
"status": "<string>",
"risk_score": "<number>",
"confidence": "<string>"
},
"meta": { "timestamp": "<string>", "request_id": "<string>" }
}Parameters#
No parameters.
Response fields#
- statusstring
Regime classification.
- risk_scorenumber
Model score.
- confidencestring
Model confidence.
- reasoning · key_factorsstring · array
Why.
Errors#
- 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.
- 429RATE_LIMIT_EXCEEDED
Per-key minute or day bucket spent. Honour Retry-After.
- 503DATA_UNAVAILABLE
No regime data is available. Retry.
