Wealthnow
Sign up

API ReferenceMacro, Rates & FX

Status

Cross-asset snapshot

GET/api/v3/intel/macro_snapshot
Price
2 credits per call
MCP tool
intel_macro_snapshot

NOW WITH a credit block: CDX IG/HY on-the-run 5Y composite spreads + 1-session delta (T-2 by source, cadence-aware staleness; full series at /api/v3/credit/indices). Cross-asset macro composite returning REAL underlying values, all real-time where the data source permits. Fields: vix (real-time spot), ten_year_yield_pct (10-year Treasury par yield, %, from the Treasury's same-day curve; its 1-day move is change_1d_bps, in basis points; the indicator carries as_of, source and business days behind the latest official curve), usd_index_narrow_dxy (computed from live spot quotes of the six pairs via the standard geometric weighted formula — the institutional standard ~99), usd_index_trade_weighted_broad (FRED DTWEXBGS — Fed's broader policy measure ~118), wti_oil_usd_bbl (front-month WTI futures, $/bbl — the contract intel_commodities serves, named in contract; the dated physical spot is in physical_spot), gold_usd_oz (live spot quote, $/oz, stamped with the quote time), sp500 (real-time index; SPY×10 emergency fallback), nasdaq100 (real-time index; QQQ×41 emergency fallback), djia (real-time index; null when unavailable — no ETF proxy emitted), russell2000 (real-time index; IWM×10 emergency fallback). Every numeric field is gated by a plausibility guard — out-of-band values are nulled with an error.implausible_value field rather than served, so a wrong number is never served. Includes vol_regime (low_vol/normal/elevated/stress per VIX bucket), data_freshness timestamp, and a sources block with the series reference for each indicator. nowcasts fields carry reference_period (the quarter/week/day described) apart from as_of (the print). The credit delta compares one CDX series and version only; across a roll it is null with delta_reason 'index_roll' and a roll block. releases: latest official CPI, PCE, unemployment, payrolls, GDP growth and fed funds, each with reference_period, released date and 1m/12m changes. 60s cache.

Parameters

Query

freshnessstringOptional

Freshness policy. 'off' serves with an age footnote; 'live'/'strict' return 503 data_stale rather than serve stale data.

One ofofflivestrict
Defaultoff

Response

A 200 is a JSON envelope: ok: true and this endpoint's own fields (see Macro, Rates & FX). It carries X-Request-ID, the credit headers (X-Credits-Cost, X-Credits-Remaining, X-Credits-Receipt, X-Credits-Settlement) and the rate-limit headers.

A 200 is billed even when it holds no data (an empty list, null, found: false), so check those fields. Pricing & credits explains the credit headers.

Errors

No error is billed. The body is { "ok": false, "error", "detail", "request_id" }; read the code from error.

ErrorMeaning
400 invalid_tickerThe request is malformed, for example a ticker that is not a symbol: invalid_ticker, refused before any credit is reserved, with param naming the parameter. Not billed.
401 unauthorizedMissing or invalid API key.
402 plan_requiredYour plan does not include this tool, you are out of credits, or your workspace's spend cap paused its keys. plan_required names the plan that unlocks the tool; usage_exceeded means the credit balance is spent; spend_cap_reached means the key is paused until the cap resets or is raised: detail names the cap and the reset, cap_usd and resets_at (ISO 8601) carry them, and doc_url links pricing and credits. Not billed.
403 scope_deniedThis API key is limited to some products and this tool is not one of them. product names the tool's product and scopes the key's products. An upgrade does not change it: use a key whose scopes include the product, or change this key's scopes. Not billed.
404 not_foundNo such resource. Not billed.
422 validationA parameter is missing, out of range or the wrong type; param names it. Not billed.
429 rate_limitedYour plan's rate limit is spent for this window. Retry after Retry-After seconds. Not billed.
503 paid_data_unavailableThe data could not be served completely right now; retry later. Not billed.
504 request_timeoutThe request ran past the server's time budget; retry. Not billed.

This table lists what the spec declares for this route. Error responses lists every code FIRM sends, with when to retry.

Guides

Read the Macro, Rates & FX guide for this endpoint's fields and examples.