mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-31 22:41:19 +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>
51 lines
1.3 KiB
Markdown
Vendored
51 lines
1.3 KiB
Markdown
Vendored
---
|
|
title: summary
|
|
description: Documentation page for the '/summary' command, which retrieves a summary
|
|
of all prints by MarketCap percentage. The command and its parameters 'days' and
|
|
'sort' are explained. The description provides various options for sorting, i.e.,
|
|
by MarketCap, float, sum, or short percentage.
|
|
keywords:
|
|
- MarketCap Summary
|
|
- Prints by MarketCap
|
|
- Prints Summary
|
|
- Command /summary
|
|
- Parameter days
|
|
- Parameter sort
|
|
- Sort by MarketCap
|
|
- Sort by float
|
|
- Sort by sum
|
|
- Sort by short percentage
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="darkpool: summary - Telegram Reference | OpenBB Bot Docs" />
|
|
|
|
This command retrieves a summary of all the prints by percentage of MarketCap over the last x days, sorted by MarketCap. The summary includes the total number of prints and their total percentage of MarketCap, as well as the float and short percentage.
|
|
|
|
### Usage
|
|
|
|
```python wordwrap
|
|
/summary days sort
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Description | Optional | Choices |
|
|
| ---- | ----------- | -------- | ------- |
|
|
| days | Number of days to look back | False | None |
|
|
| sort | Sort by `mc` (MarketCap), `float`, `sum`, or `short` (Short Percentage) | False | None |
|
|
|
|
|
|
---
|
|
|
|
## Examples
|
|
|
|
```
|
|
/summary 10 mc
|
|
```
|
|
|
|
---
|