mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-07 18:01:10 +00:00
* Adding versioning to docs --------- Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com> Co-authored-by: tehcoderer <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