jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 13:01:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
2bde8e8fabaaea676615b8a05d6df0bb2bb48a91
OpenBB/website/versioned_docs/version-v3/sdk/reference/crypto/load.md
Theodore Aptekarev f72bc8ccec Add Versioned Documentation (#5470) 
* Adding versioning to docs

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-09-29 11:49:05 +02:00

1.5 KiB
Vendored
Raw Blame History

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