Learn R Programming
td (version 0.0.6)

ref_exchanges: Reference Data Accessor for Exchanges from ‘twelvedata’

Description

Retrieve Reference Data for Exchanges from ‘twelvedata’

Usage

ref_exchanges(
  type = c("stock", "etf", "index"),
  as = c("data.frame", "raw"),
  name = "",
  code = "",
  country = "",
  apikey
)

Arguments

type

(character) A (single) type for exchange for “stock”, “etf” or “index”. Defaults to “stock”.

as

(optional, character) A selector for the desired output format: one of “data.frame” (the default) or or “raw”.

name

(optional, character) Filter by exchange. Default is unset.

code

(optional, character) Filter by exchange mic code. default is unset.

country

(optional, character) Filter by country name or alpha code. Default is unset.

apikey

(optional character) An API key override, if missing a value cached from package startup is used. The startup looks for either a file in the per-package config directory provided by tools::R_user_dir (for R 4.0.0 or later), or the TWELVEDATA_API_KEY variable.

Value

The requested data is returned as a data.frame object.

Details

ref_exchanges.

See Also

https://twelvedata.com/docs