Files
OpenBB/website/content/sdk/reference/crypto/dd/candles.md
jose-donato 2e7eb4c9b6 New documentation website (#3526)
* fix(docs): added margin between sections

* feat: removed unused files; updated ga

* fix: juan stuff doesnt work

* fix: random fix

* moon at noon

* fix: update docusaurus config

* Update controller_doc_classes.py

* fix: temp fix

* fix: temp fix

* Update controller_doc_classes.py

* fix: remove old content

* fix: taggfix

* init

* fix: styling and moved file

* Update generate_terminal_markdown.py

* fix: removed unused images

* fix: port new files

* Update generate_sdk_markdown.py

* Update controller_doc_classes.py

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 16:47:03 +00:00

1.7 KiB
Vendored

title, description
title description
candles OpenBB SDK Function

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

candles

Get candles for chosen trading pair and time interval. [Source: Coinbase]

Source Code: [link]

openbb.crypto.dd.candles(symbol: str, interval: str = "24h")

Parameters

Name Type Description Default Optional
symbol str Trading pair of coins on Coinbase e.g ETH-USDT or UNI-ETH None False
interval str Time interval. One from 1min, 5min ,15min, 1hour, 6hour, 24hour 24h True

Returns

Type Description
pd.DataFrame Candles for chosen trading pair.

Prints table showing candles for chosen trading pair and time interval. [Source: Coinbase]

Source Code: [link]

openbb.crypto.dd.candles_chart(symbol: str, interval: str = "24h", export: str = "")

Parameters

Name Type Description Default Optional
symbol str Trading pair of coins on Coinbase e.g ETH-USDT or UNI-ETH None False
interval str Time interval. One from 1m, 5m ,15m, 1h, 6h, 24h 24h True
export str Export dataframe data to csv,json,xlsx file True

Returns

This function does not return anything