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>
48 lines
1.4 KiB
Markdown
Vendored
48 lines
1.4 KiB
Markdown
Vendored
---
|
|
title: heatmap
|
|
description: Documentation for the 'heatmap' command which retrieves Daily Heat Maps
|
|
based on Market and Sector. This provides a quick overview of current stock market
|
|
performance.
|
|
keywords:
|
|
- Heatmap Command
|
|
- Daily Heat Maps
|
|
- Stock Market Performance
|
|
- Market Filter
|
|
- Sector Filter
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="overview: heatmap - Telegram Reference | OpenBB Bot Docs" />
|
|
|
|
This command allows the user to retrieve Daily Heat Maps by Market and Sector. The Daily Heat Maps will allow the user a quick overview of current stock market performance.
|
|
|
|
### Usage
|
|
|
|
```python wordwrap
|
|
/heatmap market [sector]
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Description | Optional | Choices |
|
|
| ---- | ----------- | -------- | ------- |
|
|
| market | Market to filter by. `sp500`: "S&P 500", `nasdaq100`: "NASDAQ 100", `iwm2000`: "Russell 2000", `iwb1000`: "Russell 1000", `dow30`: "Dow Jones 30", `crypto`: "Crypto" | False | sp500, nasdaq100, iwm2000, iwb1000, dow30, crypto |
|
|
| sector | Sector to filter by. If not specified, all sectors are returned. `1`: "Basic Materials" `2`: "Conglomerates" `3`: "Consumer Goods" `4`: "Financial" `5`: "Healthcare" `6`: "Industrial Goods" `7`: "Services" `8`: "Technology" `9`: "Utilities" | True | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 |
|
|
|
|
|
|
---
|
|
|
|
## Examples
|
|
|
|
```
|
|
/heatmap sp500
|
|
```
|
|
|
|
```
|
|
/heatmap sp500 services
|
|
```
|
|
---
|