Skip to contents

Retrieve live market overview snapshots across global benchmark indices, commodities, currencies, and futures.

Usage

get_market_summary(as_tibble = TRUE)

Arguments

as_tibble

Logical; if TRUE (default), returns a tidy tibble. If FALSE, returns the raw nested list from the API.

Value

If as_tibble = TRUE, a tibble with 9 columns: symbol, short_name, regular_market_price, regular_market_change, regular_market_change_percent, regular_market_previous_close, market_state, exchange, market_time (POSIXct, UTC). If as_tibble = FALSE, a nested list. Returns an empty tibble (or invisible(NULL)) on failure.

See also

Examples

if (FALSE) { # \dontrun{
# Tidy tibble output (default)
market_df <- get_market_summary()

# Raw list output
market_list <- get_market_summary(as_tibble = FALSE)
} # }