API Documentation

curl -H "X-API-Key: your_api_key" https://api.forex-calendar.pro/api/announcements

{
  "lastUpdated": "2025-12-23T10:30:00.000Z",
  "eventsCount": 5,
  "timezone": "Paris",
  "events": [
    {
      "date": "Mon Dec 23",
      "time": "2:30pm",
      "currency": "USD",
      "impact": "high",
      "event": "GDP q/q",
      "actual": "2.1%",
      "forecast": "2.0%",
      "previous": "1.8%",
      "originalTime": "8:30am",
      "timezone": "Paris"
    }
  ]
}

{
  "lastUpdated": "2025-12-25T15:02:57.863Z",
  "eventsCount": 3,
  "timezone": "New York",
  "events": [
    {
      "date": "Tue Dec 23",
      "time": "8:30am",
      "currency": "CAD",
      "impact": "high",
      "event": "GDP m/m",
      "actual": "-0.3%",
      "forecast": "-0.3%",
      "previous": "0.2%",
      "originalTime": "8:30am",
      "timezone": "New York"
    },
    {
      "date": "Tue Dec 23",
      "time": "8:30am",
      "currency": "USD",
      "impact": "high",
      "event": "Prelim GDP q/q",
      "actual": "4.3%",
      "forecast": "3.3%",
      "previous": "3.8%",
      "originalTime": "8:30am",
      "timezone": "New York"
    },
    {
      "date": "Wed Dec 24",
      "time": "8:30am",
      "currency": "USD",
      "impact": "high",
      "event": "Unemployment Claims",
      "actual": "214K",
      "forecast": "224K",
      "previous": "224K",
      "originalTime": "8:30am",
      "timezone": "New York"
    }
  ]
}

{
  "date": "2025-12-25",
  "eventsCount": 14,
  "briefing": {
    "summary": "A mixed bag of economic data today, with Japan's Housing Starts y/y surprising with a -8.5% decline...",
    "key_events": [
      "12:00am | JPY | LOW | Housing Starts y/y",
      "6:50pm | JPY | LOW | Prelim Industrial Production m/m",
      "6:50pm | JPY | LOW | Retail Sales y/y"
    ],
    "market_movers": [
      "JPY: Housing Starts y/y (-8.5%) deviated significantly from forecast (0.2%)",
      "JPY: Prelim Industrial Production m/m and Retail Sales y/y may also have a significant impact"
    ],
    "risk_windows": [
      "6:50pm | JPY | LOW | Prelim Industrial Production m/m",
      "6:50pm | JPY | LOW | Retail Sales y/y"
    ],
    "currencies_in_focus": [
      "JPY: Surprising economic data and bank holidays will impact JPY pairs",
      "CHF: Bank holiday will lead to reduced trading volumes"
    ],
    "recommendation": "Focus on JPY pairs and be cautious of potential market volatility...",
    "volatility_forecast": "medium"
  },
  "events": [
    { "date": "Thu Dec 25", "time": "12:00am", "currency": "JPY", "impact": "low", "event": "Housing Starts y/y", "actual": "-8.5%", "forecast": "0.2%", "previous": "3.2%" },
    { "date": "Thu Dec 25", "time": "All Day", "currency": "CHF", "impact": "holiday", "event": "Bank Holiday", "actual": "", "forecast": "", "previous": "" },
    { "date": "Thu Dec 25", "time": "All Day", "currency": "EUR", "impact": "holiday", "event": "French Bank Holiday", "actual": "", "forecast": "", "previous": "" },
    "..."
  ],
  "language": "English",
  "generatedAt": "2025-12-25T15:05:15.245Z"
}

{
  "announcement": {
    "date": "Thu Dec 25",
    "time": "All Day",
    "currency": "EUR",
    "impact": "holiday",
    "event": "German Bank Holiday",
    "actual": "",
    "forecast": "",
    "previous": ""
  },
  "analysis": {
    "explanation": "A German Bank Holiday may cause reduced market liquidity and trading volumes in the EUR...",
    "importance": "This announcement is important for Forex traders as it can impact EUR price movements.",
    "scenarios": {
      "above_forecast": "If the holiday results in a significant increase in economic activity, the EUR may strengthen...",
      "below_forecast": "If the holiday leads to a decrease in economic activity, the EUR may weaken..."
    },
    "pairs_to_watch": ["EUR/USD", "EUR/GBP", "EUR/JPY", "EUR/CHF"],
    "risk_level": "medium",
    "trading_tip": "Consider scaling back positions or adjusting stop-loss levels ahead of the holiday..."
  },
  "language": "English",
  "generatedAt": "2025-12-25T15:06:33.662Z"
}

{
  "plan": "pro",
  "email": "user@example.com",
  "language": "en",
  "telegramConfigured": true,
  "usage": {
    "requestsToday": 45,
    "requestsLimit": 100,
    "resetAt": "2025-12-23T11:00:00.000Z"
  },
  "createdAt": "2025-01-15T10:00:00.000Z",
  "lastUsedAt": "2025-12-23T10:30:00.000Z"
}

{
  "telegramEnabled": true,
  "telegramId": "123456789",
  "impactLevels": ["high", "medium"],
  "alertDelay": 15,
  "language": "en"
}

{
  "error": "Daily quota exceeded",
  "message": "You have exceeded your daily quota of 100 requests (free plan). Quota resets at midnight UTC.",
  "quota": {
    "limit": 100,
    "used": 100,
    "plan": "free",
    "resetsAt": "2026-07-21T00:00:00.000Z"
  },
  "upgrade": "https://forex-calendar.pro/upgrade"
}

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 42
X-RateLimit-Reset: 2026-07-21T00:00:00.000Z

const response = await fetch('https://api.forex-calendar.pro/api/announcements?impact=high', {
  headers: { 'X-API-Key': 'your_api_key' }
});
const data = await response.json();

import requests

headers = {'X-API-Key': 'your_api_key'}
response = requests.get(
    'https://api.forex-calendar.pro/api/announcements',
    params={'impact': 'high,medium'},
    headers=headers
)
data = response.json()

curl -H "X-API-Key: your_api_key" \
  "https://api.forex-calendar.pro/api/announcements?impact=all"