sync_local_okx_candle: Synchronize Local OKX Candle Data

View source: R/okx_candle_data.R

sync_local_okx_candleR Documentation

Synchronize Local OKX Candle Data

Description

Synchronize Local OKX Candle Data

Usage

sync_local_okx_candle(
  inst_id,
  bar,
  config = NULL,
  local_path = NULL,
  mode = c("latest", "history"),
  before = NULL,
  limit = 100L,
  tz = "UTC",
  storage = c("single", "monthly")
)

Arguments

inst_id

Instrument identifier.

bar

Candle interval.

config

Optional OKX API config. If omitted, defaults from the package config and OKX_API_KEY / OKX_SECRET_KEY / OKX_PASSPHRASE environment variables are used.

local_path

Optional OKX storage path.

mode

Either "latest" or "history".

before

Optional history cursor.

limit

Integer page size.

tz

Output time zone.

storage

Local storage mode: monolithic "single" or monthly partitioned "monthly".

Value

A sync result list.


investdatar documentation built on Aug. 21, 2026, 5:17 p.m.