mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-04 00:12:29 +00:00
4ad995fdd0
* add first iteration of content for Terminal Pro * Update index.md * Update dashboards.md * Update folders.md * Update grouping.md * Update report.md * Update templates.md * Update quick-start.md * Update index.md * Update index.md * Update home.md * Update news.md * Update index.md * Update index.md * Update index.md * Update data-provider.md * Update chat-with-widget.md * Update data-manipulation.md * Update forecasting.md * fix: images self closing tags * fix: only pro visitors can see pro * inter font * improve SEO content and restructuring * add new package for toggle on tutorials * move folder around * improve main page of each prod * small updates and improvements * fix logo above * small improvement in headtitle for portfolio funcs * fix typos from OpenAI's GPT-4 * fix _category_ json * remove generic SEO words * add script that generates SEO for documentation * add missing file * remove sdk warning message * fix links for andrew --------- Co-authored-by: jose-donato <zmcdonato@gmail.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
88 lines
2.3 KiB
Markdown
Vendored
88 lines
2.3 KiB
Markdown
Vendored
---
|
|
title: candles
|
|
description: This page provides documentation on how to get or chart candles for a
|
|
chosen trading pair and time interval on Coinbase using the OpenBB crypto library.
|
|
It includes the Python code for these functions and the parameters to use.
|
|
keywords:
|
|
- OpenBB crypto library
|
|
- candles trading pair
|
|
- time interval
|
|
- Coinbase
|
|
- Python function
|
|
- Cryptocurrency trading
|
|
- Crypto trading analysis
|
|
- Cryptocurrency pairs
|
|
- Trade charting
|
|
- Data export
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="crypto.dd.candles - Reference | OpenBB SDK Docs" />
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
<Tabs>
|
|
<TabItem value="model" label="Model" default>
|
|
|
|
Get candles for chosen trading pair and time interval. [Source: Coinbase]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinbase_model.py#L143)]
|
|
|
|
```python
|
|
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. |
|
|
---
|
|
|
|
</TabItem>
|
|
<TabItem value="view" label="Chart">
|
|
|
|
Prints table showing candles for chosen trading pair and time interval. [Source: Coinbase]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinbase_view.py#L76)]
|
|
|
|
```python
|
|
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
|
|
|
|
---
|
|
|
|
</TabItem>
|
|
</Tabs>
|