Quickstart
Qala noma ngolimi luni
I-FXMacroData API yinguku- JSON REST API ejwayelekile yokusetshenziswa ohlangothini lwe-server. noma yiluphi ulimi olunesekelo lwe- HTTP lusebenza. idatha yemishumayelo ye- USD, ikhalenda yokukhipha ye- USD, kanye nokathilogu wedatha kumahhala ngaphandle kokhiwo: izinsuku ze- 90 zakamuva, ngokubambezeleka kokukhipha kwemizuzu eyi- 15, kufike ezicelweni ezi- 100 ngosuku. Amanani okubikezela (kuhlanganise i- USD), zonke ezinye izinhlobo zemali, ukukhipha kwesikhathi sangempela, nomlando ophelele badinga ukhiwo lwe- API, oluthunyelwe ku- X-API-Key header. Bona ukuthi yini yamahhala
Isisekelo se-URL
https://api.fxmacrodata.com
Ukuhlunyeleliswa (Authentication)
i-X-API-Key: YOUR_API_KEY
Authorization: Bearer YOUR_API_KEY
I-legacy ?api_key= i-query parameter isekhathele: izikhiye kuma-URL zigcina sezirekhodini.
Ifomethi yempendulo
JSON (Content-Type: application/json)
openapi-generator-cli ukuze ukhiqize ngokuzenzakalelayo amaklayenti ngezi-40+ izilimi.
Accept-Encoding: gzip ngokuphathelene nokuphuma kwemibhalo ngalo lonke isicelo (8–12× izinhlelo ezincane), sebenzisa i ETag i-response header ku If-None-Match emaphulisi aphindaphindwayo (kubuyisa 304 Not Modified ngaphandle kwento (body), bese udlulisela ?limit=50 kwe-endpoints ezinomthandazo oyedwa njenge- /v1/announcements/usd/inflation noma /v1/predictions/usd/inflation lapho udinga imigqa yakamuva kuphela. Bona isandiso esiphelele →
limit amukela kufika ku-100. Ukuqoqa uhlobo oluphelele, phinda isicelo ngo- offset bekwe ku- pagination.next_offset until pagination.has_more is false. Bheka i-loop ye-Python ↓
fetch() kusukela ekhasini lewebhu kuvimbwa ngumbhrowuza. Biza FXMacroData kusukela e-backend yakho futhi ugcine i-key ye-API ikude nekhodi le-client-side.
core_pce ikhona ku-USD kodwa akukhona kuzo zonke izimali. Uhlu wonke i-slug imali esiyisekelayo nange GET /v1/data_catalogue/{currency}, isibonelo /v1/data_catalogue/usd. I-200 lapho data i-array ingenalutho futhi ethwele no_data.error_code: NO_DATA_IN_REQUESTED_WINDOW kusho ukuthi i-slug isemthethweni futhi isikhathi esiceliwe kuphela esingenalutho — ukubanzi start_date/end_date kunokuba ushintshe i-URL noma uzame futhi. I-404 isho ukuthi i-slug ye-currency noma ye-indicator ayilungile.
data_quality object. Kubo i-backtests kanye nokubika kwezikhungo, hlola point_in_time_safe, has_announcement_datetime, source_type, kanye is_stale. point_in_time_safe kuyiqiniso noma nini lapho noma yimuphi umugqa efulelwe isikhathi sokukhipha esitholakala kusikhathi sokubalwa kweminyaka yokukhishwa, ngakho hlola assumed_release_time_count nokho emugqagmeni ngamunye release_time_assumed u-flag ngaphambi kokuthi uphathe okungelona iqiniso njengento engasetshenziseki.
Ukufinyelela emakethe
Sebenzisa i-FXMacroData nge-RapidAPI
RapidAPI iyiskanalozakhi (marketplace channel) okungafanele iye ku-FXMacroData REST API. I-FXMacroData inikeza idatha; i-RapidAPI iphethe ukubhalisa kwakho kwe-marketplace, i-key ye-API, i-quota yezicelo kanye nokukhokha. Akudingeki i-akhawunti ye-FXMacroData noma i-key eyihlukile zemibhalo ezenziwa ngale nkundla.
- Vula i- uhlu olusemthethweni lwe-FXMacroData futhi ukhethe inkundla. Hlola ithebula lezintengo ukuze ubone ukufakwa kwamanje, ama-quota kanye nemikhawulo yethani (rate limits).
- Kopisha i-key yakho ye-RapidAPI kusuka ku-endpoint playground bese uyigcina endaweni ye-server yakho njenge
RAPIDAPI_KEY. - Thumela izicelo ku
https://fxmacrodata1.p.rapidapi.comngama-header amabili we-RapidAPI, njengoba kubonisiwe ngezansi.
curl --request GET \ --url "https://fxmacrodata1.p.rapidapi.com/v1/announcements/usd/inflation?limit=3" \ --header "X-RapidAPI-Key: $RAPIDAPI_KEY" \ --header "X-RapidAPI-Host: fxmacrodata1.p.rapidapi.com"
Ukubandakanyeka kwe-Marketplace endpoint
Uhlu luqukethe izimemezelo, amakalenda okukhiwa, ikhathalogi yedatha, izinqubo ze-FX zansuku zonke, ukubekwa kwe-COT, izindaba zebhange eliphakathi, izikhathi zamakethe kanye nokuhlola impilo. Ukufinyelela kwemali nomlando kuncike ohlelweni lwakho lwe-RapidAPI. Sebenzisa ikhathalogi ukuthola ama-indicator slugs asekelwayo.
Ukufinyelela okuqondile kwe-FXMacroData
Ezinye izibonelo kuleli khasi zisebenzisa api.fxmacrodata.com kanye ne-FXMacroData X-API-Key uma kudingeka. Ama-keys nezibhaliso kahlukile phakathi kwama-channels. Ukubhalisa kwe-RapidAPI kubandakanya ama-REST endpoints abhalwe phansi; ukubhalisa kwe-website, i-MCP, izibikezelo, i-streaming kanye ne-webhooks ziyizinketho ezihlukile.
Gcina i-key yakho kude ne-browser code nemigodi yomphakathi. Ukuze uthole imiphumela emide, landela pagination.next_offset until pagination.has_more kuyiqiniso. Ungalokothi uthumele i-key yakho ye-API ku-support.
Ikhali ye-API yokuqala
Isicelo esisheshayo
Isiqephu sokuqala sisebenza njengoba sinjalo: akudingeki i-key ye-data kaUSD, ekhishwa 15 imizuzu ngemva kokukhiphwa. Faka X-API-Key za zonke izimali 22 kanye nokuhlinzekwa kwesikhathi sangempela, kuthunyelwe kusuka ku-server, isikripthi, noma i-notebook.
# USD inflation, no key: 15-minute delay, most recent 90 days
curl "https://api.fxmacrodata.com/v1/announcements/usd/inflation?limit=5"
# EUR inflation: add X-API-Key for all 22 currencies and real-time releases
curl -H "X-API-Key: YOUR_API_KEY" "https://api.fxmacrodata.com/v1/announcements/eur/inflation"
Izicelo ze-Python
Izicelo ze-Python API ezingakopishwa
Sebenzisa lezi zibonelo eziqondile ze-REST uma ufuna i-raw API request esikhundleni se-SDK wrapper. Shintsha i-YOUR_API_KEY kuphela ezindleleni ezivikelwe.
isivumelwano semakhetheki lenani le-inflation ye-USD
Izibikezelo ze-Consensus, survey, central-bank, IMF, kanye ne-FXMacroData ezihlanganiswe nemimemezelo eyenziwe.
import requests
url = "https://api.fxmacrodata.com/v1/predictions/usd/inflation"
headers = {"X-API-Key": "YOUR_API_KEY"}
response = requests.get(url, headers=headers, timeout=20)
response.raise_for_status()
payload = response.json()
print(payload.get("data", payload))
USD inflation ngezikhathi ezaziwayo (known-at timestamps)
Amanqamuzi e-inflation e-public USD emlandweni we-point-in-time backtests.
import requests
url = "https://api.fxmacrodata.com/v1/announcements/usd/inflation"
response = requests.get(url, timeout=20)
response.raise_for_status()
payload = response.json()
print(payload.get("data", payload))
Umlando we-spot we-EUR/USD FX
Umlando wezintengo ze FX wansuku zonke wezibakaki zamapheya, amamodeli, nezifanekiso zokukhishwa.
import requests
url = "https://api.fxmacrodata.com/v1/forex/eur/usd"
headers = {"X-API-Key": "YOUR_API_KEY"}
response = requests.get(url, headers=headers, timeout=20)
response.raise_for_status()
payload = response.json()
print(payload.get("data", payload))
imininingwane ye-policy-rate ka-AUD
Umlando wezinqumo zebhange eliphakathi nendawo kanye nesikhathi sokukhululwa ukuze kube nocwaningo olungabheki okuzokwenzeka.
import requests
url = "https://api.fxmacrodata.com/v1/announcements/aud/policy_rate"
headers = {"X-API-Key": "YOUR_API_KEY"}
response = requests.get(url, headers=headers, timeout=20)
response.raise_for_status()
payload = response.json()
print(payload.get("data", payload))
uhlelo lokukhishwa kwe-JPY oluzayo
Izehlakalo zamama-macro ezizayo ne-UTC, imakethe eyasendaweni, kanye nemikhakha yezikhathi eziceliwe yokuhlela izixwayiso, ukuvuselela amamodeli, nokubuyekeza ukuhweba.
import requests
url = "https://api.fxmacrodata.com/v1/calendar/jpy"
params = {
"timezone": "Asia/Tokyo",
}
headers = {"X-API-Key": "YOUR_API_KEY"}
response = requests.get(url, params=params, headers=headers, timeout=20)
response.raise_for_status()
payload = response.json()
print(payload.get("data", payload))
Izimbiza zegolide
Uhlu lwezikhathi lwezinto eziyigugu ezisemthethweni olunemibalo yansuku zonke nemikhakha yoshintsho.
import requests
url = "https://api.fxmacrodata.com/v1/commodities/gold"
headers = {"X-API-Key": "YOUR_API_KEY"}
response = requests.get(url, headers=headers, timeout=20)
response.raise_for_status()
payload = response.json()
print(payload.get("data", payload))
Python
Faka okusemthethweni fxmacrodata iphesheji evela ku-PyPI (1.2.x). Amaklayenti e-sync ne-async abuyisela ama-dictionary alula we-JSON athwatha ngqo ku-pandas. Client() ngaphandle kwe-key kufunda i-tier yamahhala ye-USD; dala api_key ngezinye izimali zonke nokulethwa kwesikhathi sangempela.
Ukusebenzisa i-SDK
from fxmacrodata import Client # USD inflation — no key needed: 15-minute delay, most recent 90 days data = Client().get_indicator("usd", "inflation") print(data["data"][0]) # Add X-API-Key for all 22 currencies and real-time releases client = Client(api_key="YOUR_API_KEY") # EUR policy rate — requires API key rate = client.get_indicator("eur", "policy_rate") # Forex price data — requires API key fx = client.get_fx_price("usd", "jpy")
Ukusebenzisa i-REST API ngqo
import requests resp = requests.get( "https://api.fxmacrodata.com/v1/announcements/usd/inflation", timeout=30, ) resp.raise_for_status() payload = resp.json() print(payload["data_quality"]["point_in_time_safe"], payload["data"][0])
Ukudlula emlandweni ophelele
import requests URL = "https://api.fxmacrodata.com/v1/announcements/eur/inflation" HEADERS = {"X-API-Key": "YOUR_API_KEY"} rows, offset = [], 0 while True: resp = requests.get( URL, params={"limit": 100, "offset": offset}, headers=HEADERS, timeout=30, ) resp.raise_for_status() page = resp.json() rows.extend(page["data"]) if not page["pagination"]["has_more"]: break offset = page["pagination"]["next_offset"] print(len(rows), "rows")
Iklayenti le-Async
import asyncio from fxmacrodata import AsyncClient async def main(): async with AsyncClient(api_key="YOUR_API_KEY") as client: data = await client.get_indicator("eur", "inflation") print(data) asyncio.run(main())
Izibikezelo & Izibikezelo
I- /v1/predictions/{currency}/{indicator} i-endpoint ikhipha imininingwane yeziqagelo ezivela ezicwaningweni zesivumelwano semakethe, iziqagelo zebhange eliphakathi, i-IMF World Economic Outlook, kanye nezicwaningo zabahloli abangochwepheshe. Iziqagelo zicelwa ngenhloso yemali ethile kanye ne-indicator, njengokuthi https://api.fxmacrodata.com/v1/predictions/usd/inflation; izicelo zezibikezelo zemali kuphela azisekhethwa. Isibikezelo ngasinye sihlanganiswe nesimemezelo saso nge announcement_id, ukuze ukwazi ukuhlanganisa izibikezelo nemibiko eyenziwe.
prediction_type="fxmacrodata" isilinganiso esenziwe nge-FXMacroData; i-consensus eqinisekile ibhalwe njenge- market_consensus. Ukutholakala kwe-forecast kuncike ekukhiqweni — hlola i- imathrikhi yokufakwa kwemininingwane. Ukuze wenze ucwaningo olungabi nokuqagela okusebenza ngaphambili, landela i- isikhokelo se-backtesting esikhathi esithile.
/v1/predictions/coverage/{currency}. I-key ye-trial noma eyokukhokhelwa ibuyisa ama-value e-forecast
Python — faka izibikezelo futhi uhlanganyele ne-actuals
import requests HEADERS = {"X-API-Key": "YOUR_API_KEY"} # Predictions for USD inflation — requires API key preds = requests.get( "https://api.fxmacrodata.com/v1/predictions/usd/inflation", headers=HEADERS, timeout=30, ).json() for group in preds["data"]: print(group["announcement_id"], group["date"]) for p in group["predictions"]: print(f" {p['prediction_source_label']}: {p['predicted_value']}") # Filter by prediction type market = requests.get( "https://api.fxmacrodata.com/v1/predictions/usd/inflation", params={"prediction_type": "market_consensus"}, headers=HEADERS, timeout=30, ).json() # Join predictions with actuals using announcement_id actuals = requests.get( "https://api.fxmacrodata.com/v1/announcements/usd/inflation", headers=HEADERS, timeout=30, ).json() actuals_by_id = {row["announcement_id"]: row for row in actuals["data"]} for group in preds["data"]: actual = actuals_by_id.get(group["announcement_id"]) if actual: print(f"{group['date']}: actual={actual['val']}, forecast={group['predictions'][0]['predicted_value']}")
cURL — faka izibikezelo ngokuhlobonohlo
# Which sources forecast USD indicators — free, no key curl "https://api.fxmacrodata.com/v1/predictions/coverage/usd" # All USD inflation predictions — requires API key curl -H "X-API-Key: YOUR_API_KEY" "https://api.fxmacrodata.com/v1/predictions/usd/inflation" # Filter by prediction type: market_consensus, imf_weo, central_bank_forecast, survey curl -H "X-API-Key: YOUR_API_KEY" "https://api.fxmacrodata.com/v1/predictions/usd/inflation?prediction_type=market_consensus" # EUR policy-rate predictions curl -H "X-API-Key: YOUR_API_KEY" "https://api.fxmacrodata.com/v1/predictions/eur/policy_rate"
Imininingwane yezinhlobo zezibikezelo
| prediction_type | Incazelo |
|---|---|
| market_consensus | Isivumelwano semicimbi yemarkethe noma yonomakhasimende, lapho kutholakala khona |
| market_prediction | Isibikezelo somchazazhi oqeqeshiwe |
| model_nowcast | Ukubikezela kwemodeli yebhange eliphakathi noma lebhange lokugcina |
| ucwaningo | Ucwaningo lwebhange eliphakathi labasebenzi abaqagelayo (isib. ECB SPF) |
| central_bank_forecast | Isiqalgo esisemthethweni sebhange eliphakathi (isib. RBNZ MPS, BoC MPR) |
| central_bank_projection | Ukuqagela okusemthethweni kwamabhange amaphakathi |
| imf_weo | Isiqalgo se-IMF World Economic Outlook |
| fxmacrodata | Isiqagelo esenziwe nge-FXMacroData esihlanganisa isiqondiso sebhange eliphakathi, ucwaningo, kanye nezitayela zomlando |
cURL
Akudingeki ukufaka. Isebenza kuyo yonke i-terminal.
# USD inflation — no-key evaluation, up to 100 requests/day curl "https://api.fxmacrodata.com/v1/announcements/usd/inflation" # EUR policy rate — send your API key in the X-API-Key header curl -H "X-API-Key: YOUR_API_KEY" "https://api.fxmacrodata.com/v1/announcements/eur/policy_rate" # Release calendar for Australia — requires API key curl -H "X-API-Key: YOUR_API_KEY" "https://api.fxmacrodata.com/v1/calendar/aud" # Release calendar converted to a requested IANA timezone curl "https://api.fxmacrodata.com/v1/calendar/usd?indicator=gdp&timezone=America/Sao_Paulo" # Forex price history — requires API key curl -H "X-API-Key: YOUR_API_KEY" "https://api.fxmacrodata.com/v1/forex/usd/jpy" # Data catalogue (discover available indicators for USD) curl "https://api.fxmacrodata.com/v1/data_catalogue/usd"
JavaScript / TypeScript
Sisebenza e-server-side ku-Node.js (18+), Deno, noBun. I-API ayithumeli ama-header e-CORS, ngakho biza yona kusukela e-backend yakho kunokuba ubize yona ekhodini le-browser.
Iklayenti esemthethweni ye-npm
import { FXMacroDataClient } from "@fxmacrodata/client"; const client = new FXMacroDataClient({ apiKey: "YOUR_API_KEY", }); // Public endpoint example const usdInflation = await client.announcements("usd", "inflation"); // Non-USD endpoint example (requires paid key) const eurRate = await client.announcements("eur", "policy_rate"); console.log(usdInflation, eurRate);
Sebenzisa i-Fetch ngqo
// USD inflation — no-key evaluation, up to 100 requests/day const res = await fetch( "https://api.fxmacrodata.com/v1/announcements/usd/inflation" ); const data = await res.json(); console.log(data); // With API key for non-USD const API_KEY = process.env.FXMD_API_KEY; const eur = await fetch( "https://api.fxmacrodata.com/v1/announcements/eur/policy_rate", { headers: { "X-API-Key": API_KEY } } ); console.log(await eur.json());
Hamba
Akudingeki amapakeji angaphandle — i-standard library iyayiphatha yonke into.
package main import ( "encoding/json" "fmt" "net/http" "io" ) func main() { // USD inflation — no-key evaluation, up to 100 requests/day resp, err := http.Get("https://api.fxmacrodata.com/v1/announcements/usd/inflation") if err != nil { panic(err) } defer resp.Body.Close() body, _ := io.ReadAll(resp.Body) var result map[string]interface{} json.Unmarshal(body, &result;) fmt.Println(result) }
R
Dinga httr kanye ne jsonlite.
library(httr) library(jsonlite) # USD inflation — no-key evaluation, up to 100 requests/day res <- GET("https://api.fxmacrodata.com/v1/announcements/usd/inflation") data <- fromJSON(content(res, "text", encoding = "UTF-8")) # Convert to data frame df <- as.data.frame(data$data) head(df) # With API key for non-USD eur <- GET( "https://api.fxmacrodata.com/v1/announcements/eur/policy_rate", add_headers(`X-API-Key` = "YOUR_API_KEY") ) print(fromJSON(content(eur, "text")))
Java
Ukusetshenziswa java.net.http (Java 11+). Akudingeki amabhhayi angaphandle.
import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; public class FXMacroDataExample { public static void main(String[] args) throws Exception { var client = HttpClient.newHttpClient(); var request = HttpRequest.newBuilder() .uri(URI.create("https://api.fxmacrodata.com/v1/announcements/usd/inflation")) .build(); var response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body()); } }
C# / .NET
Ukusetshenziswa HttpClient (.NET 6+).
using System.Net.Http; using System.Text.Json; var client = new HttpClient(); // USD inflation — no-key evaluation, up to 100 requests/day var json = await client.GetStringAsync( "https://api.fxmacrodata.com/v1/announcements/usd/inflation" ); var doc = JsonDocument.Parse(json); Console.WriteLine(doc.RootElement);
MATLAB
Isebenzisa okwakhiwe webread isisebenzi.
% USD inflation — no-key evaluation, up to 100 requests/day data = webread('https://api.fxmacrodata.com/v1/announcements/usd/inflation'); disp(data); % With API key for non-USD opts = weboptions('Timeout', 30, 'HeaderFields', {'X-API-Key', 'YOUR_API_KEY'}); url = 'https://api.fxmacrodata.com/v1/announcements/eur/policy_rate'; eur = webread(url, opts); disp(eur);
Dala iklayenti elinohlobo nganoma iyiphi ulimi
I-FXMacroData API ikhipha okuphathelene noku Ispecification ye-OpenAPI 3.1. Yisebenzise ne- openapi-generator ukuze ukhiqize amaklayenti anohlobo olugcwele we-Kotlin, Swift, Rust, Dart, Ruby, PHP, kanye ne-40+ ezinye izilimi.
# Install the openapi-generator CLI npm install @openapitools/openapi-generator-cli -g # Generate a Go client openapi-generator-cli generate \ -i https://api.fxmacrodata.com/openapi.json \ -g go \ -o ./fxmacrodata-go-client # Generate a Java client openapi-generator-cli generate \ -i https://api.fxmacrodata.com/openapi.json \ -g java \ -o ./fxmacrodata-java-client
Usulungele ukwakha?
Idatha yokukhipha ye- USD isebenza ngaphandle kokhiwo, kufike ezicelweni ezi- 100 /nosuku futhi imizuzu eyi- 15 emuva kokushicilelwa. Bhalisela ukukhipha kwesikhathi sangempela, amanani okubikezela, umlando ophelele, imingcele ephakeme, nazo zonke izinhlobo zemali.