mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-04 00:12:29 +00:00
4ad995fdd0
* 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>
99 lines
2.4 KiB
Markdown
Vendored
99 lines
2.4 KiB
Markdown
Vendored
---
|
|
title: oi
|
|
description: This page deals with open interest (OI) in cryptocurrency using OpenBB
|
|
terminal. The models and charts displaying open interest by exchange, frequency
|
|
and crypto symbol (BTC for instance) are available. You can also review the source
|
|
code and instructions on how to use related Python functions.
|
|
keywords:
|
|
- OI
|
|
- Open Interest
|
|
- crypto
|
|
- symbol
|
|
- crypto symbol
|
|
- cryptocurrency
|
|
- exchange
|
|
- price
|
|
- frequency
|
|
- model
|
|
- chart
|
|
- parameter
|
|
- View
|
|
- Source Code
|
|
- dataframe
|
|
- BTC
|
|
- return
|
|
- export
|
|
- openbb.crypto.dd.oi
|
|
- openbb.crypto.dd.oi_chart
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="crypto.dd.oi - Reference | OpenBB SDK Docs" />
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
<Tabs>
|
|
<TabItem value="model" label="Model" default>
|
|
|
|
Returns open interest by exchange for a certain symbol
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinglass_model.py#L148)]
|
|
|
|
```python
|
|
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 |
|
|
---
|
|
|
|
</TabItem>
|
|
<TabItem value="view" label="Chart">
|
|
|
|
Plots open interest by exchange for a certain cryptocurrency
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinglass_view.py#L55)]
|
|
|
|
```python
|
|
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
|
|
|
|
---
|
|
|
|
</TabItem>
|
|
</Tabs>
|