mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-06-02 07:50:42 +08: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>
2.1 KiB
Vendored
2.1 KiB
Vendored
title, description, keywords
| title | description | keywords | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| load | The documentation page describes the crypto currency load function in OpenBB's Terminal. It helps to get data for any crypto currency by specifying parameters such as symbol, start date, interval, exchange, vs_currency, end_date and the source of the data. It then returns a PD DataFrame with price and volume data. |
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
Load crypto currency to get data for
Source Code: [link]
openbb.crypto.load(symbol: str, start_date: Union[datetime.datetime, str, NoneType] = None, interval: Union[str, int] = "1440", exchange: str = "binance", vs_currency: str = "usdt", end_date: Union[datetime.datetime, str, NoneType] = None, source: str = "CCXT")
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Coin to get | None | False |
| start_date | Union[datetime, Union[str, None]] | Start date to get data from with. - datetime or string format (YYYY-MM-DD) | None | True |
| interval | Union[str, int] | The interval between data points in minutes. 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 | Union[datetime, Union[str, None]] | End date to get data from with. - datetime or string format (YYYY-MM-DD) | None | True |
| source | str | The source of the data Choose from: CCXT, CoinGecko, YahooFinance |
CCXT | True |
Returns
| Type | Description |
|---|---|
| pd.DataFrame | Dataframe consisting of price and volume data |