---
title: "Subscribe to real-time announcement events (SSE)"
method: GET
path: "/v1/stream/events"
tags: ["announcements"]
---

# Subscribe to real-time announcement events (SSE)

`GET /v1/stream/events`

## Request

- Base URL: `https://api.fxmacrodata.com`
- URL: `https://api.fxmacrodata.com/v1/stream/events`
- Auth: one of:
  - none
  - API key in header `X-API-Key`
  - HTTP bearer

Opens a long-lived Server-Sent Events (SSE) stream.  A new event is pushed to all connected clients whenever FXMacroData captures a new economic data release.

The stream payload contains event metadata and a single `latest_announcement` datapoint (`date`, `val`, `announcement_datetime`) when available.  It does not include the full time-series; fetch complete history from the matching announcements endpoint after receiving an event.

**Authentication:** Live SSE delivery requires an active FXMacroData trial or subscription API key supplied via the ``api_key`` query parameter or the ``X-API-Key`` header.

**Reconnection:** Pass the ``Last-Event-ID`` header (the ``event_id`` of the last received event) to replay buffered events on reconnect.

**Filtering:** Use ``currencies`` and ``indicators`` to narrow the stream.  Omit either parameter to receive all live events included in your subscription.

**Payloads:** ``payload=compact`` is the default.  ``payload=full`` adds the latest announcement row fields directly to each event.

## Query parameters

- `currencies` string, nullable: Comma-separated currency codes to subscribe to, e.g. ``usd,eur``. Omit to receive all live events included in your subscription.
- `indicators` 'afe_dollar_index' | 'average_hourly_earnings' | 'average_hourly_earnings_mom' | 'balance_on_goods' | 'balance_on_services' | 'bgcr' | 'breakeven_inflation_rate' | 'broad_dollar_index' | 'broad_money' | 'building_approvals' | 'building_permits' | 'business_confidence' | 'capital_account_balance' | 'cb_assets' | 'commodity_price_energy' | 'commodity_price_ex_energy' | 'commodity_price_index' | 'commodity_prices' | 'consumer_confidence' | 'core_inflation' | 'core_inflation_median' | 'core_inflation_mom' | 'core_inflation_trim' | 'core_pce' | 'core_pce_mom' | 'credit_growth' | 'crude_oil_inventories' | 'current_account_balance' | 'dairy_exports' | 'deposit_rates' | 'durable_goods_orders' | 'effr' | 'eme_dollar_index' | 'employment' | 'exports' | 'financial_account_balance' | 'foreign_reserves' | 'full_time_employment' | 'fx_reserves' | 'gdp' | 'gdp_growth_q4_yoy' | 'gold_reserves' | 'gov_bond_10y' | 'gov_bond_15y' | 'gov_bond_1_5m' | 'gov_bond_1m' | 'gov_bond_1y' | 'gov_bond_20y' | 'gov_bond_25y' | 'gov_bond_2m' | 'gov_bond_2y' | 'gov_bond_30y' | 'gov_bond_3m' | 'gov_bond_3y' | 'gov_bond_40y' | 'gov_bond_4m' | 'gov_bond_4y' | 'gov_bond_5y' | 'gov_bond_6m' | 'gov_bond_6y' | 'gov_bond_7y' | 'gov_bond_8y' | 'gov_bond_9y' | 'government_debt' | 'house_price_index' | 'house_prices' | 'household_credit' | 'household_spending' | 'housing_starts' | 'import_prices' | 'imports' | 'industrial_production' | 'inflation' | 'inflation_linked_bond' | 'inflation_mom' | 'initial_jobless_claims' | 'international_assets' | 'international_liabilities' | 'job_openings' | 'm1' | 'm2' | 'm3' | 'nairu' | 'natural_gas_storage' | 'net_foreign_asset_position' | 'non_farm_payrolls' | 'non_farm_payrolls_change' | 'obfr' | 'part_time_employment' | 'participation_rate' | 'pce' | 'pce_mom' | 'policy_rate' | 'policy_rate_midpoint' | 'policy_rate_mlf' | 'policy_rate_mro' | 'policy_rate_target_lower' | 'ppi' | 'primary_income_balance' | 'productivity' | 'real_yield_20y' | 'real_yield_30y' | 'real_yield_5y' | 'real_yield_7y' | 'retail_sales' | 'retail_sales_control_group' | 'retail_sales_ex_autos' | 'retail_sales_ex_autos_and_gas' | 'risk_free_rate' | 'secondary_income_balance' | 'sight_deposits' | 'snb_balance_sheet' | 'sofr_average_180d' | 'sofr_average_30d' | 'sofr_average_90d' | 'sofr_index' | 'terms_of_trade' | 'tgcr' | 'trade_balance' | 'trade_weighted_index' | 'trimmed_mean_inflation' | 'unemployment' | 'wage_price_index' | 'wages', nullable: Comma-separated indicator slugs, e.g. ``inflation,gdp``. Omit to receive all indicators.
- `api_key` string, nullable: Your active FXMacroData trial or subscription API key.
- `payload` 'compact' | 'full', nullable: Event payload shape. Use `compact` for the stable trigger payload or `full` to flatten the latest announcement row into each event.
- `live_only` boolean
- `max_age_ms` integer, nullable

## Headers

- `Last-Event-ID` string, nullable

## Response `200`

Streaming SSE response. Each `data:` line is one JSON release-delivery event; see `/v1/announcements/changes` for the field-by-field contract.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/fxmacrodata/apis/fx-macrodata-api.md) · [All operations](https://skmtc.dev/fxmacrodata/apis/fx-macrodata-api/llms.txt) · [OpenAPI document](https://skmtc.dev/fxmacrodata/apis/fx-macrodata-api/revisions/fadaa543b154?raw)