mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-29 21:42:22 +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>
39 lines
828 B
Markdown
Vendored
39 lines
828 B
Markdown
Vendored
---
|
|
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ###########
|
|
title: summaryflow
|
|
description: OpenBB Telegram Command
|
|
---
|
|
|
|
# summaryflow
|
|
|
|
This command allows the user to retrieve a summary of all the flow per stock over the last x days, with the result sorted in various ways. This summary will include the ratio to total market capitalization, the number of trades, and other information.
|
|
|
|
### Usage
|
|
|
|
```python wordwrap
|
|
/summaryflow 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 | mc, float, sum, short |
|
|
|
|
|
|
---
|
|
|
|
## Examples
|
|
|
|
```
|
|
/summaryflow 1 float
|
|
```
|
|
|
|
```
|
|
/summaryflow 1 sum
|
|
```
|
|
---
|