diff --git a/openbb_terminal/cryptocurrency/due_diligence/coinbase_model.py b/openbb_terminal/cryptocurrency/due_diligence/coinbase_model.py index 36439553345..f5487758210 100644 --- a/openbb_terminal/cryptocurrency/due_diligence/coinbase_model.py +++ b/openbb_terminal/cryptocurrency/due_diligence/coinbase_model.py @@ -140,7 +140,7 @@ def get_trades( @log_start_end(log=logger) -def get_candles(symbol: str, interval: str = "24h") -> pd.DataFrame: +def get_candles(symbol: str, interval: str = "24hour") -> pd.DataFrame: """Get candles for chosen trading pair and time interval. [Source: Coinbase] Parameters @@ -148,12 +148,17 @@ def get_candles(symbol: str, interval: str = "24h") -> pd.DataFrame: symbol: str Trading pair of coins on Coinbase e.g ETH-USDT or UNI-ETH interval: str - Time interval. One from 1min, 5min ,15min, 1hour, 6hour, 24hour + Time interval. One from 1min, 5min ,15min, 1hour, 6hour, 24hour, 1day Returns ------- pd.DataFrame Candles for chosen trading pair. + + Examples + -------- + >>> from openbb_terminal.sdk import openbb + >>> openbb.crypto.dd.candle(symbol="eth-usdt", interval="24hour") """ interval_map = { diff --git a/openbb_terminal/cryptocurrency/due_diligence/coinbase_view.py b/openbb_terminal/cryptocurrency/due_diligence/coinbase_view.py index 71e2663bda1..28f6eb0f5d9 100644 --- a/openbb_terminal/cryptocurrency/due_diligence/coinbase_view.py +++ b/openbb_terminal/cryptocurrency/due_diligence/coinbase_view.py @@ -73,7 +73,7 @@ def display_trades( @log_start_end(log=logger) -def display_candles(symbol: str, interval: str = "24h", export: str = "") -> None: +def display_candles(symbol: str, interval: str = "24hour", export: str = "") -> None: """Prints table showing candles for chosen trading pair and time interval. [Source: Coinbase] Parameters @@ -81,7 +81,7 @@ def display_candles(symbol: str, interval: str = "24h", export: str = "") -> Non symbol: str Trading pair of coins on Coinbase e.g ETH-USDT or UNI-ETH interval: str - Time interval. One from 1m, 5m ,15m, 1h, 6h, 24h + Time interval. One from 1min, 5min ,15min, 1hour, 6hour, 24hour, 1day export : str Export dataframe data to csv,json,xlsx file """ diff --git a/openbb_terminal/miscellaneous/library/trail_map.csv b/openbb_terminal/miscellaneous/library/trail_map.csv index e2fee8cfda7..4ab88df81e8 100644 --- a/openbb_terminal/miscellaneous/library/trail_map.csv +++ b/openbb_terminal/miscellaneous/library/trail_map.csv @@ -124,7 +124,7 @@ crypto.dd.balance,openbb_terminal.cryptocurrency.due_diligence.binance_view.get_ crypto.dd.ob,openbb_terminal.cryptocurrency.due_diligence.ccxt_model.get_orderbook,openbb_terminal.cryptocurrency.due_diligence.ccxt_view.display_order_book crypto.dd.show_available_pairs_for_given_symbol,openbb_terminal.cryptocurrency.due_diligence.coinbase_model.show_available_pairs_for_given_symbol, crypto.dd.exchanges,openbb_terminal.cryptocurrency.due_diligence.ccxt_model.get_exchanges, -crypto.dd.candles,openbb_terminal.cryptocurrency.due_diligence.coinbase_model.get_candles,openbb_terminal.cryptocurrency.due_diligence.coinbase_view.display_candles +crypto.dd.candle,openbb_terminal.cryptocurrency.due_diligence.coinbase_model.get_candles, crypto.dd.stats,openbb_terminal.cryptocurrency.due_diligence.coinbase_model.get_product_stats,openbb_terminal.cryptocurrency.due_diligence.coinbase_view.display_stats crypto.dd.trades,openbb_terminal.cryptocurrency.due_diligence.ccxt_model.get_trades,openbb_terminal.cryptocurrency.due_diligence.ccxt_view.display_trades crypto.dd.trading_pair_info,openbb_terminal.cryptocurrency.due_diligence.coinbase_model.get_trading_pair_info,