Files
OpenBB/website/content/sdk/reference/crypto/load.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

40 lines
1.4 KiB
Markdown
Vendored

---
title: load
description: OpenBB SDK Function
---
# load
Load crypto currency to get data for
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/cryptocurrency_helpers.py#L489)]
```python
openbb.crypto.load(symbol: str, start_date: datetime.datetime | str | None = None, interval: str | int = "1440", exchange: str = "binance", vs_currency: str = "usdt", end_date: datetime.datetime | str | None = None, source: str = "CCXT")
```
---
## Parameters
| Name | Type | Description | Default | Optional |
| ---- | ---- | ----------- | ------- | -------- |
| symbol | str | Coin to get | None | False |
| start_date | str or datetime | Start date to get data from with. - datetime or string format (YYYY-MM-DD) | None | True |
| interval | str|int | The interval between data points in minutes.<br/>Choose from: 1, 15, 30, 60, 240, 1440, 10080, 43200 | 1440 | True |
| exchange | str: | The exchange to get data from. | binance | True |
| vs_currency | str | Quote Currency (Defaults to usdt) | usdt | True |
| end_date | str or datetime | End date to get data from with. - datetime or string format (YYYY-MM-DD) | None | True |
| source | str | The source of the data<br/>Choose from: CCXT, CoinGecko, YahooFinance | CCXT | True |
---
## Returns
| Type | Description |
| ---- | ----------- |
| pd.DataFrame | Dataframe consisting of price and volume data |
---