restAPImarket: restAPImarket Class

In okxAPI: An Unofficial Wrapper for 'okx exchange v5' API

restAPImarket Class

Description

Wrapper for REST API MARKET.

Super class

okxAPI::restAPI -> restAPImarket

Methods

Public methods

• restAPImarket$candles()

• restAPImarket$history_candles()

• restAPImarket$clone()

Inherited methods

• okxAPI::restAPI$get_body()
• okxAPI::restAPI$get_header()
• okxAPI::restAPI$get_message()
• okxAPI::restAPI$get_request_path()
• okxAPI::restAPI$get_result()
• okxAPI::restAPI$get_signature()
• okxAPI::restAPI$get_timestamp()
• okxAPI::restAPI$initialize()

---

Method candles()

See Get candlesticks for more information.

Usage

restAPImarket$candles(instId, process = "identity", ...)

Arguments

instId

Instrument ID, e.g. BTC-USD-190927-5000-C.

process

A function to process the data received from the API. Default to identity.

...

Other request parameters.

---

Method history_candles()

See Get candlesticks history for more information.

Usage

restAPImarket$history_candles(instId, process = "identity", ...)

Arguments

instId

Instrument ID, e.g. BTC-USD-190927-5000-C.

process

A function to process the data received from the API. Default to identity.

...

Other request parameters.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

restAPImarket$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

okxAPI documentation built on April 22, 2023, 9:09 a.m.