--- title: "Get Currently Available Macroeconomic Indicators" method: GET path: "/v1/data_catalogue/{currency}" tags: ["data_catalogue"] --- # Get Currently Available Macroeconomic Indicators `GET /v1/data_catalogue/{currency}` ## Request - Base URL: `https://api.fxmacrodata.com` - URL: `https://api.fxmacrodata.com/v1/data_catalogue/{currency}` - Auth: one of: - none - API key in header `X-API-Key` - HTTP bearer Returns the currently available macroeconomic indicators for a specific currency. Availability reflects the data currently served, so temporarily unavailable series are excluded until data is available again. The catalogue is refreshed on a regular schedule. This endpoint also replaces the deprecated `/v1/capabilities` and `/v1/coverage_matrix` endpoints. Coverage is included directly on each catalogue entry. To also include the legacy top-level coverage list, call it with `include_coverage=true`. To include capability metadata, call it with `include_capabilities=true`. Each entry includes: * **name**: The full descriptive name of the metric. * **unit**: The unit of measurement (e.g., %YoY, Billions of USD). * **frequency**: How often the data is updated (Daily, Monthly, Quarterly). * **source** / **source_url**: The publisher or source family for the series, when available. * **source_series_id** / **source_series_name**: The upstream source identifier and exact source-series label, when available. * **seasonal_adjustment**: Seasonal basis (`SA`, `NSA`, `UNKNOWN`, or `NOT_APPLICABLE`). * **price_basis**: GDP/level price basis (`REAL`, `NOMINAL`, or `UNKNOWN`) when applicable. * **aliases** / **related_indicators**: Optional flat discovery metadata for common alternative names and adjacent indicators. * **standardization_note**: Optional note explaining sign, unit, scope, or cross-currency comparability choices. * **has_official_forecast**: Whether the relevant central bank or statistics agency publishes a preliminary, flash, or advance estimate of this indicator before the main/final data release. * **coverage**: Earliest/latest available dates, row count, recency status, and coverage quality for that indicator. ## Path parameters - `currency` 'AUD' | 'BRL' | 'CAD' | 'CHF' | 'CNH' | 'CNY' | 'DKK' | 'EUR' | 'GBP' | 'HUF' | 'ILS' | 'JPY' | 'KRW' | 'MYR' | 'NGN' | 'NOK' | 'NZD' | 'PEN' | 'SEK' | 'THB' | 'TWD' | 'USD', required: The 3-letter currency code (e.g., USD, AUD, EUR, GBP, CHF) ## Query parameters - `include_capabilities` boolean: Include currency-scoped endpoint/auth metadata that replaces the deprecated /v1/capabilities response. - `include_coverage` boolean: Also include the legacy currency-scoped coverage list that replaces the deprecated /v1/coverage_matrix response. Per-indicator coverage is included in catalogue entries by default. - `indicator` '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: Optional indicator filter when include_coverage=true. ## Response `200` Indicator metadata keyed by indicator slug, with optional capability and coverage metadata. - DataCatalogueResponse: Indicator slug to catalogue entry. The response is a JSON object whose keys are the indicator slugs published for the currency (for example ``gdp``, ``inflation``, ``policy_rate``) and whose values are ``DataCatalogueItem`` objects. Because the slug set differs by currency, entries are described by ``additionalProperties`` rather than fixed ``properties``. The same slugs are accepted by ``/v1/announcements`` and ``/v1/predictions`` for that currency. ## Other responses - `404`: Currency not found. - `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)