jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 13:01:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f68929fa1efaa5e9abb7911029e287c975b37fd3
OpenBB/website/content/sdk/reference/crypto/tools/il.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

2.2 KiB
Vendored
Raw Blame History

title, description
title description
il OpenBB SDK Function

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

il

Calculates Impermanent Loss in a custom liquidity pool

Source Code: [link]

openbb.crypto.tools.il(price_changeA: float, price_changeB: float, proportion: float, initial_pool_value: float)

Parameters

Name Type Description Default Optional
price_changeA float price change of crypto A in percentage None False
price_changeB float price change of crypto B in percentage None False
proportion float percentage of first token in pool None False
initial_pool_value float initial value that pool contains None False

Returns

Type Description
Tuple[pd.DataFrame, str] - pd.DataFrame: dataframe with results
- str: narrative version of results

Displays Impermanent Loss in a custom liquidity pool

Source Code: [link]

openbb.crypto.tools.il_chart(price_changeA: int, price_changeB: int, proportion: int, initial_pool_value: int, narrative: bool = False, export: str = "")

Parameters

Name Type Description Default Optional
price_changeA float price change of crypto A in percentage None False
price_changeB float price change of crypto B in percentage None False
proportion float percentage of first token in pool None False
initial_pool_value float initial value that pool contains None False
narrative str display narrative version instead of dataframe False True
export str Export dataframe data to csv,json,xlsx file True

Returns

This function does not return anything