News, events and macro
Economic calendar, news, exchange announcements and the macro backdrop.
get_economic_calendar
Economic calendar (ForexFactory feed), default currencies ["USD"], order:"chronological". Requires the analytics capability (Pro and above).
Capability: analytics · read-only · REST: POST /v1/tools/get_economic_calendar
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | no | — | |
to | string | no | — | |
currencies | string[] | no | — | |
impact | LOW | MEDIUM | HIGH | no | — |
Example request:
{}get_news
Recent crypto headlines from free RSS feeds (each feed can be disabled by config), tagged by base asset, order:"newest_first". Returns headline + link + source + timestamp only — never article text — and the source must be credited when quoting. Requires the analytics capability (Pro and above).
Capability: analytics · read-only · REST: POST /v1/tools/get_news
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assets | string[] | no | — | |
hours | integer | no | 24 | |
limit | integer | no | 20 |
Example request:
{}get_exchange_announcements
The connection's exchange's own official announcements: listings, delistings, maintenance, funding-interval and contract changes, newest first, filterable by symbol and types. Bybit and OKX publish public endpoints; Binance has no verified official endpoint, so it returns missing_inputs rather than guessing. Available on every tier.
Capability: read · read-only · REST: POST /v1/tools/get_exchange_announcements
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
symbol | string | no | — | |
types | string[] | no | — | |
hours | integer | no | 168 | |
limit | integer | no | 20 |
Example request:
{}get_event_risk
Upcoming USD high/medium-impact events (CPI, FOMC, NFP, PCE, GDP...) inside the horizon with blackout windows (high: 60 min before/30 after; medium: 30/15) and a trade_advice of proceed|caution|block. Crypto symbols map to USD events; data_gap:true when the calendar is unavailable (never reported as "no events"). Requires the analytics capability (Pro and above).
Capability: analytics · read-only · REST: POST /v1/tools/get_event_risk
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
symbol | string | yes | — | Canonical ccxt symbol: BTC/USDT:USDT (perp) or BTC/USDT (spot). Aliases like BTCUSDT are accepted and the canonical symbol is echoed. |
horizon_hours | integer | no | 24 |
Example request:
{
"symbol": "BTC/USDT:USDT"
}get_event_sensitivity
How this symbol's own H1 bars reacted to past high-impact USD events: for each event category, the median range of the event hour relative to the median non-event hour (ratio) and the median absolute move, in bps. Categories with fewer than 5 events report insufficient_samples. Requires the analytics capability (Pro and above).
Capability: analytics · read-only · REST: POST /v1/tools/get_event_sensitivity
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
symbol | string | yes | — | Canonical ccxt symbol: BTC/USDT:USDT (perp) or BTC/USDT (spot). Aliases like BTCUSDT are accepted and the canonical symbol is echoed. |
days | integer | no | 60 |
Example request:
{
"symbol": "BTC/USDT:USDT"
}get_economic_surprise
USD economic surprises over the last N days: for released events with both actual and forecast, surprise = (actual − forecast)/|forecast| (capped ±100%), aggregated per category with beat/miss counts. The free calendar feed publishes actuals only after release and sometimes late: events_with_actuals is reported so a thin sample is visible, and data_gap:true when none are available. Requires the analytics capability (Pro and above).
Capability: analytics · read-only · REST: POST /v1/tools/get_economic_surprise
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
days | integer | no | 14 |
Example request:
{}get_rate_expectations
USD rate backdrop from free market data: front-month fed-funds-futures implied rate (100 − ZQ price), 13-week bill and 10-year yields, and the 10y−13w spread. Raw numbers; missing_inputs lists unavailable series. Requires the analytics capability (Pro and above).
Capability: analytics · read-only · REST: POST /v1/tools/get_rate_expectations
No parameters.
Example request:
{}get_market_context
Cross-asset backdrop: DXY, VIX, US10Y (Yahoo), BTC 24h change, BTC dominance (CoinGecko, degraded when unavailable) and a volume-weighted average funding rate across the major perps, plus a heuristic risk_tone whose rule is echoed in criteria. Requires the analytics capability (Pro and above).
Capability: analytics · read-only · REST: POST /v1/tools/get_market_context
No parameters.
Example request:
{}get_risk_regime
Composite risk-on/risk-off score in [-1,1] from z-scored VIX, DXY, gold, S&P 500 and the 10y−13w yield spread (13-week bill as the short-rate proxy), with fixed weights echoed; BTC 30d realised volatility is reported alongside (informational, not in the score). Needs at least 3 inputs, otherwise REGIME_UNAVAILABLE. Each reading is recorded for history. Requires the analytics capability (Pro and above).
Capability: analytics · read-only · REST: POST /v1/tools/get_risk_regime
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
history_days | integer | no | 0 |
Example request:
{}get_macro_data
Sections: market_sessions (fixed UTC crypto sessions asia 00-08, london 07-16, new_york 13-22 plus a weekend flag; available on every tier) and cot_report (CFTC CME bitcoin/ether futures positioning for BTC or ETH; analytics capability). Available on every tier.
Capability: read · read-only · REST: POST /v1/tools/get_macro_data
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sections | string[] | no | ["market_sessions"] | |
asset | BTC | ETH | no | "BTC" |
Example request:
{}