get_market_regime
Returns a current Hedgr regime snapshot for one or more currency pairs, including a compact headline, sorted snapshot rows, latest rate, realised-volatility regime, 30-day change, methodology, and dashboard surface. Volatility regimes are Settled / Directional / Choppy / Stressed. Also returns a market_environment block matching the Monitor Market Environment KPI cards when the book has exposure: the exposure-weighted Composite score (0-100), Volatility score, and 30-day Trend (change and direction). Use for market-backdrop questions. Regimes are not trade recommendations. The scores are analytical only. Also returns dashboard_market_environment (the Composite, Trend and Volatility scores, levels and the Global Backdrop score/sentiment exactly as the dashboard published them; null with a reason until the Monitor tab has published), dashboard_regimes (per-pair regime label and recent range as shown on screen), and market_environment.trend_score, adverse_currencies and trend_summary from the server engine.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pairs | No | Currency pairs to query, e.g. ['GBPEUR', 'GBPUSD', 'USDZAR']. Omit to return regimes for all pairs relevant to the user's current exposure. | |
| history_years | No | How many years of history to include when include_history is true. Defaults to 2. | |
| include_chart | No | When true, includes one or two image/png content blocks: (1) a horizontal bar chart of realised-volatility % by pair, colour-coded by regime (green=Settled, blue=Directional, amber=Choppy, red=Stressed); (2) when include_history is also true, a rate + Bollinger-band line chart for the most-stressed pair. | |
| include_history | No | Include the historical regime series (date + regime + volatility per point). Useful for charting or for the agent to describe how stable the current regime is. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | Tool-specific payload. Null when connection_status.state is 'setup_required'. | |
| connection_status | Yes |