mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-29 13:32:08 +00:00
* fix(docs): added margin between sections * feat: removed unused files; updated ga * fix: juan stuff doesnt work * fix: random fix * moon at noon * fix: update docusaurus config * Update controller_doc_classes.py * fix: temp fix * fix: temp fix * Update controller_doc_classes.py * fix: remove old content * fix: taggfix * init * fix: styling and moved file * Update generate_terminal_markdown.py * fix: removed unused images * fix: port new files * Update generate_sdk_markdown.py * Update controller_doc_classes.py Co-authored-by: teh_coderer <me@tehcoderer.com>
1.7 KiB
Vendored
1.7 KiB
Vendored
title, description
| title | description |
|---|---|
| ob | OpenBB SDK Function |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
ob
Returns orderbook for a coin in a given exchange
Source Code: [link]
openbb.crypto.dd.ob(exchange: str, symbol: str, to_symbol: str)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| exchange | str | exchange id | None | False |
| symbol | str | coin symbol | None | False |
| to_symbol | str | currency to compare coin against | None | False |
Returns
| Type | Description |
|---|---|
| Dict[str, Any] | With bids and asks |
Plots order book for a coin in a given exchange
Source Code: [link]
openbb.crypto.dd.ob_chart(exchange: str, symbol: str, to_symbol: str, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| exchange | str | exchange id | None | False |
| symbol | str | coin symbol | None | False |
| vs | str | currency to compare coin against | None | True |
| export | str | Export dataframe data to csv,json,xlsx file | True |
Returns
This function does not return anything