- Search for an indicator key.
- Fetch compact observations or the country high-signal pack.
- Check released history and upcoming calendar events.
- Add forecasts and the current macro regime.
- Use a compact country report when an agent needs one dense rollup.
- Check macro status before citing freshness-sensitive conclusions.
- Use scenario and sensitivity endpoints when macro needs to connect to factors or portfolios.
requestId and traceparent. Preserve freshness, provenance, methodology, source-rights, and degraded-state fields when they are present.
Workflow Quickstart
1. Search Indicators
indicatorKey in later calls. For example, US CPI is available as CPIAUCSL.
2. Fetch A Compact Country Pack
/v1/macro/high-signal-pack defaults to country=US and response_mode=compact. The compact shape is designed for agents: bounded series summaries, latest value, upcoming release, forecast, regime, and source posture.
Expand only when needed:
3. Fetch Observations
| Parameter | Required | Default | Notes |
|---|---|---|---|
indicator | Yes | — | Alias: indicator_key |
country | No | US | ISO country code |
limit | No | route default | Max 240 |
response_mode | No | standard | compact, standard, verbose, or agent |
include | No | — | Comma-separated expansions such as trust or series |
4. Separate Released History From Upcoming Calendar
Released history:/v1/macro/calendar returns future scheduled releases only. Past rows belong in /v1/macro/releases?status=released.
5. Add Forecasts And Regime
6. Check Macro Status
/v1/macro/status is artifact-backed when runtime validation artifacts are packaged with the API. If those artifacts are missing or unusable, the route returns an explicit degraded runtime_registry_fallback response instead of probing vendors live. Use it when an agent needs to decide whether macro output is ready, degraded, stale, or unsupported.
The compact response includes country status, source posture, alerts, freshness age, statusSource, artifactGeneratedAt, computedAt, and methodology. Agents should treat statusSource: "runtime_registry_fallback" as a caution flag: cite the degraded status, avoid freshness-sensitive claims, and retry later or ask for confirmation from a human teammate. Use response_mode=verbose or view=full only when you need indicator-level rows.
7. Use Country Report For A Dense Investment Briefing
briefing block.
The briefing block includes:
topLineregimekeyDriverswatchItemsinvestmentImplicationsdataQuality
| Field | Type | Notes |
|---|---|---|
symbols | string array | Adds a lightweight company lens |
holdings | holding array | Adds portfolio lens using the same holding shape as portfolio endpoints |
horizon | enum | 1m, 3m, 6m, 12m, or 18m |
briefingMode | enum | macro, portfolio, or company |
8. Connect Macro To Portfolio And Factor Workflows
List supported stress scenarios:/v1/factors/macro-sensitivity is labeled macro_factor_sensitivity_v1_heuristic. It combines scenario shock maps with current macro-regime factor impacts. It is explainable and fast; it is not a point-in-time empirical regression.
9. One-Call Country Overview
When an agent wants the whole country picture in a single request — headline indicators with latest/previous/change/direction and next release, the current regime, upcoming releases, and the sovereign credit rating — use the overview endpoint:/v1/macro/overview defaults to country=US. It is the fastest way to orient on an economy before drilling into indicators, releases, or forecasts.
10. Bulk Observation Export
For research or backfill, pull a filterable page of raw observations across countries and indicators:/v1/macro/all is cursor-paginated (follow nextCursor) and accepts country (single or comma-separated), indicator_type, indicator, frequency, date_from, date_to, and limit (max 1000). Pass format=csv for an attachment; oversized exports are materialized asynchronously and returned as an export job whose signed download URL arrives via the export.completed webhook event.
11. Company Macro Exposure
Cross a single company’s geographic revenue segments with the country macro plane to get revenue-weighted macro sensitivities:ticker (alias symbol) or cik is required. The response carries per-indicator beta, direction, confidence, and a coverage percentage that degrades gracefully when revenue segments are unavailable. Use period=quarterly to source the geographic segments from the latest quarterly rather than annual reporting, and country to set the domestic macro plane used for unmapped revenue (defaults to US).
Supported Country Coverage
| Ring | Countries | Posture |
|---|---|---|
| Launch ring | US, CN, JP, TW, IL | Curated official-source coverage, deepest launch validation |
| Expansion ring | CA, GB, EZ, KR, BR, IN, SA | Smaller high-signal packs, explicit source/fallback posture |
MCP Tools
Hosted MCP exposes the same workflow for agents:macro.searchmacro.indicatorsmacro.high_signal_packmacro.releasesmacro.calendarmacro.forecastsmacro.regimesmacro.statusmacro.credit_ratingsmacro.country_reportmacro.investment_briefingportfolio.stress_scenariosfactors.macro_sensitivity
macro.investment_briefing, set params.content_mode: "minimal" on tools/call so the agent receives full structuredContent without a duplicate text payload. Ask for response_mode: "standard" or include ["series", "trust"] only when the agent needs full nested data.
Failure Posture
- Treat non-2xx responses as contract-aware failures, not free-form errors.
- Search first when an indicator key is unknown.
- Preserve
requestIdandtraceparentin downstream artifacts. - Cite freshness and source posture when macro data informs an investment claim.

