Files
OpenBB/website/content/sdk/reference/crypto/dd/oi.md
jose-donato 2e7eb4c9b6 New documentation website (#3526)
* 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>
2022-11-22 16:47:03 +00:00

1.7 KiB
Vendored

title, description
title description
oi OpenBB SDK Function

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

oi

Returns open interest by exchange for a certain symbol

Source Code: [link]

openbb.crypto.dd.oi(symbol: str, interval: int = 0)

Parameters

Name Type Description Default Optional
symbol str Crypto Symbol to search open interest futures (e.g., BTC) None False
interval int Frequency (possible values are: 0 for ALL, 2 for 1H, 1 for 4H, 4 for 12H), by default 0 0 True

Returns

Type Description
pd.DataFrame open interest by exchange and price

Plots open interest by exchange for a certain cryptocurrency

Source Code: [link]

openbb.crypto.dd.oi_chart(symbol: str, interval: int = 0, export: str = "")

Parameters

Name Type Description Default Optional
symbol str Crypto symbol to search open interest (e.g., BTC) None False
interval int Frequency (possible values are: 0 for ALL, 2 for 1H, 1 for 4H, 4 for 12H), by default 0 0 True
export str Export dataframe data to csv,json,xlsx file True

Returns

This function does not return anything