get_market_hours {charlesschwabapi}R Documentation

Get Market Hours

Description

Given the tokens object from the 'get_authentication_tokens' function, return a data frame containing information about the market(s) of interest and its specific hours of operation. By default, all of the markets are returned for today's date, but both the specific markets returned and the date can be tweaked. Please see the parameters for more specifics related to what can be specified for the function.

Usage

get_market_hours(
  tokens,
  markets = c("equity", "option", "bond", "future", "forex"),
  date = NULL
)

Arguments

tokens

token object from 'get_authentication_tokens' function (list).

markets

markets of interest that are "equity", "option", "bond", "future", and/or "forex". Default is all markets (string or character vector).

date

date you would like to get the hours of operation. Valid dates are today through one year from now. Default is NULL, which is today (date).

Value

Returns a data frame containing information surrounding the market of interest and its specific hours of operation.

Author(s)

Nick Bultman, njbultman74@gmail.com, July 2024


[Package charlesschwabapi version 1.0.2 Index]