mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-31 14:31:20 +00:00
2754be2620
* Improve overall docusaurus * update pypi on installation * fix merge conflicts * fix spelling * change CRLF to LF * improve docs installation for bot * more changes * few more * fix --------- Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
36 lines
767 B
Markdown
Vendored
36 lines
767 B
Markdown
Vendored
---
|
|
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ###########
|
|
title: summary
|
|
description: OpenBB Telegram Command
|
|
---
|
|
|
|
# summary
|
|
|
|
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
|
|
```
|
|
|
|
---
|