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>
53 lines
1.1 KiB
Markdown
Vendored
53 lines
1.1 KiB
Markdown
Vendored
---
|
|
title: top
|
|
description: The page provides instructions on the use of the 'top' command, a feature
|
|
to retrieve top cryptocurrencies by market capitalization, inclusive of component
|
|
parameters and usage examples.
|
|
keywords:
|
|
- cryptocurrencies
|
|
- market capitalization
|
|
- top command
|
|
- user instructions
|
|
- command usage
|
|
- sortby parameter
|
|
- category filter
|
|
- reverse sort
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="crypto: top - Telegram Reference | OpenBB Bot Docs" />
|
|
|
|
This command will retrieve the top cryptocurrencies, ranked by market capitalization, allowing the user to quickly get a snapshot of the current market.
|
|
|
|
### Usage
|
|
|
|
```python wordwrap
|
|
/top [sortby] [category] [reverse]
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Description | Optional | Choices |
|
|
| ---- | ----------- | -------- | ------- |
|
|
| sortby | Column to sort data by (e.g., mc) | True | mc, vol, 1hr, 1d, 1wk |
|
|
| category | Category to filter by (e.g., stablecoins) | True | None |
|
|
| reverse | Reverse the sort order (e.g., True) (default: False) | True | None |
|
|
|
|
|
|
---
|
|
|
|
## Examples
|
|
|
|
```
|
|
/top
|
|
```
|
|
|
|
```
|
|
/top mc marketing
|
|
```
|
|
|
|
---
|