generated: '2026-10-18'
method: derived
generator: derive-vocabulary.py
source: openapi/fxmacrodata-openapi.json
vocabulary:
  name: FXMacroData Domain Vocabulary
  description: 'Terms declared by FXMacroData''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions.
    Derived, not authored.'
  version: '2026-10-18'
  terms:
  - term: health
    definition: Service health status endpoint.
    tags:
    - Resource Group
    source: openapi/fxmacrodata-openapi.json
  - term: announcements
    definition: 'Primary product: macroeconomic announcement time series.'
    tags:
    - Resource Group
    source: openapi/fxmacrodata-openapi.json
  - term: predictions
    definition: Forecasts/predictions for macroeconomic announcements, linked to the unique announcement they target via ``announcement_id``.
      Covers market consensus, central-bank forecasts, IMF WEO, and professional-forecaster surveys.
    tags:
    - Resource Group
    source: openapi/fxmacrodata-openapi.json
  - term: calendar
    definition: Standalone economic and policy release calendar endpoint spanning announcements and central-bank decision timing.
    tags:
    - Resource Group
    source: openapi/fxmacrodata-openapi.json
  - term: press_releases
    definition: Official central-bank press-release archive endpoints.
    tags:
    - Resource Group
    source: openapi/fxmacrodata-openapi.json
  - term: commodities
    definition: Commodity and energy datasets, including OPEC and planned commodity price endpoints.
    tags:
    - Resource Group
    source: openapi/fxmacrodata-openapi.json
  - term: fx_markets
    definition: FX market-state datasets including spot FX, market sessions, risk sentiment, and COT positioning.
    tags:
    - Resource Group
    source: openapi/fxmacrodata-openapi.json
  - term: settlement
    definition: 'Settlement records for event contracts on official macro releases: first-print value, latest value, release timing (scheduled,
      actual release window, ingested, latency from the actual release) and the contract outcome for a strike, with an Ed25519 attestation.'
    tags:
    - Resource Group
    source: openapi/fxmacrodata-openapi.json
  - term: data_catalogue
    definition: Cross-domain metadata index for available indicators.
    tags:
    - Resource Group
    source: openapi/fxmacrodata-openapi.json
  - term: AnnouncementChangeEvent
    definition: A release event returned by ``/v1/announcements/changes``. Events share the shape emitted by ``/v1/stream/events``. Fields that
      do not apply to an event are omitted rather than returned as null.
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/AnnouncementChangeEvent
  - term: AnnouncementChangesResponse
    definition: 'Object declared by the contract with fields: data, count, next_cursor, has_more, retention_seconds, scope, freemium_delay.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/AnnouncementChangesResponse
  - term: AnnouncementChangesScope
    definition: The filter set the response was produced under. ``currencies`` and ``indicators`` are null when no filter was applied.
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/AnnouncementChangesScope
  - term: AnnouncementDataPoint
    definition: 'Object declared by the contract with fields: source_validity_status, source_correction, announcement_id, date, val, source, source_url,
      source_url_scope, previous_value, previous_date, previous_announcement_datetime, change. (56 more)'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/AnnouncementDataPoint
  - term: AnnouncementPredictions
    definition: All available forecasts targeting a single announcement. ``announcement_id`` matches the value surfaced on the corresponding row
      in ``/v1/announcements/{currency}/{indicator}``, allowing clients to join predictions with realised observations. ``predictions`` contains
      one sub-entry per source (e.g. central-bank projection, IMF WEO, market consensus survey, FXMacroData prediction).
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/AnnouncementPredictions
  - term: AnnouncementResponse
    definition: 'Object declared by the contract with fields: currency, indicator, name, unit, value_name, source, source_url, source_series_id,
      source_series_name, source_local_name, seasonal_adjustment, price_basis. (32 more)'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/AnnouncementResponse
  - term: CBTargetEntry
    definition: A single central-bank target entry valid from ``effective_from``.
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/CBTargetEntry
  - term: CBTargetInfo
    definition: Central-bank target metadata for an indicator. ``current`` is the entry effective as of the response ``end_date``. ``history``
      contains every known target regime in ascending date order.
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/CBTargetInfo
  - term: COTDataPoint
    definition: 'Object declared by the contract with fields: date, announcement_datetime, open_interest, noncommercial_long, noncommercial_short,
      noncommercial_net, noncommercial_spread, commercial_long, commercial_short, commercial_net, total_reportable_long, total_reportable_short.
      (79 more)'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/COTDataPoint
  - term: COTFXOverlay
    definition: 'Object declared by the contract with fields: pair.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/COTFXOverlay
  - term: COTPaginationInfo
    definition: 'Object declared by the contract with fields: limit, offset, returned_count, total_count, has_more, next_offset.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/COTPaginationInfo
  - term: COTProvenance
    definition: 'Object declared by the contract with fields: publisher, publisher_url, storage, served_by, timestamp_field, value_field.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/COTProvenance
  - term: COTResponse
    definition: 'Object declared by the contract with fields: currency, instrument, report, report_name, report_dataset_id, available_reports,
      source, source_url, provenance, fx_overlay, start_date, end_date. (22 more)'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/COTResponse
  - term: CalendarReleaseRow
    definition: 'Object declared by the contract with fields: announcement_datetime, release, calendar_event_id, announcement_datetime_utc, announcement_datetime_local,
      announcement_datetime_requested_timezone, release_date_confirmed, release_time_assumed, release_time_status, release_date_status, release_time_assumption,
      time_announced. (23 more)'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/CalendarReleaseRow
  - term: CalendarResponse
    definition: 'Object declared by the contract with fields: currency, timezone, requested_timezone, indicator, requested_indicator, start_date,
      end_date, history_start_date, history_truncated, data_quality, data.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/CalendarResponse
  - term: CalendarSnapshot
    definition: 'Object declared by the contract with fields: currency, as_of, knowledge_mode, checkpoint, next_cursor, events, evidence_notice.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/CalendarSnapshot
  - term: CalendarVersions
    definition: 'Object declared by the contract with fields: currency, archive_event_id, checkpoint, next_cursor, versions.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/CalendarVersions
  - term: CatalogueCoverage
    definition: 'Object declared by the contract with fields: available, requires_api_key, earliest_available_date, latest_available_date, latest_release_date,
      row_count, value_available, has_recent_data, recent_observation_count, coverage_quality, history_coverage_quality, freshness_quality. (14
      more)'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/CatalogueCoverage
  - term: CatalogueSeriesVariant
    definition: 'Object declared by the contract with fields: series_id, name, storage_indicator, source, source_series_id, source_series_name,
      source_url, source_url_scope, calendar_release_name, calendar_source_url, annualization_source_url, seasonal_adjustment. (10 more)'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/CatalogueSeriesVariant
  - term: CatalogueSupportedOptions
    definition: 'Object declared by the contract with fields: basis, frequency, revisions, seasonality, annualization, period_aggregation.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/CatalogueSupportedOptions
  - term: CommoditiesLatestResponse
    definition: 'Object declared by the contract with fields: currency, source, as_of, is_stale, stale_indicators, freshness, count, data.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/CommoditiesLatestResponse
  - term: CommodityCoverage
    definition: 'Object declared by the contract with fields: scope, requested_start, requested_end, available_start, available_end, input_row_count,
      row_count, distinct_date_count, duplicate_date_row_count, excluded_weekend_row_count, invalid_date_row_count, expected_weekday_label_count.
      (14 more)'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/CommodityCoverage
  - term: CommodityCoverageSegment
    definition: 'Object declared by the contract with fields: start_date, end_date, row_count.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/CommodityCoverageSegment
  - term: CommodityDataPoint
    definition: 'Object declared by the contract with fields: source_permission_status, date, val, announcement_datetime, source, source_url,
      source_type, source_chart_timestamp, source_chart_timestamp_ms, source_chart_period, quote_time_status, sampling_method. (23 more)'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/CommodityDataPoint
  - term: CommodityIngestStatus
    definition: 'Object declared by the contract with fields: state, last_attempt_at, last_success_at, latest_available_date, data_lag_days, is_stale,
      error_code.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/CommodityIngestStatus
  - term: CommodityLatestFreshness
    definition: 'Object declared by the contract with fields: status, configured_count, available_count, oldest_available_date, newest_available_date,
      stale_indicators, unavailable_indicators, source_failure_indicators, unknown_freshness_indicators.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/CommodityLatestFreshness
  - term: CommodityLatestItem
    definition: 'Object declared by the contract with fields: indicator, unit, frequency, has_official_forecast, last_updated, observation_date,
      latest_available_date, is_stale, data_lag_days, ingest_status, data_quality, latest. (2 more)'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/CommodityLatestItem
  - term: CommodityMissingWeekdayRange
    definition: 'Object declared by the contract with fields: start_date, end_date, weekday_count.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/CommodityMissingWeekdayRange
  - term: CommodityObservation
    definition: 'Object declared by the contract with fields: source_permission_status, date, val, announcement_datetime, source, source_url,
      source_type, source_chart_timestamp, source_chart_timestamp_ms, source_chart_period, quote_time_status, sampling_method. (21 more)'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/CommodityObservation
  - term: CommodityResponse
    definition: 'Object declared by the contract with fields: currency, indicator, source, source_url, provenance, has_official_forecast, last_updated,
      latest_available_date, data_quality, start_date, end_date, pagination. (1 more)'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/CommodityResponse
  - term: CurveAnalyticsResponse
    definition: 'Object declared by the contract with fields: research, currency, curve_family, view, metric, method, requested_date, as_of, node_count,
      slope_count, inverted_count, segment_count. (4 more)'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/CurveAnalyticsResponse
  - term: DataCatalogueItem
    definition: 'Object declared by the contract with fields: name, unit, frequency, source, source_url, source_url_scope, calendar_release_name,
      calendar_source_url, annualization_source_url, source_series_id, source_series_name, source_history_start. (33 more)'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/DataCatalogueItem
  - term: DataCatalogueResponse
    definition: 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/anno
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/DataCatalogueResponse
  - term: DataQuality
    definition: 'Object declared by the contract with fields: source_freshness, source_monitoring_complete, known_source_gap, source_checked_at,
      source_check_expires_at, latest_published_period, source_permission_status, commodity_coverage, stored_history_coverage, point_in_time_basis,
      is_official, is_proxy. (33 more)'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/DataQuality
  - term: FactorDataPoint
    definition: 'Object declared by the contract with fields: date, val, score, level_score, impulse_score, rate_repricing_score, macro_pressure_score,
      label, stance_context, announcement_datetime, coverage_ratio, component_count. (6 more)'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/FactorDataPoint
  - term: FactorResponse
    definition: 'Object declared by the contract with fields: currency, factor, methodology, as_of, score, level_score, impulse_score, rate_repricing_score,
      macro_pressure_score, label, stance_context, latest_available_date. (6 more)'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/FactorResponse
  - term: FinancialCoverage
    definition: 'Object declared by the contract with fields: source_id, available, first_observation, last_observation, last_updated, source_accessed_at.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/FinancialCoverage
  - term: FinancialObservation
    definition: One official instrument/measure observation, retaining source dimensions.
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/FinancialObservation
  - term: FinancialPagination
    definition: 'Object declared by the contract with fields: limit, offset, returned_count, total_count, has_more, next_offset.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/FinancialPagination
  - term: FinancialPriceResponse
    definition: 'Object declared by the contract with fields: currency, start_date, end_date, sources, coverage, pagination, data.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/FinancialPriceResponse
  - term: FinancialSource
    definition: 'Object declared by the contract with fields: id, currency, publisher, url, license_url, attribution, frequency, publication_frequency,
      history_start, measures, dataset_name, license. (1 more)'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/FinancialSource
  - term: ForexDataPoint
    definition: 'Object declared by the contract with fields: source_permission_status, date, val, open, high, low, close, ohlc_point_count, ohlc_source_count,
      ohlc_timestamp_start_utc, ohlc_timestamp_end_utc, ohlc_type. (45 more)'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/ForexDataPoint
  - term: ForexResponse
    definition: 'Object declared by the contract with fields: base, quote, source, provenance, pair_metadata, data_quality, start_date, end_date,
      pagination, data, indicators, daily_ohlc_basis. (3 more)'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/ForexResponse
  - term: FreemiumDelayNotice
    definition: 'How far behind real time a free-tier response is, and what that costs. Present only for callers without a paid key, and present
      whether or not anything was actually withheld: a delayed response must never be mistakable for a current one. ``withheld_count`` is how
      many releases were held back from *this* response; ``next_available_at`` is when the oldest of them becomes readable.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/FreemiumDelayNotice
  - term: FreemiumWindow
    definition: Present only when the freemium window shortened the response. Without it, ``pagination.total_count`` counts the clamped series
      and a truncated history is indistinguishable from a genuinely short one.
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/FreemiumWindow
  - term: FxIntradayReferenceRatePoint
    definition: 'Object declared by the contract with fields: timestamp, price, reference_date, timestamp_type, source, source_pair, derivation_method.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/FxIntradayReferenceRatePoint
  - term: FxIntradayReferenceRatesResponse
    definition: 'Object declared by the contract with fields: pair, start_time, end_time, data.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/FxIntradayReferenceRatesResponse
  - term: FxReferencePoint
    definition: 'Object declared by the contract with fields: date, reference_date, base, quote, pair, rate, timestamp_utc, timestamp_type, fixing_time_utc,
      published_at_utc, time_precision, source. (5 more)'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/FxReferencePoint
  - term: FxReferenceResponse
    definition: 'Object declared by the contract with fields: base, quote, start_date, end_date, timestamp_basis, source_policy, pagination, data,
      dataset_version, coverage.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/FxReferenceResponse
  - term: FxSessionRatePoint
    definition: 'Object declared by the contract with fields: date, reference_date, base, quote, pair, rate, timestamp_utc, timestamp_type, fixing_time_utc,
      published_at_utc, time_precision, source. (10 more)'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/FxSessionRatePoint
  - term: FxSessionRateResponse
    definition: 'Object declared by the contract with fields: base, quote, session, start_date, end_date, source_policy, pagination, data, dataset_version,
      coverage.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/FxSessionRateResponse
  - term: FxSource
    definition: One official FX reference-rate source.
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/FxSource
  - term: FxSourcePolicy
    definition: Redistribution rules governing which rows the public endpoints serve.
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/FxSourcePolicy
  - term: FxSourceUniverseEntry
    definition: 'Object declared by the contract with fields: source, pair_count, pairs.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/FxSourceUniverseEntry
  - term: FxSourceUniversePair
    definition: 'Object declared by the contract with fields: pair, availability, anchor.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/FxSourceUniversePair
  - term: FxSourceUniverseResponse
    definition: 'Object declared by the contract with fields: source_policy, currency, source, data.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/FxSourceUniverseResponse
  - term: FxSourcesResponse
    definition: 'Object declared by the contract with fields: source_policy, sources.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/FxSourcesResponse
  - term: HTTPValidationError
    definition: 'Object declared by the contract with fields: detail.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/HTTPValidationError
  - term: LatestAnnouncementItem
    definition: 'Object declared by the contract with fields: indicator, name, source, source_url, source_series_id, source_series_name, source_local_name,
      seasonal_adjustment, price_basis, is_proxy, proxy_note, provenance. (9 more)'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/LatestAnnouncementItem
  - term: LatestAnnouncementProvenance
    definition: 'Object declared by the contract with fields: publisher, publisher_url, source_series_id, source_series_name, source_local_name,
      seasonal_adjustment, price_basis, storage, served_by, timestamp_field, value_field, is_proxy. (1 more)'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/LatestAnnouncementProvenance
  - term: LatestAnnouncementValue
    definition: One observation, used for both ``latest`` and ``previous``.
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/LatestAnnouncementValue
  - term: LatestAnnouncementsProvenance
    definition: 'Object declared by the contract with fields: publisher, storage, served_by, timestamp_field, value_field.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/LatestAnnouncementsProvenance
  - term: LatestAnnouncementsResponse
    definition: 'Object declared by the contract with fields: currency, source, provenance, as_of, count, data, freemium_delay.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/LatestAnnouncementsResponse
  - term: MarketSession
    definition: 'Object declared by the contract with fields: name, display_name, description, currencies, timezone, open_utc, close_utc, open_unix,
      close_unix, is_open, seconds_to_open, seconds_to_close.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/MarketSession
  - term: MarketSessionOverlap
    definition: 'Object declared by the contract with fields: name, sessions, description, priority, notable_pairs, start_utc, end_utc, start_unix,
      end_unix, is_active, seconds_to_start, seconds_to_end. (1 more)'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/MarketSessionOverlap
  - term: MarketSessionsResponse
    definition: 'Object declared by the contract with fields: now_utc, now_unix, is_market_day, sessions, overlaps.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/MarketSessionsResponse
  - term: OfficialForwardSourceSupport
    definition: How the official publisher makes forward rates available, if at all.
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/OfficialForwardSourceSupport
  - term: PaginationInfo
    definition: Offset pagination state for a single page of results.
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/PaginationInfo
  - term: PointInTimeCompleteness
    definition: Coverage of source-confirmed publication timestamps for a dataset.
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/PointInTimeCompleteness
  - term: PolicyFamilyEntry
    definition: 'Object declared by the contract with fields: indicator, value_name, role.'
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/PolicyFamilyEntry
  - term: PredictionItem
    definition: A single per-source forecast inside an announcement group.
    tags:
    - Object
    source: openapi/fxmacrodata-openapi.json#/components/schemas/PredictionItem