mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-29 05:21:48 +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.2 KiB
Markdown
Vendored
51 lines
1.2 KiB
Markdown
Vendored
---
|
|
title: summaryflow
|
|
description: The SummaryFlow page provides instruction on using the summaryflow command,
|
|
which compiles detailed summaries of the flow per stock over selected periods, sorted
|
|
in various ways.
|
|
keywords:
|
|
- SummaryFlow
|
|
- stock flow summary
|
|
- stock analysis
|
|
- MarketCap sort
|
|
- short sort
|
|
- /summaryflow usage
|
|
- trading
|
|
- trades tracking
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="flow: summaryflow - Telegram Reference | OpenBB Bot Docs" />
|
|
|
|
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
|
|
```
|
|
---
|