Files
OpenBB/website/content/sdk/reference/crypto/load.md
teh_coderer 79046608b6 Docs Fix (#3543)
* Update generate_terminal_markdown.py

* updates

* update workflows

* Automated Change

* tests

* tests

* Automated Change

* Update test_generate_docs.py

* Automated Change

* updates

* Automated Change

* Update gen-docs.yml

* Update test.yml

* Automated Change

* Update test.yml

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* test

* Automated Change

* testtt23

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* Automated Change

* added empting reference folders before autogen docs

* updates

* Automated Change

* update tests gitactions

* Automated Change

* up

* Automated Change

* Automated Change

* update pytest

* Automated Change

* tests

* Automated Change

* examples update

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* Update test.yml

* Update generate_sdk_markdown.py

* strip

* Automated Change

* Workflow : check test update

* Automated Change

* Automated Change

* Automated Change

* Update test.yml

* Automated Change

* Update test.yml

* Automated Change

* Automated Change

* up

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* update workflows

* fix guides

* testing

* Update gh-pages.yml

* Update gh-pages.yml

Co-authored-by: tehcoderer <tehcoderer@users.noreply.github.com>
Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
Co-authored-by: Chavithra <Chavithra@users.noreply.github.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
2022-11-25 17:19:08 -05:00

1.5 KiB
Vendored

title, description
title description
load OpenBB SDK Function

load

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