mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 16:02:04 +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>
56 lines
1.9 KiB
Markdown
Vendored
56 lines
1.9 KiB
Markdown
Vendored
---
|
|
title: fun
|
|
description: This page provides a comprehensive guide on how to use the python script
|
|
'fun' to display various fundamental metrics from the Token Terminal. The metrics
|
|
include market cap, timeline, category, etc. It also comes with specific command-line
|
|
examples and parameter descriptions for better understanding.
|
|
keywords:
|
|
- fundamental metrics
|
|
- Token Terminal
|
|
- usage
|
|
- parameters
|
|
- python script
|
|
- examples
|
|
- market_cap
|
|
- Blockchain
|
|
- category
|
|
- metric
|
|
- timeline
|
|
- reverse
|
|
- limit
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="crypto/ov/fun - Reference | OpenBB Terminal Docs" />
|
|
|
|
Display fundamental metrics overview [Source: Token Terminal]
|
|
|
|
### Usage
|
|
|
|
```python
|
|
fun -m {twitter_followers,gmv_annualized,market_cap,take_rate,revenue,revenue_protocol,tvl,pe,pe_circulating,ps,ps_circulating} [-c {Asset Management,Blockchain,DeFi,Exchange,Gaming,Insurance,Interoperability,Lending,NFT,Other,Prediction Market,Stablecoin}] [-t {24h,7d,30d,90d,180d,365d}] [-r] [-l LIMIT]
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Description | Default | Optional | Choices |
|
|
| ---- | ----------- | ------- | -------- | ------- |
|
|
| metric | Choose metric of interest | None | False | twitter_followers, gmv_annualized, market_cap, take_rate, revenue, revenue_protocol, tvl, pe, pe_circulating, ps, ps_circulating |
|
|
| category | Choose category of interest | | True | Asset Management, Blockchain, DeFi, Exchange, Gaming, Insurance, Interoperability, Lending, NFT, Other, Prediction Market, Stablecoin |
|
|
| timeline | Choose timeline of interest | 24h | True | 24h, 7d, 30d, 90d, 180d, 365d |
|
|
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
|
| limit | Display N items | 10 | True | None |
|
|
|
|
|
|
---
|
|
|
|
## Examples
|
|
|
|
```python
|
|
2022 Aug 28, 20:02 (🦋) /crypto/ov/ $ fun -m market_cap -c Blockchain
|
|
```
|
|
---
|