ping
Ping
Health check that confirms the FXMacroData API and MCP server are reachable. Returns the API health response.
无需输入参数。
io.github.fxmacrodata由 GitHub 账号 fxmacrodata 发布v1.0.1更新于 Nov 2, 2026
Macroeconomic and FX time-series data for AI agents: indicators, calendars, COT, forex, commodities.
远程 MCP 服务器,向 AI 助手提供 FXMacroData 的宏观经济与外汇时间序列数据,包括指标、发布日历、COT、汇率与大宗商品。
Web executable,通过 Streamable HTTP。 远程服务在工作区中配置后即可从网页运行时运行。
把这段提示词粘贴到 Claude Code、Codex、Cursor 等智能体,或 SourceWeft 对话中。智能体会读取该服务器的安装指南,先向你展示发布者、端点和登录方式,经你同意后再把它添加到你的客户端。密钥不会写进任何命令。
阅读 https://sourceweft.com/mcp/io.github.fxmacrodata%2Ffxmacrodata/install.md,并按其中说明把这个 MCP 服务器接入我的客户端。修改任何配置之前,先告诉我它的发布者、端点和登录方式,等我确认。不要把 API 密钥写进命令或我会提交的文件;问我密钥应从哪里获取。把它添加到你客户端的 mcpServers 配置中。
{
"mcpServers": {
"fxmacrodata": {
"type": "http",
"url": "https://fxmacrodata.com/mcp"
}
}
}[PyPI Version] [Python Versions] [License] [Build]
The FXMacroData Python SDK provides a simple and efficient interface for fetching macroeconomic indicators, forex prices, release calendars, COT positioning, and commodity prices from FXMacroData.
Use synchronous and asynchronous clients to bring the data into research notebooks, backtests and applications.
Subscribe to FXMacroData for non-USD data, full available history, FX, commodities and positioning. Use the public USD workflow to evaluate the integration before connecting your subscription.
get_fx_price.requests and aiohttp.Install from PyPI:
Or install the latest version from GitHub:
Every request has a 30-second timeout by default. Change it per client:
All errors are FXMacroDataError or one of its subclasses:
Your API key is never included in error messages, and it is only sent over HTTPS to the origin you configured: redirects to another host or to plain HTTP are refused rather than followed with the key attached.
FXMacroData supports all practical OpenBB integration paths from this package:
obb.fxmacrodata.*./api/v1/fxmacrodata/* routes through openbb-api.openbb-api from inline metadata.widgets.json, apps.json, and data endpoints.openbb-mcp.openbb-build.OpenBB packages require Python 3.10+. Install the OpenBB Python extra:
Then use FXMacroData from the OpenBB Python interface:
Run the OpenBB REST API and generated Workspace backend:
Workspace can be connected to http://127.0.0.1:6900. The generated
/widgets.json uses FXMacroData's inline OpenBB widget metadata.
Run the OpenBB Workspace custom backend:
Default backend URL:
Workspace exposes /widgets.json, /apps.json, /catalogue,
/release_calendar, /macro_indicator, /forex, /cot, and /commodity.
Swagger/OpenAPI docs are disabled by default for this backend. For local
debugging only, set FXMACRODATA_OPENBB_ENABLE_DOCS=1 before starting it.
Run OpenBB MCP:
Run OpenBB CLI:
See docs/openbb-integration.md for the full integration matrix and the
separate upstream OpenBB repository contribution path.
get_indicator(currency, indicator, start_date=None, end_date=None)Fetches macroeconomic indicator time series data.
currency: "usd", "aud", "eur", "gbp", "cad", "nok", "nzd", "jpy", "brl", "cny", "dkk", "pln", "sek", "sgd", etc.indicator: "policy_rate", "inflation", "gdp", "unemployment", "trade_balance", "current_account_balance", "gov_bond_10y", etc.get_fx_price(base, quote, start_date=None, end_date=None, indicators=None)Fetches daily FX spot rates between two currencies.
indicators: Optional comma-separated technical indicators — "sma_20", "sma_50", "sma_200", "rsi_14", "macd", "ema_12", "ema_26", "bollinger_bands", or "all".get_calendar(currency, indicator=None)Fetches upcoming economic data release dates for a currency.
indicator: Optional filter to a specific indicator slug.announcement_datetime (Unix timestamp) and release (indicator slug).get_data_catalogue(currency, include_capabilities=False, include_coverage=False, indicator=None)Discovers available macroeconomic indicators for a given currency.
name, unit, frequency, and has_official_forecast.get_cot(currency, start_date=None, end_date=None)Fetches CFTC Commitment of Traders (COT) positioning data.
AUD, CAD, CHF, EUR, GBP, JPY, NZD, USD.get_commodities(indicator, start_date=None, end_date=None)Fetches commodity price time series.
indicator: "gold", "silver", or "platinum".18 currencies supported: AUD, BRL, CAD, CHF, CNH, CNY, DKK, EUR, GBP, ILS, JPY, NGN, NOK, NZD, PEN, SEK, THB, USD.
The table below shows a sample of indicator coverage across four major currencies. Use get_data_catalogue() to discover the full list for any currency.
MIT License © FXMacroData
来源:README.md,提交 817acce
Ping
Health check that confirms the FXMacroData API and MCP server are reachable. Returns the API health response.
无需输入参数。
MCP Capabilities
Explains what the FXMacroData MCP server can do: which tools render MCP Apps, which return plain rows, what is public versus subscriber-only, and how tool selection differs across ChatGPT, Claude, Cursor, Codex, and plain MCP clients. Suited to questions about what is available, why visuals are not showing, or how to get the same result in a different interface.
无需输入参数。
MCP Auth Guide
Explains which authentication mode suits FXMacroData MCP across major clients and platforms: OAuth, an API key, or a bearer token, for ChatGPT/OpenAI Apps, Claude/Anthropic, Microsoft/VS Code/Copilot-style clients, AstrBot, Cursor, Codex, local scripts, and CI.
无需输入参数。
Subscribe For MCP Access
Returns FXMacroData subscription options and a direct checkout path for unlocking MCP app visuals, charts, and advanced analytical tools.
无需输入参数。
Indicator Catalogue
List every macroeconomic indicator FXMacroData publishes for a currency, with units, frequency, and coverage/freshness metadata. Returns the exact `indicator` slug strings used across FXMacroData indicator, calendar, and prediction endpoints. Rows whose `coverage` is stale, partial, or unavailable are not suitable for real-time carry or inflation analysis. Supported currencies (lowercase 3-letter codes): AUD, BRL, CAD, CHF, CNH, CNY, DKK, EUR, GBP, HUF, ILS, JPY, KRW, MYR, NGN, NOK, NZD, PEN, SEK, THB, TWD, USD. Access: free for every currency, no API key required.
currency必填indicatorinclude_coverageinclude_capabilitiesGlobal Risk Sentiment
Return the global risk-on/risk-off sentiment series used for FX regime analysis. The result includes a derived composite score, regime label, component contributions, pagination, and data_quality metadata. Suited to cross-asset regime context for high-beta, safe-haven, commodity, or USD-defensive FX conditions. Access: free, no API key required.
end_datestart_dateRecorded Risk Sentiment Changes
Poll retained risk-sentiment additions, score revisions, and input-metadata changes. Pass pagination.next_after_sequence as after_sequence on the next page or poll. Recording timestamps describe when FXMacroData stored each change; earlier untracked revisions and publisher publication times are unavailable. Access: free, no API key required.
limitafter_sequenceMacro News
Return recent official central-bank news and press-release headlines for a currency, covering central-bank policy, inflation, employment, GDP, trade, fiscal, energy, and commodity narratives. Rows are official-source headlines with lightweight keyword-derived affected_indicators and sentiment fields when a headline is classifiable. Supported currencies: AUD, BRL, CAD, CHF, DKK, EUR, GBP, ILS, JPY, NGN, NOK, NZD, PEN, SEK, USD. Access: USD is available without an API key; every other currency returns subscription_required with a subscribe link.
limitoffsetcurrency必填lookback_daysRelease Calendar
Get upcoming scheduled macroeconomic release timestamps for a currency, for questions such as when the next CPI, GDP, payrolls, or policy decision is due. Returns ISO-8601 announcement_datetime values in UTC plus market-local timestamps, a markdown agenda, and Release Calendar App metadata. The optional `timezone` adds an `announcement_datetime_requested_timezone` field. Each row has a `release` string with the indicator name and a `currency` code. Unbounded calls return future releases only. The optional `indicator` filter narrows to a single series, and optional `start_date` and `end_date` bounds select a month, week, day, or explicit date range. Supported currencies: AUD, BRL, CAD, CHF, CNH, CNY, COMM, DKK, EUR, GBP, HUF, ILS, JPY, KRW, MYR, NGN, NOK, NZD, PEN, SEK, THB, TWD, USD. The `indicator` parameter lists the accepted indicator slugs. Access: USD is available without an API key; every other currency returns subscription_required with a subscribe link.
currency必填end_datetimezoneindicatorstart_dateHistorical Calendar Snapshot
Return persisted economic-event schedules, importance and cancellation states at an explicit historical cutoff. Accepted mode requires actual capture and parser acceptance by the cutoff. Reconstruction additionally admits qualified official notices recovered later; it does not establish historical service availability. Scheduled-date and event filters apply after version selection. Checkpoint and cursor pin subsequent export pages. Empty results do not establish that no events were scheduled. Access: requires an FXMacroData API key; an anonymous call returns subscription_required with a subscribe link.
as_of必填limitcursorcurrency必填end_datecheckpointevent_kindimportancestart_dateknowledge_modeCalendar Event Versions
Return immutable schedule and importance versions for a stable archive event ID, including explicit publisher cancellations and source capture evidence. Capture, acceptance and documentary publisher clocks remain distinct. Checkpoint and cursor pin subsequent history pages. Access: requires an FXMacroData API key; an anonymous call returns subscription_required with a subscribe link.
limitcursorcurrency必填checkpointarchive_event_id必填Calendar Archive Coverage
Inspect persisted official-calendar captures, parser outcomes, configured sources and coverage limitations for a currency. Successful capture does not prove complete historical calendar or speech coverage. Access: requires an FXMacroData API key; an anonymous call returns subscription_required with a subscribe link.
currency必填Release Calendar Visual Artifact
Returns the release calendar payload with MCP Apps metadata so compatible clients render the interactive Release Calendar App inline. Suited to requests to show, display, visualize, or render a macro release calendar, such as 'show me the AUD release calendar'. Optional `indicator`, `start_date`, and `end_date` filters narrow the calendar to a series, month, week, day, or date range; `timezone` adds local times for a specific city or region. Supported currencies: AUD, BRL, CAD, CHF, CNH, CNY, COMM, DKK, EUR, GBP, HUF, ILS, JPY, KRW, MYR, NGN, NOK, NZD, PEN, SEK, THB, TWD, USD. The `indicator` parameter lists the accepted indicator slugs. Access: USD is available without an API key; every other currency returns subscription_required with a subscribe link.
currency必填end_datetimezoneindicatorstart_dateEvent Predictions
Return stored forecasts, consensus-style predictions, central-bank projections, survey forecasts, IMF forecasts, nowcasts, or FXMacroData blended predictions for macro announcements, for actual-vs-consensus, prior-vs-forecast, or event-surprise context. Rows are keyed by announcement_id/date/indicator and include prediction source metadata. Supported currencies: AUD, BRL, CAD, CHF, CNH, CNY, DKK, EUR, GBP, HUF, ILS, JPY, KRW, MYR, NGN, NOK, NZD, PEN, SEK, THB, TWD, USD. The `indicator` parameter lists the accepted indicator slugs. Access: requires an FXMacroData API key; an anonymous call returns subscription_required with a subscribe link.
pageas_ofbasislimitoffsetcurrency必填end_datefrequencyindicator必填start_datebefore_dateseasonality另有 8 个Latest Macro Announcements
Return the latest stored macroeconomic value for every available indicator in one currency, as a compact current macro snapshot. An unverified announcement_datetime has unproven origin; it is neither a verified scheduled time nor observed actual publication. Report absent schedule, publication and ingestion evidence as unknown, and latency as not measured. Access: USD is available without an API key; every other currency returns subscription_required with a subscribe link.
currency必填Macro Announcement Changes
Poll recently ingested macro announcement changes with a resumable cursor. This is the bounded, MCP-safe counterpart to the release-event stream: the returned next_cursor is accepted as `since` on a later call, so polling resumes without holding a streaming invocation open. Access: USD is available without an API key; every other currency returns subscription_required with a subscribe link.
limitsincepayloadcurrenciesindicatorsOfficial Press Releases
Return the public central-bank press-release archive for a currency as the original official release rows, without derived sentiment or indicator classifications. Access: USD is available without an API key; every other currency returns subscription_required with a subscribe link.
limitoffsetcurrency必填Macro Factor
Return a precomputed macro factor for one currency, with optional stored component scores and source references. The factor is a documented summary value and does not replace the underlying macro releases. Access: USD is available without an API key; every other currency returns subscription_required with a subscribe link.
limitfactor必填offsetcurrency必填end_datestart_dateinclude_sourcesinclude_componentsFX Reference Sources
List public official FX reference-rate sources and the source policy that governs pair-specific intraday reference-rate series. Access: free for every currency, no API key required.
无需输入参数。
FX Reference Pair Universe
List the public FX reference-rate pair universe, optionally filtered by currency or source id, showing which pairs and sources have intraday reference-rate series. Access: free for every currency, no API key required.
sourcecurrencyIntraday FX Reference Rates
Return subscriber intraday official FX reference-rate observations for one pair. Coverage is limited to the pairs and sources in the FX reference pair universe. Access: requires an FXMacroData API key; an anonymous call returns subscription_required with a subscribe link.
base必填quote必填end_timestart_timeRate Curve Analytics
Return official government-nominal curve nodes, slopes, or derived forward segments for one currency. This is a subscriber data tool and preserves the endpoint's requested view and method metadata. Access: requires an FXMacroData API key; an anonymous call returns subscription_required with a subscribe link.
dateviewmethodmetriccurrency必填curve_familyPair Rate Differentials
Return the stored or derived rate differential for one FX pair, with the measure, rate type, curve family, and tenor metadata that define it. Access: requires an FXMacroData API key; an anonymous call returns subscription_required with a subscribe link.
base必填limitquote必填offsetmeasureend_daterate_typestart_datecurve_familyend_tenor_yearsstart_tenor_yearsLatest Commodity Values
Return the latest stored value for every available commodity indicator in one response, as a batch snapshot of the subscriber commodity series. Access: requires an FXMacroData API key; an anonymous call returns subscription_required with a subscribe link.
无需输入参数。
FX Spot Rates
Get raw historical FX spot-rate rows for a currency pair (e.g. EUR/USD, USD/JPY) as a plain-text table, raw rows, exact values, or JSON-like data, with optional technical-indicator series (SMA, EMA, RSI, MACD, Bollinger Bands, etc.) computed from spot. Returns data only, without chart metadata. Daily granularity from official central-bank reference rates with full multi-year history. Supported currencies (lowercase 3-letter codes): AUD, BRL, CAD, CHF, CNH, CNY, DKK, EUR, GBP, HUF, ILS, JPY, KRW, MYR, NGN, NOK, NZD, PEN, SEK, THB, TWD, USD. The optional `indicators` parameter accepts a comma-separated list of technical indicator slugs to attach to each row. Supported indicator values: adx_14, atr_14, bollinger_bands, cci_20, donchian_20, ema_12, ema_20, ema_200, ema_26, ema_50, macd, macd_histogram, macd_signal, rsi_14, sma_20, sma_200, sma_50, stochastic_14_3, williams_r_14, all. Access: requires an FXMacroData API key; an anonymous call returns subscription_required with a subscribe link.
base必填quote必填end_dateindicatorsstart_dateFX Seasonality
Get monthly return seasonality for an FX pair or XAU/USD, covering seasonal patterns, month-of-year tendency, historical monthly win rate, and XAUUSD/gold seasonality. Returns monthly average return, median return, win rate, sample size, dispersion, and per-year monthly returns from stored FX or gold series. Access: requires an FXMacroData API key; an anonymous call returns subscription_required with a subscribe link.
monthend_dateinstrument必填lookback_yearsIndicator Time Series
Get a paginated historical time series of a single macroeconomic indicator for a currency, sourced directly from the official central bank or statistical agency. Covers CPI/inflation, GDP, unemployment, policy rates, bond yields, payrolls, retail sales, PCE, PPI, trade balance, current account, money supply, and similar series. Each row returns `date` (economic reference period), `val` (numeric), and separate publication evidence. The `as_of` parameter restricts results to historically eligible values; current values can include later revisions. Returns raw rows without chart metadata. Each call returns one page, newest first: 100 rows when `start_date` is set, otherwise 20 (`limit` overrides, maximum 100). A page is not the full history. When `pagination.has_more` is true the result has a `partial_page` object: `partial_page.next_call` holds the exact arguments for the next page and `partial_page.pages_remaining` gives the number of pages left. Responses default to official-source rows only; prohibited private aggregator rows are always removed. USD indicators are free; non-USD requires an API key. Supported currencies: AUD, BRL, CAD, CHF, CNH, CNY, DKK, EUR, GBP, HUF, ILS, JPY, KRW, MYR, NGN, NOK, NZD, PEN, SEK, THB, TWD, USD. The `indicator` parameter lists the accepted indicator slugs. Access: USD is available without an API key; every other currency returns subscription_required with a subscribe link.
pageslugas_oflimitoffsetcurrencyend_dateindicatorrevisionsstart_datevalue_modeseries_mode另有 3 个Plot Visual Artifact
Build a generic MCP Apps chart from one or more FXMacroData endpoint families: arbitrary plots, multi-series charts, and actual-vs-consensus views that combine announcements with predictions. Supported series sources are announcements, predictions, forex, commodities, and cot. For example, USD policy-rate midpoint actuals against market consensus use one announcements series for `usd/policy_rate_midpoint` and one predictions series for `usd/policy_rate_midpoint` with `prediction_class=forecaster_survey`. The tool does not fetch arbitrary URLs or run custom chart code; it only composes approved FXMacroData API surfaces into the comparison chart app. Access: USD is available without an API key; every other currency returns subscription_required with a subscribe link.
basepagelimitqueryquotetitley_keyoffsetseriessourcex_axisy_label另有 7 个Indicator Visual Artifact
Returns an indicator time series with MCP Apps metadata so compatible clients (Claude Desktop, ChatGPT, Codex, etc.) render an interactive line chart instead of a JSON dump. Suited to indicator time-series requests to show, tell, explain, compare, inspect a trend, or review a recent window. Broad histories page through the `limit`, `offset`, and `page` controls, with `pagination.next_offset` giving the next page. Supported currencies: AUD, BRL, CAD, CHF, CNH, CNY, DKK, EUR, GBP, HUF, ILS, JPY, KRW, MYR, NGN, NOK, NZD, PEN, SEK, THB, TWD, USD. The `indicator` parameter lists the accepted indicator slugs. Access: USD is available without an API key; every other currency returns subscription_required with a subscribe link.
pagelimitoffsetcurrency必填end_dateindicator必填start_dateFX Visual Artifact
Returns FX spot-rate history for a currency pair with MCP Apps chart metadata so compatible clients render an interactive spot-rate chart inline. Suited to FX pair time-series and trend requests such as 'show me AUD/USD', 'the last 30 days', or 'how has EUR/USD moved recently'. Access: requires an FXMacroData API key; an anonymous call returns subscription_required with a subscribe link.
base必填quote必填end_dateindicatorsstart_dateCommodities Visual Artifact
Returns commodity price history with MCP Apps chart metadata so compatible clients render an interactive commodity chart inline. Access: requires an FXMacroData API key; an anonymous call returns subscription_required with a subscribe link.
end_dateindicator必填start_dateCOT Visual Artifact
Returns weekly CFTC COT positioning data with MCP Apps chart metadata. By default it charts noncommercial net positioning; the `metric` parameter selects another COT field. Access: USD is available without an API key; every other currency returns subscription_required with a subscribe link.
metricreportcurrency必填end_datestart_datePolicy-Rate Differential Visual Artifact
Build a two-series chart comparing base and quote policy-rate history to visualize the rate differential setup for an FX pair. Access: requires an FXMacroData API key; an anonymous call returns subscription_required with a subscribe link.
base必填quote必填end_datestart_dateMacro Briefing Task
Build a compact macro briefing for a currency by combining catalogue, key macro series, release-calendar, prediction, news, risk-sentiment, COT, seasonality, and FX technical context. Returns analysis in the tool response. Access: USD is available without an API key; every other currency returns subscription_required with a subscribe link.
currency必填Indicator Intelligence Task
Build an intelligence pack for one indicator by combining chart-ready series data, derived analytics, and nearest release timing context. Returns analysis in the tool response. Access: USD is available without an API key; every other currency returns subscription_required with a subscribe link.
currency必填end_dateindicator必填start_dateFX Pair Intelligence Task
Build an intelligence pack for an FX pair by combining policy-rate spread context, spot-rate context, and release-timing metadata. Returns analysis in the tool response. Access: requires an FXMacroData API key; an anonymous call returns subscription_required with a subscribe link.
base必填quote必填end_datestart_dateMacro Heatmap Task
Build a cross-currency macro heatmap from indicator time series and return a matrix with latest values, recent changes, and z-scores. Returns analysis in the tool response.
end_datecurrenciesindicatorsstart_datePolicy Scenario Modeler Task
Run a policy-rate spread what-if scenario for an FX pair and estimate directional spot impact using an explicit heuristic elasticity assumption. Returns analysis in the tool response. Access: requires an FXMacroData API key; an anonymous call returns subscription_required with a subscribe link.
base必填quote必填end_dateshock_bpsshock_legstart_datepolicy_shock_bpselasticity_per_100bpsMacro War Room Task
Build a multi-panel macro market cockpit that combines FX sessions, upcoming release queue, pair context, and generated risk alerts. Returns analysis in the tool response. Access: USD is available without an API key; every other currency returns subscription_required with a subscribe link.
basequotecurrencyend_dateindicatorstart_dateEvent Impact Replay Task
Replay verified publication events against measured 1, 5 and 20-observation FX reference returns. Daily windows exclude the publication-day fixing; changes from previous actuals are not consensus surprises. Returns analysis in the tool response. Access: USD is available without an API key; every other currency returns subscription_required with a subscribe link.
basequotecurrency必填end_dateindicator必填start_datelookback_eventsQuant Scenario Lab Task
Run an expanded quant-style policy scenario for an FX pair with deterministic projection, stress percentiles, and horizon assumptions. Returns analysis in the tool response. Access: requires an FXMacroData API key; an anonymous call returns subscription_required with a subscribe link.
base必填quote必填end_dateshock_bpsshock_legstart_datehorizon_dayselasticity_per_100bpsannualized_volatility_pctKnown At Time Task
Return the slice of a macro series that would have been known at a specific timestamp, selecting verified value vintages before pagination. Returns analysis in the tool response. Access: USD is available without an API key; every other currency returns subscription_required with a subscribe link.
as_of必填currency必填end_dateindicator必填start_dateavailabilitydataset_versionMacro Regime Classifier Task
Classify a currency's macro regime using policy rate, inflation, GDP, and unemployment context, with explicit assumptions and confidence notes. Returns analysis in the tool response. Access: USD is available without an API key; every other currency returns subscription_required with a subscribe link.
currency必填end_datestart_dateRelease Risk Score Task
Score upcoming releases for a currency pair using release-calendar proximity and indicator-level heuristics. Returns analysis in the tool response. Access: requires an FXMacroData API key; an anonymous call returns subscription_required with a subscribe link.
base必填quote必填horizon_eventsPortfolio Risk Engine Task
Analyze a multi-position FX book for concentration, stress exposure, and event-driven catalyst risk. Returns analysis in the tool response. Access: requires an FXMacroData API key; an anonymous call returns subscription_required with a subscribe link.
horizon_eventspositions_json必填stress_shock_pctFX Trade Setup Task
Build a trader-oriented FX pair setup using spot context, macro differentials, upcoming catalyst risk, and optional COT positioning. Returns analysis in the tool response. Access: requires an FXMacroData API key; an anonymous call returns subscription_required with a subscribe link.
base必填quote必填include_cothorizon_eventsFX Backtest Task
Run a spot-only FX backtest using historical policy-rate-differential and/or lagged momentum signals. Downloads complete histories, verifies vintages and price coverage, and charges opening, rebalancing and closing costs. The carry signal does not include funding income or broker rollover. Returns analysis in the tool response. Access: requires an FXMacroData API key; an anonymous call returns subscription_required with a subscribe link.
base必填quote必填end_datestrategystart_dateevent_gatedinitial_capitalevent_window_daysmomentum_lookbacktransaction_cost_bpsMacro Research Pack Task
Bundles catalogue, indicator history, next release timing, and optional FX pair context into one persistent-host-friendly research payload. Returns analysis in the tool response. Access: USD is available without an API key; every other currency returns subscription_required with a subscribe link.
basequotecurrency必填end_dateindicator必填start_dateForecast Coverage Catalogue
List which publishers produce pre-release forecasts for a currency's indicators, what class of forecast each one is (compiled consensus, forecaster survey, market implied, model nowcast, central-bank projection), whether any of them is a genuine consensus, and how far the verified archive runs. Suited to questions about whether a consensus, forecast or estimate exists for a release, such as 'do you have the consensus for US CPI' or 'what forecast do you have for payrolls'. It needs no API key and works for every served currency. It returns no forecast values: those require a subscription. Its answer distinguishes two cases: no publisher produces this forecast for anybody (no subscription adds it), versus the data exists and is behind the paywall. A pair listed here exists in the verified archive. Access: free for every currency, no API key required. It returns coverage metadata only; forecast values need a subscription.
currencyFX Market Sessions
Returns which FX trading sessions are currently open (Sydney, Tokyo, London, New York) and when the next session opens or closes, for questions such as 'is the market open?', 'when does London open?', or 'which sessions overlap right now?'. An ISO-8601 UTC timestamp in `at` returns the snapshot for a specific moment instead of now. Accounts for weekends and major banking holidays. Access: free, no API key required.
atCOT Report
Get weekly CFTC Commitment of Traders (COT) positioning data for a currency's FX futures contract on the CME, covering speculator positioning, non-commercial longs vs shorts, hedge-fund FX positioning, and sentiment extremes. Returns weekly snapshots with long/short open interest by trader category. Updated every Friday at 15:30 ET reflecting the Tuesday cutoff. USD (the USD Index contract) is available without an API key for the most recent 90 days on a 15-minute release delay; every other currency and the full history need an API key. Supported currencies: AUD, CAD, CHF, EUR, GBP, JPY, NZD, USD, XAU. Access: USD is available without an API key; every other currency returns subscription_required with a subscribe link.
reportcurrency必填end_datestart_dateCommodity Indicators
Get historical price series for supported commodity indicators using the exact slugs advertised by this schema. Requires an API key. Supported indicators: crude_oil_inventories, distillate_inventories, gasoline_inventories, gold, natural_gas, natural_gas_storage, oil_brent, oil_wti, platinum, silver. Access: requires an FXMacroData API key; an anonymous call returns subscription_required with a subscribe link.
symbolend_dateindicatorstart_dateFutures Instrument Positioning
Read persisted CFTC contract positioning. Omit instrument to list supported instrument/report combinations. Main and micro contracts, futures-only and combined reports remain separate. Position dates are not publication timestamps. Requires an API key.
limitoffsetreportend_dateinstrumentstart_dateReserves, Treasury and Energy History
Read one source and year of gold ownership/custody, Treasury auctions, cash/debt, TIC positions or EIA energy fundamentals. Keep native dimensions and unknown historical publication times. Omit source to list definitions; an API key is required.
yearlimitorderoffsetregionsourcemeasureproductmaturityaccount_typeownership_basisholder_country_codeOfficial Financial Prices
Read persisted official financial price observations: government yield curves, individual securities, overnight benchmarks and reference prices. Preserves issuer, instrument, maturity, curve type and source precision. Requires an API key; an empty result means no stored observations for the selection. Access: requires an FXMacroData API key; an anonymous call returns subscription_required with a subscribe link.
limitissueroffsetsourcemeasurecurrency必填end_datestart_dateinstrument_idOfficial Dataset Family
Get metadata-first official dataset payloads grouped by API endpoint type. `endpoint_type` selects the API taxonomy group and `dataset` selects the specific series family. Supported endpoint types: monetary_policy, fiscal_policy, international_trade, statistics_releases. Supported datasets: auction_metrics, bop, capital_flows, cb_liquidity, credit_conditions, external_debt, fx_intervention, iip, services_trade, treasury_cash, wage_settlements. Access: requires an FXMacroData API key; an anonymous call returns subscription_required with a subscribe link.
dataset必填currency必填componentendpoint_type必填已满足适用检查项的 100%
该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。
pip install fxmacrodatapip install git+https://github.com/fxmacrodata/fxmacrodata.gitfrom fxmacrodata import Client
client = Client(api_key="YOUR_API_KEY")
# Fetch macroeconomic indicatorsdata = client.get_indicator( "aud", "policy_rate", start_date="2023-01-01", end_date="2023-11-01")print(data)
# Forex price endpointfx = client.get_fx_price("usd", "gbp", start_date="2025-01-01")print(fx)
# Forex with technical indicatorsfx = client.get_fx_price("eur", "usd", indicators="sma_20,rsi_14,macd")print(fx)
# Release calendarcalendar = client.get_calendar("usd")print(calendar)
# Data catalogue — discover available indicatorscatalogue = client.get_data_catalogue("usd")print(catalogue)
# COT positioning datacot = client.get_cot("eur", start_date="2025-01-01")print(cot)
# Commodity pricesgold = client.get_commodities("gold", start_date="2026-01-01")print(gold)import asynciofrom fxmacrodata import AsyncClient
async def main(): async with AsyncClient(api_key="YOUR_API_KEY") as client: # Fetch macroeconomic indicators data = await client.get_indicator("eur", "inflation") print(data)
# Forex price endpoint fx = await client.get_fx_price("usd", "jpy") print(fx)
# Release calendar calendar = await client.get_calendar("usd") print(calendar)
# Data catalogue catalogue = await client.get_data_catalogue("usd") print(catalogue)
# COT positioning cot = await client.get_cot("jpy") print(cot)
# Commodity prices gold = await client.get_commodities("gold") print(gold)
asyncio.run(main())Client(api_key="YOUR_API_KEY", timeout=60) # secondsClient(api_key="YOUR_API_KEY", timeout=(3.05, 120)) # (connect, read)AsyncClient(api_key="YOUR_API_KEY", timeout=60) # total secondspip install "fxmacrodata[openbb]"openbb-buildfrom openbb import obb
obb.user.credentials.fxmacrodata_api_key = "YOUR_API_KEY"
catalogue = obb.fxmacrodata.data_catalogue( currency="USD", provider="fxmacrodata",).to_df()
inflation = obb.fxmacrodata.macro_indicators( currency="USD", indicator="inflation", start_date="2020-01-01", provider="fxmacrodata",).to_df()
eurusd = obb.fxmacrodata.fx_historical( base="EUR", quote="USD", start_date="2024-01-01", provider="fxmacrodata",).to_df()pip install "fxmacrodata[openbb-api]"openbb-buildfxmacrodata-openbb-api --host 127.0.0.1 --port 6900pip install "fxmacrodata[workspace]"fxmacrodata-openbb-backendhttp://127.0.0.1:7779pip install "fxmacrodata[mcp]"openbb-buildfxmacrodata-openbb-mcp --default-categories fxmacrodata --host 127.0.0.1 --port 8001pip install "fxmacrodata[openbb-cli]"openbb-buildopenbb