get_public_economic_calendar: Get economic calendar

View source: R/wrappers_get_market.R

get_public_economic_calendarR Documentation

Get economic calendar

Description

Retrieve macro-economic calendar records. OKX requires authentication for this endpoint.

Usage

get_public_economic_calendar(
  region = NULL,
  importance = NULL,
  before = NULL,
  after = NULL,
  limit = NULL,
  config,
  tz = .okx_default_tz
)

Arguments

region

Character or 'NULL'. Region filter.

importance

Character or 'NULL'. Importance level filter.

before

Character or 'NULL'. Pagination cursor for newer rows.

after

Character or 'NULL'. Pagination cursor for older rows.

limit

Integer or 'NULL'. Number of rows to request.

config

List. API credentials/config.

tz

Character. Time zone for parsing timestamps. Default '"Asia/Hong_Kong"'.

Value

A 'data.frame' with calendar event fields and timestamps.


okxr documentation built on May 8, 2026, 5:09 p.m.