mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-08 10:22:09 +00:00
cd420c51c7
* example changes in slopes * change lettering size and side bar capitalization * revert back to Fira * start automatic website generation * this was autogen * add examples to slopes model * generate slopes doc * change to _index.md * allow italic formatting * fix regex * option to regenerate paths * update alt docs * fix generate * update alt * fix generate * update common * target italic only for types * format alt * format italic common * add sig indentation * update sig indent alt * update common ident * add todo * generate docstrings for all menus * fix maxdd * fix returns font size * fix keys docs * fix more docstrings * escape literal symbols * escape literal symbols * reformat keys * format opt * remove literal escape * remove another literal escape * remove another literal escape * unindent returns * update docs return unindent * add comma in last arg * fix funcs without params * fix signature * compact some code * refactor some more code * refactor some code * some final cleanup * write docstrings * change main * move futures paths * generate futures docs * add external axes references * fix typo * revert to double docstring * fix small bug * remove docs folder * generate.py in website folder * add forecast to docs * clear some warnings * fix underscore * remove cite * refresh website docs * fix forecast docstrings * fix po * fix po docs and remove italic * fix more docstrings * remove last warning * codespell * flake8 * exclude website contente from flake * noqa on optimizer * update website * fix mypy * remove setup from mypy * mypy to openbbterminal * update precommit * pylint * try to remove sdk loading issue * avoid logging on test Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
74 lines
1.2 KiB
ReStructuredText
Vendored
74 lines
1.2 KiB
ReStructuredText
Vendored
.. role:: python(code)
|
|
:language: python
|
|
:class: highlight
|
|
|
|
|
|
|
|
|
To obtain charts, make sure to add :python:`chart = True` as the last parameter.
|
|
|
|
.. raw:: html
|
|
|
|
<h3>
|
|
> Getting data
|
|
</h3>
|
|
|
|
{{< highlight python >}}
|
|
crypto.dd.basic(
|
|
symbol: str = 'btc-bitcoin',
|
|
chart: bool = False,
|
|
) -> pandas.core.frame.DataFrame
|
|
{{< /highlight >}}
|
|
|
|
.. raw:: html
|
|
|
|
<p>
|
|
Basic coin information [Source: CoinPaprika]
|
|
</p>
|
|
|
|
* **Parameters**
|
|
|
|
symbol: str
|
|
Coin id
|
|
chart: *bool*
|
|
Flag to display chart
|
|
|
|
|
|
* **Returns**
|
|
|
|
pd.DataFrame
|
|
Metric, Value
|
|
|
|
|
|
|
|
|
.. raw:: html
|
|
|
|
<h3>
|
|
> Getting charts
|
|
</h3>
|
|
|
|
{{< highlight python >}}
|
|
crypto.dd.basic(
|
|
symbol: str = 'BTC',
|
|
export: str = '',
|
|
chart: bool = False,
|
|
) -> None
|
|
{{< /highlight >}}
|
|
|
|
.. raw:: html
|
|
|
|
<p>
|
|
Get basic information for coin. Like:
|
|
name, symbol, rank, type, description, platform, proof_type, contract, tags, parent.
|
|
[Source: CoinPaprika]
|
|
</p>
|
|
|
|
* **Parameters**
|
|
|
|
symbol: str
|
|
Cryptocurrency symbol (e.g. BTC)
|
|
export: str
|
|
Export dataframe data to csv,json,xlsx
|
|
chart: *bool*
|
|
Flag to display chart
|
|
|