jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-07 18:01:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

hugo hotfix (#3359)

Browse Source 
* hotfix

* regenerate from old commit
This commit is contained in:
James Maslek
2022-11-09 17:47:27 -05:00
committed by GitHub
parent 54aaa962f9
commit d303378809
45 changed files with 150 additions and 218 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
website/content/SDK/common/qa/es/_index.rst vendored
View File

@@ -26,7 +26,7 @@ common.qa.es(
.. raw:: html
<p>
Gets Expected Shortfall for specified stock dataframe
Gets Expected Shortfall for specified stock dataframe.
</p>
* **Parameters**
@@ -47,10 +47,8 @@ common.qa.es(
* **Returns**
list
list of ES
list
list of historical ES
pd.DataFrame
DataFrame with Expected Shortfall per percentile
|
@@ -75,7 +73,7 @@ common.qa.es(
.. raw:: html
<p>
Displays expected shortfall
Displays expected shortfall.
</p>
* **Parameters**

10
website/content/SDK/common/qa/var/_index.rst vendored
View File

@@ -27,7 +27,7 @@ common.qa.var(
.. raw:: html
<p>
Gets value at risk for specified stock dataframe
Gets value at risk for specified stock dataframe.
</p>
* **Parameters**
@@ -50,10 +50,8 @@ common.qa.var(
* **Returns**
list
list of VaR
list
list of historical VaR
pd.DataFrame
DataFrame with Value at Risk per percentile
|
@@ -80,7 +78,7 @@ common.qa.var(
.. raw:: html
<p>
Displays VaR of dataframe
Displays VaR of dataframe.
</p>
* **Parameters**

4
website/content/SDK/crypto/dd/active/_index.rst vendored
View File

@@ -16,8 +16,8 @@ To obtain charts, make sure to add :python:`chart = True` as the last parameter.
crypto.dd.active(
symbol: str,
interval: str = '24h',
start_date: int = 1262304000,
end_date: int = 1667908975,
start_date: int = 1262322000,
end_date: int = 1668033690,
chart: bool = False,
) -> pandas.core.frame.DataFrame
{{< /highlight >}}

9
website/content/SDK/crypto/dd/change/_index.rst vendored
View File

@@ -2,12 +2,7 @@
:language: python
:class: highlight
<<<<<<< HEAD:website/content/SDK/crypto/dd/change/_index.md
## Get underlying data
### crypto.dd.change(symbol: str, exchange: str = 'binance', start_date: int = 1262322000, end_date: int = 1667592183) -> pandas.core.frame.DataFrame
=======
|
>>>>>>> main:website/content/SDK/crypto/dd/change/_index.rst
To obtain charts, make sure to add :python:`chart = True` as the last parameter.
@@ -21,8 +16,8 @@ To obtain charts, make sure to add :python:`chart = True` as the last parameter.
crypto.dd.change(
symbol: str,
exchange: str = 'binance',
start_date: int = 1262304000,
end_date: int = 1667908975,
start_date: int = 1262322000,
end_date: int = 1668033690,
chart: bool = False,
) -> pandas.core.frame.DataFrame
{{< /highlight >}}

2
website/content/SDK/crypto/dd/close/_index.rst vendored
View File

@@ -14,7 +14,7 @@
crypto.dd.close(
symbol: str,
start_date: str = '2010-01-01',
end_date: str = '2022-11-08',
end_date: str = '2022-11-09',
print_errors: bool = True,
chart: bool = False,
) -> pandas.core.frame.DataFrame

9
website/content/SDK/crypto/dd/eb/_index.rst vendored
View File

@@ -2,12 +2,7 @@
:language: python
:class: highlight
<<<<<<< HEAD:website/content/SDK/crypto/dd/eb/_index.md
## Get underlying data
### crypto.dd.eb(symbol: str, exchange: str = 'binance', start_date: int = 1262322000, end_date: int = 1667592183) -> pandas.core.frame.DataFrame
=======
|
>>>>>>> main:website/content/SDK/crypto/dd/eb/_index.rst
To obtain charts, make sure to add :python:`chart = True` as the last parameter.
@@ -21,8 +16,8 @@ To obtain charts, make sure to add :python:`chart = True` as the last parameter.
crypto.dd.eb(
symbol: str,
exchange: str = 'binance',
start_date: int = 1262304000,
end_date: int = 1667908975,
start_date: int = 1262322000,
end_date: int = 1668033690,
chart: bool = False,
) -> pandas.core.frame.DataFrame
{{< /highlight >}}

8
website/content/SDK/crypto/dd/gh/_index.rst vendored
View File

@@ -17,8 +17,8 @@ crypto.dd.gh(
symbol: str,
dev_activity: bool = False,
interval: str = '1d',
start_date: str = '2021-11-08T12:02:55Z',
end_date: str = '2022-11-08T12:02:55Z',
start_date: str = '2021-11-09T17:41:30Z',
end_date: str = '2022-11-09T17:41:30Z',
chart: bool = False,
) -> pandas.core.frame.DataFrame
{{< /highlight >}}
@@ -63,9 +63,9 @@ crypto.dd.gh(
{{< highlight python >}}
crypto.dd.gh(
symbol: str,
start_date: str = '2021-11-08T12:02:55Z',
start_date: str = '2021-11-09T17:41:30Z',
dev_activity: bool = False,
end_date: str = '2022-11-08T12:02:55Z',
end_date: str = '2022-11-09T17:41:30Z',
interval: str = '1d',
export: str = '',
external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None,

8
website/content/SDK/crypto/dd/mcapdom/_index.rst vendored
View File

@@ -16,8 +16,8 @@ To obtain charts, make sure to add :python:`chart = True` as the last parameter.
crypto.dd.mcapdom(
symbol: str,
interval: str = '1d',
start_date: str = '2021-11-08',
end_date: str = '2022-11-08',
start_date: str = '2021-11-09',
end_date: str = '2022-11-09',
chart: bool = False,
) -> pandas.core.frame.DataFrame
{{< /highlight >}}
@@ -59,8 +59,8 @@ crypto.dd.mcapdom(
{{< highlight python >}}
crypto.dd.mcapdom(
symbol: str,
start_date: str = '2021-11-08',
end_date: str = '2022-11-08',
start_date: str = '2021-11-09',
end_date: str = '2022-11-09',
interval: str = '1d',
export: str = '',
external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None,

8
website/content/SDK/crypto/dd/mt/_index.rst vendored
View File

@@ -17,8 +17,8 @@ crypto.dd.mt(
symbol: str,
timeseries_id: str,
interval: str = '1d',
start_date: str = '2021-11-08',
end_date: str = '2022-11-08',
start_date: str = '2021-11-09',
end_date: str = '2022-11-09',
chart: bool = False,
) -> Tuple[pandas.core.frame.DataFrame, str]
{{< /highlight >}}
@@ -65,8 +65,8 @@ crypto.dd.mt(
crypto.dd.mt(
symbol: str,
timeseries_id: str,
start_date: str = '2021-11-08',
end_date: str = '2022-11-08',
start_date: str = '2021-11-09',
end_date: str = '2022-11-09',
interval: str = '1d',
export: str = '',
external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None,

4
website/content/SDK/crypto/dd/nonzero/_index.rst vendored
View File

@@ -15,8 +15,8 @@ To obtain charts, make sure to add :python:`chart = True` as the last parameter.
{{< highlight python >}}
crypto.dd.nonzero(
symbol: str,
start_date: int = 1262304000,
end_date: int = 1667908975,
start_date: int = 1262322000,
end_date: int = 1668033690,
chart: bool = False,
) -> pandas.core.frame.DataFrame
{{< /highlight >}}

4
website/content/SDK/crypto/load/_index.rst vendored
View File

@@ -14,12 +14,12 @@
crypto.load(
symbol: 'str',
start_date: 'datetime' = datetime.datetime(
2019, 11, 4, 12, 2, 54, 720992, chart: bool = False,
2019, 11, 5, 17, 41, 30, 140491, chart: bool = False,
), interval: 'str' = '1440',
exchange: 'str' = 'binance',
vs_currency: 'str' = 'usdt',
end_date: 'datetime' = datetime.datetime(
2022, 11, 8, 12, 2, 54, 720993, chart: bool = False,
2022, 11, 9, 17, 41, 30, 140493, chart: bool = False,
), source: 'str' = 'CCXT',
chart: bool = False,
) -> 'pd.DataFrame'

4
website/content/SDK/crypto/onchain/btc_supply/_index.rst vendored
View File

@@ -37,8 +37,8 @@ crypto.onchain.btc_supply() -> pandas.core.frame.DataFrame
{{< highlight python >}}
crypto.onchain.btc_supply(
start_date: int = 1262304000,
end_date: int = 1667908975,
start_date: int = 1262322000,
end_date: int = 1668033690,
export: str = '',
external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None,
chart: bool = False,

4
website/content/SDK/crypto/onchain/btc_transac/_index.rst vendored
View File

@@ -37,8 +37,8 @@ crypto.onchain.btc_transac() -> pandas.core.frame.DataFrame
{{< highlight python >}}
crypto.onchain.btc_transac(
start_date: int = 1262304000,
end_date: int = 1667908975,
start_date: int = 1262322000,
end_date: int = 1668033690,
export: str = '',
external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None,
chart: bool = False,

8
website/content/SDK/crypto/onchain/hr/_index.rst vendored
View File

@@ -16,8 +16,8 @@ To obtain charts, make sure to add :python:`chart = True` as the last parameter.
crypto.onchain.hr(
symbol: str,
interval: str = '24h',
start_date: int = 1289476975,
end_date: int = 1667908975,
start_date: int = 1289601690,
end_date: int = 1668033690,
chart: bool = False,
) -> pandas.core.frame.DataFrame
{{< /highlight >}}
@@ -59,8 +59,8 @@ crypto.onchain.hr(
{{< highlight python >}}
crypto.onchain.hr(
symbol: str,
start_date: int = 1636372975,
end_date: int = 1667908975,
start_date: int = 1636497690,
end_date: int = 1668033690,
interval: str = '24h',
export: str = '',
external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None,

18
website/content/SDK/crypto/ov/altindex/_index.rst vendored
View File

@@ -2,12 +2,7 @@
:language: python
:class: highlight
<<<<<<< HEAD:website/content/SDK/crypto/ov/altindex/_index.md
## Get underlying data
### crypto.ov.altindex(period: int = 30, start_date: int = 1262322000, end_date: int = 1667592183) -> pandas.core.frame.DataFrame
=======
|
>>>>>>> main:website/content/SDK/crypto/ov/altindex/_index.rst
To obtain charts, make sure to add :python:`chart = True` as the last parameter.
@@ -20,8 +15,8 @@ To obtain charts, make sure to add :python:`chart = True` as the last parameter.
{{< highlight python >}}
crypto.ov.altindex(
period: int = 30,
start_date: int = 1262304000,
end_date: int = 1667908975,
start_date: int = 1262322000,
end_date: int = 1668033690,
chart: bool = False,
) -> pandas.core.frame.DataFrame
{{< /highlight >}}
@@ -52,12 +47,7 @@ crypto.ov.altindex(
pandas.DataFrame:
Date, Value (Altcoin Index)
<<<<<<< HEAD:website/content/SDK/crypto/ov/altindex/_index.md
## Getting charts
### crypto.ov.altindex(period: int = 365, start_date: int = 1262322000, end_date: int = 1667592183, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) -> None
=======
|
>>>>>>> main:website/content/SDK/crypto/ov/altindex/_index.rst
.. raw:: html
@@ -68,8 +58,8 @@ crypto.ov.altindex(
{{< highlight python >}}
crypto.ov.altindex(
period: int = 365,
start_date: int = 1262304000,
end_date: int = 1667908975,
start_date: int = 1262322000,
end_date: int = 1668033690,
export: str = '',
external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None,
chart: bool = False,

4
website/content/SDK/crypto/ov/btcrb/_index.rst vendored
View File

@@ -15,7 +15,7 @@ To obtain charts, make sure to add :python:`chart = True` as the last parameter.
{{< highlight python >}}
crypto.ov.btcrb(
start_date: str = '2010-01-01',
end_date: str = '2022-11-08',
end_date: str = '2022-11-09',
chart: bool = False,
)
{{< /highlight >}}
@@ -49,7 +49,7 @@ crypto.ov.btcrb(
{{< highlight python >}}
crypto.ov.btcrb(
start_date: str = '2010-01-01',
end_date: str = '2022-11-08',
end_date: str = '2022-11-09',
export: str = '',
external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None,
chart: bool = False,

4
website/content/SDK/economy/events/_index.rst vendored
View File

@@ -13,8 +13,8 @@
{{< highlight python >}}
economy.events(
countries: Union[List[str], str] = '',
start_date: str = '2022-11-08',
end_date: str = '2022-11-08',
start_date: str = '2022-11-09',
end_date: str = '2022-11-09',
chart: bool = False,
) -> pandas.core.frame.DataFrame
{{< /highlight >}}

14
website/content/SDK/economy/macro/_index.rst vendored
View File

@@ -2,12 +2,7 @@
:language: python
:class: highlight
<<<<<<< HEAD:website/content/SDK/economy/macro/_index.md
## Get underlying data
### economy.macro(parameters: list = None, countries: list = None, transform: str = '', start_date: str = '1900-01-01', end_date=datetime.date(2022, 11, 4), symbol: str = '') -> Tuple[Any, Dict[Any, Dict[Any, Any]], str]
=======
|
>>>>>>> main:website/content/SDK/economy/macro/_index.rst
To obtain charts, make sure to add :python:`chart = True` as the last parameter.
@@ -24,7 +19,7 @@ economy.macro(
transform: str = '',
start_date: str = '1900-01-01',
end_date=datetime.date(
2022, 11, 8, chart: bool = False,
2022, 11, 9, chart: bool = False,
), symbol: str = '',
chart: bool = False,
) -> Tuple[Any, Dict[Any, Dict[Any, Any]], str]
@@ -63,12 +58,7 @@ economy.macro(
str
Denomination which can be Trillions, Billions, Millions, Thousands
<<<<<<< HEAD:website/content/SDK/economy/macro/_index.md
## Getting charts
### economy.macro(parameters: list = None, countries: list = None, transform: str = '', start_date: str = '1900-01-01', end_date: str = '2022-11-04', symbol: str = '', raw: bool = False, external_axes: Optional[List[axes]] = None, export: str = '', chart=True)
=======
|
>>>>>>> main:website/content/SDK/economy/macro/_index.rst
.. raw:: html
@@ -82,7 +72,7 @@ economy.macro(
countries: list = None,
transform: str = '',
start_date: str = '1900-01-01',
end_date: str = '2022-11-08',
end_date: str = '2022-11-09',
symbol: str = '',
raw: bool = False,
external_axes: Optional[List[axes]] = None,

14
website/content/SDK/economy/treasury/_index.rst vendored
View File

@@ -2,12 +2,7 @@
:language: python
:class: highlight
<<<<<<< HEAD:website/content/SDK/economy/treasury/_index.md
## Get underlying data
### economy.treasury(instruments: list = None, maturities: list = None, frequency: str = 'monthly', start_date: str = '1900-01-01', end_date: str = '2022-11-04') -> pandas.core.frame.DataFrame
=======
|
>>>>>>> main:website/content/SDK/economy/treasury/_index.rst
To obtain charts, make sure to add :python:`chart = True` as the last parameter.
@@ -23,7 +18,7 @@ economy.treasury(
maturities: list = None,
frequency: str = 'monthly',
start_date: str = '1900-01-01',
end_date: str = '2022-11-08',
end_date: str = '2022-11-09',
chart: bool = False,
) -> pandas.core.frame.DataFrame
{{< /highlight >}}
@@ -56,12 +51,7 @@ economy.treasury(
treasury_data: pd.Dataframe
Holds data of the selected types and maturities
<<<<<<< HEAD:website/content/SDK/economy/treasury/_index.md
## Getting charts
### economy.treasury(instruments: list = None, maturities: list = None, frequency: str = 'monthly', start_date: str = '1900-01-01', end_date: str = '2022-11-04', raw: bool = False, external_axes: Optional[List[axes]] = None, export: str = '', chart=True)
=======
|
>>>>>>> main:website/content/SDK/economy/treasury/_index.rst
.. raw:: html
@@ -75,7 +65,7 @@ economy.treasury(
maturities: list = None,
frequency: str = 'monthly',
start_date: str = '1900-01-01',
end_date: str = '2022-11-08',
end_date: str = '2022-11-09',
raw: bool = False,
external_axes: Optional[List[axes]] = None,
export: str = '',

23
website/content/SDK/etf/candle/_index.rst vendored
View File

@@ -1,11 +1,6 @@
<<<<<<< HEAD:website/content/SDK/etf/candle/_index.md
## Get underlying data
### etf.candle(symbol: str, data: pandas.core.frame.DataFrame = None, use_matplotlib: bool = True, intraday: bool = False, add_trend: bool = False, ma: Optional[Iterable[int]] = None, asset_type: str = '', start_date: datetime.datetime = datetime.datetime(2019, 10, 31, 16, 3, 2, 269455), interval: int = 1440, end_date: datetime.datetime = datetime.datetime(2022, 11, 4, 16, 3, 2, 269462), prepost: bool = False, source: str = 'YahooFinance', iexrange: str = 'ytd', weekly: bool = False, monthly: bool = False, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, raw: bool = False, yscale: str = 'linear')
=======
.. role:: python(code)
:language: python
:class: highlight
>>>>>>> main:website/content/SDK/etf/candle/_index.rst
|
@@ -24,11 +19,13 @@ etf.candle(
add_trend: bool = False,
ma: Optional[Iterable[int]] = None,
asset_type: str = '',
start_date: datetime.datetime = datetime.datetime(
2019, 11, 4, 12, 2, 54, 348838, chart: bool = False,
start_date: Union[datetime.datetime, str,
NoneType] = datetime.datetime(
2019, 11, 5, 17, 41, 30, 338404, chart: bool = False,
), interval: int = 1440,
end_date: datetime.datetime = datetime.datetime(
2022, 11, 8, 12, 2, 54, 348849, chart: bool = False,
end_date: Union[datetime.datetime, str,
NoneType] = datetime.datetime(
2022, 11, 9, 17, 41, 30, 338406, chart: bool = False,
), prepost: bool = False,
source: str = 'YahooFinance',
iexrange: str = 'ytd',
@@ -69,12 +66,12 @@ etf.candle(
External axes (2 axes are expected in the list), by default None
asset_type\_: str
String to include in title
start_date: datetime
Start date to get data from with
start_date: str or datetime, optional
Start date to get data from with. - datetime or string format (YYYY-MM-DD)
interval: int
Interval (in minutes) to get data 1, 5, 15, 30, 60 or 1440
end_date: datetime
End date to get data from with
end_date: str or datetime, optional
End date to get data from with. - datetime or string format (YYYY-MM-DD)
prepost: bool
Pre and After hours data
source: str

20
website/content/SDK/etf/load/_index.rst vendored
View File

@@ -13,10 +13,14 @@
{{< highlight python >}}
etf.load(
symbol: str,
start_date: datetime.datetime = None,
interval: int = 1440,
end_date: datetime.datetime = None,
prepost: bool = False,
start_date: Union[datetime.datetime, str,
NoneType] = datetime.datetime(
2019, 11, 5, 17, 41, 30, 338385, chart: bool = False,
), interval: int = 1440,
end_date: Union[datetime.datetime, str,
NoneType] = datetime.datetime(
2022, 11, 9, 17, 41, 30, 338397, chart: bool = False,
), prepost: bool = False,
source: str = 'YahooFinance',
iexrange: str = 'ytd',
weekly: bool = False,
@@ -64,12 +68,12 @@ etf.load(
symbol: str
Ticker to get data
start_date: datetime
Start date to get data from with
start_date: str or datetime, optional
Start date to get data from with. - datetime or string format (YYYY-MM-DD)
interval: int
Interval (in minutes) to get data 1, 5, 15, 30, 60 or 1440
end_date: datetime
End date to get data from with
end_date: str or datetime, optional
End date to get data from with. - datetime or string format (YYYY-MM-DD)
prepost: bool
Pre and After hours data
source: str

4
website/content/SDK/etf/news/_index.rst vendored
View File

@@ -16,7 +16,7 @@ To obtain charts, make sure to add :python:`chart = True` as the last parameter.
etf.news(
query: str,
limit: int = 10,
start_date: str = '2022-11-01',
start_date: str = '2022-11-02',
show_newest: bool = True,
sources: str = '',
chart: bool = False,
@@ -60,7 +60,7 @@ etf.news(
etf.news(
query: str,
limit: int = 3,
start_date: str = '2022-11-01',
start_date: str = '2022-11-02',
show_newest: bool = True,
sources: str = '',
export: str = '',

3
website/content/SDK/forex/candle/_index.rst vendored
View File

@@ -17,6 +17,9 @@ forex.candle(
from_symbol: str = '',
ma: Optional[Iterable[int]] = None,
external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None,
use_matplotlib: bool = True,
add_trend: bool = False,
yscale: str = 'linear',
chart: bool = False,
)
{{< /highlight >}}

7
website/content/SDK/forex/load/_index.rst vendored
View File

@@ -1,11 +1,6 @@
<<<<<<< HEAD:website/content/SDK/forex/load/_index.md
## Get underlying data
### forex.load(to_symbol: str, from_symbol: str, resolution: str = 'd', interval: str = '1day', start_date: str = '2021-11-04', source: str = 'YahooFinance', verbose: bool = True) -> pandas.core.frame.DataFrame
=======
.. role:: python(code)
:language: python
:class: highlight
>>>>>>> main:website/content/SDK/forex/load/_index.rst
|
@@ -21,7 +16,7 @@ forex.load(
from_symbol: str,
resolution: str = 'd',
interval: str = '1day',
start_date: str = '2021-11-08',
start_date: str = '2021-11-09',
source: str = 'YahooFinance',
verbose: bool = True,
chart: bool = False,

12
website/content/SDK/futures/curve/_index.rst vendored
View File

@@ -14,7 +14,7 @@ To obtain charts, make sure to add :python:`chart = True` as the last parameter.
{{< highlight python >}}
futures.curve(
ticker: str = '',
symbol: str = '',
chart: bool = False,
)
{{< /highlight >}}
@@ -27,8 +27,8 @@ futures.curve(
* **Parameters**
ticker: str
Ticker to get forward curve
symbol: str
symbol to get forward curve
chart: *bool*
Flag to display chart
@@ -43,7 +43,7 @@ futures.curve(
{{< highlight python >}}
futures.curve(
ticker: str,
symbol: str,
raw: bool = False,
export: str = '',
external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None,
@@ -59,8 +59,8 @@ futures.curve(
* **Parameters**
ticker: str
Curve future ticker to display
symbol: str
Curve future symbol to display
raw: bool
Display futures timeseries in raw format
export: str

14
website/content/SDK/futures/historical/_index.rst vendored
View File

@@ -14,7 +14,7 @@ To obtain charts, make sure to add :python:`chart = True` as the last parameter.
{{< highlight python >}}
futures.historical(
tickers: List[str],
symbols: List[str],
expiry: str = '',
chart: bool = False,
) -> Dict
@@ -28,8 +28,8 @@ futures.historical(
* **Parameters**
tickers: List[str]
List of future timeseries tickers to display
symbols: List[str]
List of future timeseries symbols to display
expiry: str
Future expiry date with format YYYY-MM
chart: *bool*
@@ -51,9 +51,9 @@ futures.historical(
{{< highlight python >}}
futures.historical(
tickers: List[str],
symbols: List[str],
expiry: str = '',
start_date: str = '2019-11-09',
start_date: str = '2019-11-10',
raw: bool = False,
export: str = '',
external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None,
@@ -69,8 +69,8 @@ futures.historical(
* **Parameters**
tickers: List[str]
List of future timeseries tickers to display
symbols: List[str]
List of future timeseries symbols to display
expiry: str
Future expiry date with format YYYY-MM
start_date : str

6
website/content/SDK/portfolio/holdp/_index.rst vendored
View File

@@ -44,7 +44,7 @@ portfolio.holdp(
{{< highlight python >}}
portfolio.holdp(
portfolio: openbb_terminal.portfolio.portfolio_model.PortfolioModel,
sum_assets: bool = False,
unstack: bool = False,
raw: bool = False,
limit: int = 10,
export: str = '',
@@ -63,8 +63,8 @@ portfolio.holdp(
portfolio: Portfolio
Portfolio object with trades loaded
sum_assets: bool
Sum assets over time
unstack: bool
Individual assets over time
raw : bool
To display raw data
limit : int

6
website/content/SDK/portfolio/holdv/_index.rst vendored
View File

@@ -49,7 +49,7 @@ portfolio.holdv(
{{< highlight python >}}
portfolio.holdv(
portfolio: openbb_terminal.portfolio.portfolio_model.PortfolioModel,
sum_assets: bool = False,
unstack: bool = False,
raw: bool = False,
limit: int = 10,
export: str = '',
@@ -68,8 +68,8 @@ portfolio.holdv(
portfolio: Portfolio
Portfolio object with trades loaded
sum_assets: bool
Sum assets over time
unstack: bool
Individual assets over time
raw : bool
To display raw data
limit : int

3
website/content/SDK/portfolio/perf/_index.rst vendored
View File

@@ -13,7 +13,6 @@
{{< highlight python >}}
portfolio.perf(
portfolio: openbb_terminal.portfolio.portfolio_model.PortfolioModel,
interval: str = 'all',
show_all_trades: bool = False,
chart: bool = False,
) -> pandas.core.frame.DataFrame
@@ -29,8 +28,6 @@ portfolio.perf(
portfolio: Portfolio
Portfolio object with trades loaded
interval : str
interval to consider performance. From: mtd, qtd, ytd, 3m, 6m, 1y, 3y, 5y, 10y, all
show_all_trades: bool
Whether to also show all trades made and their performance (default is False)

4
website/content/SDK/stocks/ba/cnews/_index.rst vendored
View File

@@ -13,8 +13,8 @@
{{< highlight python >}}
stocks.ba.cnews(
symbol: str,
start_date: str = '2022-10-09',
end_date: str = '2022-11-08',
start_date: str = '2022-10-10',
end_date: str = '2022-11-09',
chart: bool = False,
) -> List[Dict]
{{< /highlight >}}

8
website/content/SDK/stocks/ba/hist/_index.rst vendored
View File

@@ -15,8 +15,8 @@ To obtain charts, make sure to add :python:`chart = True` as the last parameter.
{{< highlight python >}}
stocks.ba.hist(
symbol: str,
start_date: str = '2022-11-01',
end_date: str = '2022-11-08',
start_date: str = '2022-11-02',
end_date: str = '2022-11-09',
number: int = 100,
chart: bool = False,
) -> pandas.core.frame.DataFrame
@@ -61,8 +61,8 @@ stocks.ba.hist(
{{< highlight python >}}
stocks.ba.hist(
symbol: str,
start_date: str = '2022-11-01',
end_date: str = '2022-11-08',
start_date: str = '2022-11-02',
end_date: str = '2022-11-09',
number: int = 100,
raw: bool = False,
limit: int = 10,

4
website/content/SDK/stocks/ba/trend/_index.rst vendored
View File

@@ -15,7 +15,7 @@ To obtain charts, make sure to add :python:`chart = True` as the last parameter.
{{< highlight python >}}
stocks.ba.trend(
start_date: datetime.datetime = datetime.datetime(
2022, 11, 8, 12, 2, 54, 989242, chart: bool = False,
2022, 11, 9, 17, 41, 29, 364353, chart: bool = False,
), hour: int = 0,
number: int = 10,
chart: bool = False,
@@ -60,7 +60,7 @@ stocks.ba.trend(
{{< highlight python >}}
stocks.ba.trend(
start_date: datetime.datetime = datetime.datetime(
2022, 11, 8, 12, 2, 54, 989446, chart: bool = False,
2022, 11, 9, 17, 41, 29, 364749, chart: bool = False,
), hour: int = 0,
number: int = 10,
limit: int = 10,

15
website/content/SDK/stocks/ca/hcorr/_index.rst vendored
View File

@@ -2,12 +2,7 @@
:language: python
:class: highlight
<<<<<<< HEAD:website/content/SDK/stocks/ca/hcorr/_index.md
## Get underlying data
### stocks.ca.hcorr(similar: List[str], start_date: str = '2021-11-03', candle_type: str = 'a')
=======
|
>>>>>>> main:website/content/SDK/stocks/ca/hcorr/_index.rst
To obtain charts, make sure to add :python:`chart = True` as the last parameter.
@@ -20,7 +15,7 @@ To obtain charts, make sure to add :python:`chart = True` as the last parameter.
{{< highlight python >}}
stocks.ca.hcorr(
similar: List[str],
start_date: str = '2021-11-07',
start_date: str = '2021-11-08',
candle_type: str = 'a',
chart: bool = False,
)
@@ -42,14 +37,8 @@ stocks.ca.hcorr(
Start date of comparison, by default 1 year ago
candle_type : str, optional
OHLCA column to use for candles or R for returns, by default "a" for Adjusted Close
<<<<<<< HEAD:website/content/SDK/stocks/ca/hcorr/_index.md
## Getting charts
### stocks.ca.hcorr(similar: List[str], start_date: str = '2021-11-03', candle_type: str = 'a', display_full_matrix: bool = False, raw: bool = False, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, export: str = '', chart=True)
=======
chart: *bool*
Flag to display chart
>>>>>>> main:website/content/SDK/stocks/ca/hcorr/_index.rst
|
@@ -63,7 +52,7 @@ stocks.ca.hcorr(
{{< highlight python >}}
stocks.ca.hcorr(
similar: List[str],
start_date: str = '2021-11-07',
start_date: str = '2021-11-08',
candle_type: str = 'a',
display_full_matrix: bool = False,
raw: bool = False,

14
website/content/SDK/stocks/ca/hist/_index.rst vendored
View File

@@ -2,12 +2,7 @@
:language: python
:class: highlight
<<<<<<< HEAD:website/content/SDK/stocks/ca/hist/_index.md
## Get underlying data
### stocks.ca.hist(similar: List[str], start_date: str = '2021-11-03', candle_type: str = 'a') -> pandas.core.frame.DataFrame
=======
|
>>>>>>> main:website/content/SDK/stocks/ca/hist/_index.rst
To obtain charts, make sure to add :python:`chart = True` as the last parameter.
@@ -20,7 +15,7 @@ To obtain charts, make sure to add :python:`chart = True` as the last parameter.
{{< highlight python >}}
stocks.ca.hist(
similar: List[str],
start_date: str = '2021-11-07',
start_date: str = '2021-11-08',
candle_type: str = 'a',
chart: bool = False,
) -> pandas.core.frame.DataFrame
@@ -51,12 +46,7 @@ stocks.ca.hist(
pd.DataFrame
Dataframe containing candle type variable for each ticker
<<<<<<< HEAD:website/content/SDK/stocks/ca/hist/_index.md
## Getting charts
### stocks.ca.hist(similar: List[str], start_date: str = '2021-11-03', candle_type: str = 'a', normalize: bool = True, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True)
=======
|
>>>>>>> main:website/content/SDK/stocks/ca/hist/_index.rst
.. raw:: html
@@ -67,7 +57,7 @@ stocks.ca.hist(
{{< highlight python >}}
stocks.ca.hist(
similar: List[str],
start_date: str = '2021-11-07',
start_date: str = '2021-11-08',
candle_type: str = 'a',
normalize: bool = True,
export: str = '',

4
website/content/SDK/stocks/ca/volume/_index.rst vendored
View File

@@ -15,7 +15,7 @@ To obtain charts, make sure to add :python:`chart = True` as the last parameter.
{{< highlight python >}}
stocks.ca.volume(
similar: List[str],
start_date: str = '2021-11-07',
start_date: str = '2021-11-08',
chart: bool = False,
) -> pandas.core.frame.DataFrame
{{< /highlight >}}
@@ -49,7 +49,7 @@ stocks.ca.volume(
{{< highlight python >}}
stocks.ca.volume(
similar: List[str],
start_date: str = '2021-11-07',
start_date: str = '2021-11-08',
export: str = '',
external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None,
chart: bool = False,

23
website/content/SDK/stocks/candle/_index.rst vendored
View File

@@ -1,11 +1,6 @@
<<<<<<< HEAD:website/content/SDK/stocks/candle/_index.md
## Get underlying data
### stocks.candle(symbol: str, data: pandas.core.frame.DataFrame = None, use_matplotlib: bool = True, intraday: bool = False, add_trend: bool = False, ma: Optional[Iterable[int]] = None, asset_type: str = '', start_date: datetime.datetime = datetime.datetime(2019, 10, 31, 16, 3, 2, 269455), interval: int = 1440, end_date: datetime.datetime = datetime.datetime(2022, 11, 4, 16, 3, 2, 269462), prepost: bool = False, source: str = 'YahooFinance', iexrange: str = 'ytd', weekly: bool = False, monthly: bool = False, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, raw: bool = False, yscale: str = 'linear')
=======
.. role:: python(code)
:language: python
:class: highlight
>>>>>>> main:website/content/SDK/stocks/candle/_index.rst
|
@@ -24,11 +19,13 @@ stocks.candle(
add_trend: bool = False,
ma: Optional[Iterable[int]] = None,
asset_type: str = '',
start_date: datetime.datetime = datetime.datetime(
2019, 11, 4, 12, 2, 54, 348838, chart: bool = False,
start_date: Union[datetime.datetime, str,
NoneType] = datetime.datetime(
2019, 11, 5, 17, 41, 30, 338404, chart: bool = False,
), interval: int = 1440,
end_date: datetime.datetime = datetime.datetime(
2022, 11, 8, 12, 2, 54, 348849, chart: bool = False,
end_date: Union[datetime.datetime, str,
NoneType] = datetime.datetime(
2022, 11, 9, 17, 41, 30, 338406, chart: bool = False,
), prepost: bool = False,
source: str = 'YahooFinance',
iexrange: str = 'ytd',
@@ -69,12 +66,12 @@ stocks.candle(
External axes (2 axes are expected in the list), by default None
asset_type\_: str
String to include in title
start_date: datetime
Start date to get data from with
start_date: str or datetime, optional
Start date to get data from with. - datetime or string format (YYYY-MM-DD)
interval: int
Interval (in minutes) to get data 1, 5, 15, 30, 60 or 1440
end_date: datetime
End date to get data from with
end_date: str or datetime, optional
End date to get data from with. - datetime or string format (YYYY-MM-DD)
prepost: bool
Pre and After hours data
source: str

2
website/content/SDK/stocks/dd/pt/_index.rst vendored
View File

@@ -50,7 +50,7 @@ stocks.dd.pt(
stocks.dd.pt(
symbol: str,
data: pandas.core.frame.DataFrame,
start_date: str = '2022-11-08',
start_date: str = '2022-11-09',
limit: int = 10,
raw: bool = False,
export: str = '',

2
website/content/SDK/stocks/disc/dividends/_index.rst vendored
View File

@@ -12,7 +12,7 @@
{{< highlight python >}}
stocks.disc.dividends(
date: str = '2022-11-08',
date: str = '2022-11-09',
chart: bool = False,
) -> pandas.core.frame.DataFrame
{{< /highlight >}}

4
website/content/SDK/stocks/disc/ipo/_index.rst vendored
View File

@@ -12,8 +12,8 @@
{{< highlight python >}}
stocks.disc.ipo(
start_date: str = '2022-11-03',
end_date: str = '2022-11-08',
start_date: str = '2022-11-04',
end_date: str = '2022-11-09',
chart: bool = False,
) -> pandas.core.frame.DataFrame
{{< /highlight >}}

8
website/content/SDK/stocks/dps/ftd/_index.rst vendored
View File

@@ -15,8 +15,8 @@ To obtain charts, make sure to add :python:`chart = True` as the last parameter.
{{< highlight python >}}
stocks.dps.ftd(
symbol: str,
start_date: str = '2022-09-09',
end_date: str = '2022-11-08',
start_date: str = '2022-09-10',
end_date: str = '2022-11-09',
limit: int = 0,
chart: bool = False,
) -> pandas.core.frame.DataFrame
@@ -59,8 +59,8 @@ stocks.dps.ftd(
stocks.dps.ftd(
symbol: str,
data: pandas.core.frame.DataFrame,
start_date: str = '2022-09-09',
end_date: str = '2022-11-08',
start_date: str = '2022-09-10',
end_date: str = '2022-11-09',
limit: int = 0,
raw: bool = False,
export: str = '',

4
website/content/SDK/stocks/fa/mktcap/_index.rst vendored
View File

@@ -15,7 +15,7 @@ To obtain charts, make sure to add :python:`chart = True` as the last parameter.
{{< highlight python >}}
stocks.fa.mktcap(
symbol: str,
start_date: str = '2019-11-06',
start_date: str = '2019-11-07',
chart: bool = False,
) -> Tuple[pandas.core.frame.DataFrame, str]
{{< /highlight >}}
@@ -54,7 +54,7 @@ stocks.fa.mktcap(
{{< highlight python >}}
stocks.fa.mktcap(
symbol: str,
start_date: str = '2019-11-06',
start_date: str = '2019-11-07',
export: str = '',
external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None,
chart: bool = False,

2
website/content/SDK/stocks/ins/act/_index.rst vendored
View File

@@ -50,7 +50,7 @@ stocks.ins.act(
stocks.ins.act(
data: pandas.core.frame.DataFrame,
symbol: str,
start_date: str = '2019-11-04',
start_date: str = '2019-11-05',
interval: str = '1440min',
limit: int = 10,
raw: bool = False,

20
website/content/SDK/stocks/load/_index.rst vendored
View File

@@ -13,10 +13,14 @@
{{< highlight python >}}
stocks.load(
symbol: str,
start_date: datetime.datetime = None,
interval: int = 1440,
end_date: datetime.datetime = None,
prepost: bool = False,
start_date: Union[datetime.datetime, str,
NoneType] = datetime.datetime(
2019, 11, 5, 17, 41, 30, 338385, chart: bool = False,
), interval: int = 1440,
end_date: Union[datetime.datetime, str,
NoneType] = datetime.datetime(
2022, 11, 9, 17, 41, 30, 338397, chart: bool = False,
), prepost: bool = False,
source: str = 'YahooFinance',
iexrange: str = 'ytd',
weekly: bool = False,
@@ -64,12 +68,12 @@ stocks.load(
symbol: str
Ticker to get data
start_date: datetime
Start date to get data from with
start_date: str or datetime, optional
Start date to get data from with. - datetime or string format (YYYY-MM-DD)
interval: int
Interval (in minutes) to get data 1, 5, 15, 30, 60 or 1440
end_date: datetime
End date to get data from with
end_date: str or datetime, optional
End date to get data from with. - datetime or string format (YYYY-MM-DD)
prepost: bool
Pre and After hours data
source: str

4
website/content/SDK/stocks/options/pcr/_index.rst vendored
View File

@@ -16,7 +16,7 @@ To obtain charts, make sure to add :python:`chart = True` as the last parameter.
stocks.options.pcr(
symbol: str,
window: int = 30,
start_date: str = '2021-11-07',
start_date: str = '2021-11-08',
chart: bool = False,
) -> pandas.core.frame.DataFrame
{{< /highlight >}}
@@ -51,7 +51,7 @@ stocks.options.pcr(
stocks.options.pcr(
symbol: str,
window: int = 30,
start_date: str = '2021-11-07',
start_date: str = '2021-11-08',
export: str = '',
external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None,
chart: bool = False,

6
website/content/SDK/stocks/screener/historical/_index.rst vendored
View File

@@ -16,11 +16,11 @@ To obtain charts, make sure to add :python:`chart = True` as the last parameter.
stocks.screener.historical(
preset_loaded: str = 'top_gainers',
limit: int = 10,
start_date: str = '2022-05-12',
start_date: str = '2022-05-13',
type_candle: str = 'a',
normalize: bool = True,
chart: bool = False,
)
) -> Tuple[pandas.core.frame.DataFrame, List[str], bool]
{{< /highlight >}}
.. raw:: html
@@ -66,7 +66,7 @@ stocks.screener.historical(
stocks.screener.historical(
preset_loaded: str = 'top_gainers',
limit: int = 10,
start_date: str = '2022-05-12',
start_date: str = '2022-05-13',
type_candle: str = 'a',
normalize: bool = True,
export: str = '',