R/crypto_symbols.R

In threadingdata/finnhubr: Integration with Finnhub.io API

#' @title Cryptocurrency Symbols for Exchange
#' @description Get symbols from selected cryptocurrency exchange
#'   
#' @param exchange Crypto Exchanges - COINBASE, GEMINI, Binance, BITFINIX, KRAKEN, etc.
#' 
#' @importFrom purrr set_names
#' 
#' @return
#' @export
#' 
#' @examples
#' crypto_symbols(exchange = 'COINBASE')
#' all_cryptos <- crypto_exchanges() %>% 
#'    dplyr::pull(crypto_exchange) %>% 
#'    purrr::map(crypto_symbols) %>% 
#'    dplyr::bind_rows()
crypto_symbols <- function(exchange = 'COINBASE', ...){
  
  url <- finnhub_endpoint('crypto_symbols')
  
  df <- retry_get(url, 
                  query = list(token = finnhub_key(),
                               exchange = exchange)
  )
  df %>% 
    purrr::set_names(c('description', 'display_symbol', 'symbol'))
}