jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-03 07:51:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
948d2ef29900c48ec26616eb48ba952aaaadd883
OpenBB/website/content/sdk/reference/crypto/dd/ob.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622) 
* add first iteration of content for Terminal Pro

* Update index.md

* Update dashboards.md

* Update folders.md

* Update grouping.md

* Update report.md

* Update templates.md

* Update quick-start.md

* Update index.md

* Update index.md

* Update home.md

* Update news.md

* Update index.md

* Update index.md

* Update index.md

* Update data-provider.md

* Update chat-with-widget.md

* Update data-manipulation.md

* Update forecasting.md

* fix: images self closing tags

* fix: only pro visitors can see pro

* inter font

* improve SEO content and restructuring

* add new package for toggle on tutorials

* move folder around

* improve main page of each prod

* small updates and improvements

* fix logo above

* small improvement in headtitle for portfolio funcs

* fix typos from OpenAI's GPT-4

* fix _category_ json

* remove generic SEO words

* add script that generates SEO for documentation

* add missing file

* remove sdk warning message

* fix links for andrew

---------

Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2023-10-30 21:01:29 +00:00

2.2 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
ob This documentation page provides detailed information about operation of generating and viewing order book for a coin in a given exchange using OpenBB library. Learn about the parameters required and the response for each function call.
orderbook
openbb.crypto.dd
cryptocurrency
coin exchange
ob
ob_chart
coin symbol
exchange id
crypto trading
matplotlib.axes._axes.Axes

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

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