HeyTraders Documentation

Macro API

Macro operations expose US FRED series, derived US macro regimes, and forecasts. Every operation requires research and completes synchronously.

Operations

MethodPathRequired scopePurpose
GET/v1/macro/series/catalogresearchList the grouped FRED series catalog with optional observations
GET/v1/macro/series/fred/{series_id}researchRead a FRED series for the requested date range
GET/v1/macro/cycleresearchRead the current macro-cycle analysis
GET/v1/macro/ratesresearchRead rates and liquidity analysis
GET/v1/macro/forecastresearchRead macro forecast analysis

Series and markets

Discover the exact FRED series ID through /v1/macro/series/catalog or reuse a known official identifier; do not pass a display label. The catalog accepts provider=FRED and include_observations=true by default, preserving the recent observation rows and count on each series. Set include_observations=false for entries containing only series_id, metadata, and quality. Group metadata, ordering, and the catalog-level count remain unchanged. Date formats and maximum ranges for individual series are defined in OpenAPI.

Analysis resources identify their market as US. Keep provider, series ID, market, observation date, and value together when joining series. A missing observation is not zero.

Macro routes synchronously call the research infrastructure. A timeout returns 504 UPSTREAM_TIMEOUT, unavailable transport returns 503 UPSTREAM_UNAVAILABLE, and an upstream or malformed result returns a 502 error. Retry idempotent reads only.