Files
OpenBB/website/content/sdk/reference/crypto/defi/ldapps.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622)
* 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>
2023-10-30 21:01:29 +00:00

89 lines
2.5 KiB
Markdown
Vendored

---
title: ldapps
description: This page provides documentation for ldapps functions used in the OpenBB
finance terminal. These functions retrieve and display information about listed
DeFi protocols, their current Total Valued Locked (TVL), and changes to it.
keywords:
- DeFi protocols
- ldapps
- dApps
- cryptocurrency
- Total Valued Locked (TVL)
- dataframe
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="crypto.defi.ldapps - Reference | OpenBB SDK Docs" />
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<Tabs>
<TabItem value="model" label="Model" default>
Returns information about listed DeFi protocols, their current TVL and changes to it in the last hour/day/week.
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/llama_model.py#L35)]
```python
openbb.crypto.defi.ldapps(limit: int = 100, sortby: str = "", ascend: bool = False, description: bool = False, drop_chain: bool = True)
```
---
## Parameters
| Name | Type | Description | Default | Optional |
| ---- | ---- | ----------- | ------- | -------- |
| limit | int | The number of dApps to display | 100 | True |
| sortby | str | Key by which to sort data | | True |
| ascend | bool | Flag to sort data descending | False | True |
| description | bool | Flag to display description of protocol | False | True |
| drop_chain | bool | Whether to drop the chain column | True | True |
---
## Returns
| Type | Description |
| ---- | ----------- |
| pd.DataFrame | Information about DeFi protocols |
---
</TabItem>
<TabItem value="view" label="Chart">
Prints table showing information about listed DeFi protocols, their current TVL and changes to it in
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/llama_view.py#L94)]
```python
openbb.crypto.defi.ldapps_chart(sortby: str, limit: int = 20, ascend: bool = False, description: bool = False, export: str = "")
```
---
## Parameters
| Name | Type | Description | Default | Optional |
| ---- | ---- | ----------- | ------- | -------- |
| limit | int | Number of records to display | 20 | True |
| sortby | str | Key by which to sort data | None | False |
| ascend | bool | Flag to sort data descending | False | True |
| description | bool | Flag to display description of protocol | False | True |
| export | str | Export dataframe data to csv,json,xlsx file | | True |
---
## Returns
This function does not return anything
---
</TabItem>
</Tabs>