jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-07 01:41:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e7abffee64aec08ab29107534b4e2fe49d2fe552
OpenBB/website/versioned_docs/version-v3/sdk/reference/crypto/dd/oi.md
Theodore Aptekarev f72bc8ccec Add Versioned Documentation (#5470) 
* Adding versioning to docs

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-09-29 11:49:05 +02:00

1.7 KiB
Vendored
Raw Blame History

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