mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-07 09:52:13 +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
1.1 KiB
Markdown
Vendored
39 lines
1.1 KiB
Markdown
Vendored
---
|
|
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ###########
|
|
title: heatmap
|
|
description: OpenBB Telegram Command
|
|
---
|
|
|
|
# heatmap
|
|
|
|
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
|
|
```
|
|
---
|