get_public_underlying: Get underlying list
In okxr: R Interface to the 'OKX' REST API
View source: R/wrappers_get_market.R
get_public_underlying R Documentation
Get underlying list
Description
Retrieve available underlyings for derivatives instruments.
Usage
get_public_underlying(
inst_type,
config = NULL,
tz = .okx_default_tz
)
Arguments
inst_type
Character. Instrument type: '"SWAP"', '"FUTURES"', or
'"OPTION"'.
config
Optional list. Public endpoint request options, such as
'timeout'; credentials are not required.
tz
Character. Unused except for interface consistency.
Value
A one-column 'data.frame' with 'uly'.
okxr documentation built on May 8, 2026, 5:09 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
View source: R/wrappers_get_market.R
| get_public_underlying | R Documentation |
Get underlying list
Description
Retrieve available underlyings for derivatives instruments.
Usage
get_public_underlying(
inst_type,
config = NULL,
tz = .okx_default_tz
)
Arguments
inst_type |
Character. Instrument type: '"SWAP"', '"FUTURES"', or '"OPTION"'. |
config |
Optional list. Public endpoint request options, such as 'timeout'; credentials are not required. |
tz |
Character. Unused except for interface consistency. |
Value
A one-column 'data.frame' with 'uly'.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.