Developer Portal
Trader APIsHTTP APIPublic endpoints

Get Economic CalendarGET

Returns economic calendar events, optionally scoped to a symbol. When a symbol_id is supplied, relevance is determined by the symbol's base and quote assets (currency filter) and its asset class (category filter); when omitted, all events in the window are returned. An explicit currencies or categories param overrides the symbol-derived defaults. Results can be bounded by a from/to date range. No authentication required.

View as Markdown
GET
/public/economic-calendar

Query Parameters

symbol_idstring

Optional symbol ID. Its base/quote assets select relevant currencies and its asset class selects a default category set. Omit for an unscoped calendar.

currenciesstring

Comma-separated list of currency codes to filter by (e.g. EUR,USD). Overrides the symbol-derived currency filter. Empty or omitted leaves currency scoping to the symbol (if any).

fromstring

Lower bound (inclusive) for event dates, RFC3339 or YYYY-MM-DD. Defaults to 30 days ago when omitted.

Format: "date-time"
tostring

Upper bound (inclusive) for event dates, RFC3339 or YYYY-MM-DD. Defaults to 7 days from now when omitted.

Format: "date-time"
categoriesstring

Comma-separated list of economic categories to filter by. When omitted, the relevant categories are derived automatically from the symbol's asset class (forex, stock/ETF/index, and commodity each get a tailored set; other classes such as crypto are left unfiltered). Passing this param overrides that default. Unknown names are ignored. Allowed values: MONETARY_POLICY, INFLATION, EMPLOYMENT, GROWTH_OUTPUT, BUSINESS_ACTIVITY, CONSUMER, TRADE, HOUSING, MONEY_CREDIT, GOVERNMENT_FINANCE, ENERGY, COMMODITIES, MARKET_POSITIONING, OTHER.

curl -X GET "http://localhost:8081/api/v1/public/economic-calendar?symbol_id=%3Cstring%3E&currencies=%3Cstring%3E&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z&categories=%3Cstring%3E"

Economic calendar events relevant to the symbol

{
  "events": [
    {
      "date": "string",
      "country": "string",
      "currency": "string",
      "event": "string",
      "impact": "string",
      "previous": 0.1,
      "estimate": 0.1,
      "actual": 0.1,
      "change": 0.1,
      "change_percentage": 0.1,
      "unit": "string",
      "is_past": true,
      "category": "string",
      "relevance_tier": "string"
    }
  ]
}

Funding Rates

Returns the live funding rate and next settlement time for a perpetual symbol, using the rates that apply to the authenticated user. Returns 404 if the symbol has no active funding rate, or if funding rates are not configured for this user.

Guest OHLCV Bars

Returns historical OHLCV bars for one active symbol. At least one of `from` or `count` is required. When both are supplied, `count` takes precedence and `from` is ignored. A request may not ask for more than 5,000 bars: `count` directly, or — in range mode — the bars the timeframe implies over `[from, to]`, so the permitted span scales with the timeframe (5,000 minutes on `1M`, 5,000 days on `D`). Bounds are rejected with HTTP 400 rather than truncated. No authentication required.