jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-29 21:42:22 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
9a9cc14ec145f4133e69a389f8a032e35fee2ea3
OpenBB/website/versioned_docs/version-v3/sdk/reference/crypto/tools/il.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

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