diff options
Diffstat (limited to 'website/content/sdk/reference/crypto/ov/cr.md')
| -rw-r--r-- | website/content/sdk/reference/crypto/ov/cr.md | 48 |
1 files changed, 24 insertions, 24 deletions
diff --git a/website/content/sdk/reference/crypto/ov/cr.md b/website/content/sdk/reference/crypto/ov/cr.md index 33807cb76dd..14c6a79708a 100644 --- a/website/content/sdk/reference/crypto/ov/cr.md +++ b/website/content/sdk/reference/crypto/ov/cr.md @@ -1,16 +1,17 @@ --- title: cr -description: Documentation for two functions providing cryptocurrency interest rates +description: + Documentation for two functions providing cryptocurrency interest rates for both borrowing and supplying.You can use the functions to export data or generate charts. Several platforms are covered including BlockFi, Ledn, SwissBorg, and Youhodler. keywords: -- Cryptocurrency -- Crypto Interest Rates -- Crypto Borrowing -- Crypto Supplying -- Interest Rate Platforms -- Crypto Charts -- Crypto Data Export + - Cryptocurrency + - Crypto Interest Rates + - Crypto Borrowing + - Crypto Supplying + - Interest Rate Platforms + - Crypto Charts + - Crypto Data Export --- import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; @@ -23,7 +24,7 @@ import TabItem from '@theme/TabItem'; <Tabs> <TabItem value="model" label="Model" default> -Returns crypto {borrow,supply} interest rates for cryptocurrencies across several platforms +Returns crypto \{borrow,supply\} interest rates for cryptocurrencies across several platforms Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/loanscan_model.py#L267)] @@ -35,24 +36,24 @@ openbb.crypto.ov.cr(rate_type: str = "borrow") ## Parameters -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| rate_type | str | Interest rate type: {borrow, supply}. Default: supply | borrow | True | - +| Name | Type | Description | Default | Optional | +| --------- | ---- | ------------------------------------------------------- | ------- | -------- | +| rate_type | str | Interest rate type: \{borrow, supply\}. Default: supply | borrow | True | --- ## Returns -| Type | Description | -| ---- | ----------- | +| Type | Description | +| ------------ | ---------------------------------- | | pd.DataFrame | crypto interest rates per platform | + --- </TabItem> <TabItem value="view" label="Chart"> -Displays crypto {borrow,supply} interest rates for cryptocurrencies across several platforms +Displays crypto \{borrow, supply\} interest rates for cryptocurrencies across several platforms Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/loanscan_view.py#L24)] @@ -64,14 +65,13 @@ openbb.crypto.ov.cr_chart(symbols: str, platforms: str, rate_type: str = "borrow ## Parameters -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| rate_type | str | Interest rate type: {borrow, supply}. Default: supply | borrow | True | -| symbols | str | Crypto separated by commas. Default: BTC,ETH,USDT,USDC | None | False | -| platforms | str | Platforms separated by commas. Default: BlockFi,Ledn,SwissBorg,Youhodler | None | False | -| limit | int | Number of records to show | 10 | True | -| export | str | Export dataframe data to csv,json,xlsx file | | True | - +| Name | Type | Description | Default | Optional | +| --------- | ---- | ------------------------------------------------------------------------ | ------- | -------- | +| rate_type | str | Interest rate type: \{borrow, supply\}. Default: supply | borrow | True | +| symbols | str | Crypto separated by commas. Default: BTC,ETH,USDT,USDC | None | False | +| platforms | str | Platforms separated by commas. Default: BlockFi,Ledn,SwissBorg,Youhodler | None | False | +| limit | int | Number of records to show | 10 | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | --- |