Files
OpenBB/website/content/terminal/reference/economy/map.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622)
* 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>
2023-10-30 21:01:29 +00:00

45 lines
1.2 KiB
Markdown
Vendored

---
title: map
description: The documentation outlines the usage and parameters of a performance
index stocks map placed according to sectors and industries. The Web-Based map tool,
sourced by Finviz, adjusts based on selected performance periods and map filter
types, such as SP500, world, full or ETF.
keywords:
- Performance index
- stocks map
- sectors and industries
- market cap
- Finviz
- map filter type
- Performance period
- sp500
- world
- full
- etf
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="economy /map - Reference | OpenBB Terminal Docs" />
Performance index stocks map categorized by sectors and industries. Size represents market cap. Opens web-browser. [Source: Finviz]
### Usage
```python
map [-p {1d,1w,1m,3m,6m,1y}] [-t {sp500,world,full,etf}]
```
---
## Parameters
| Name | Description | Default | Optional | Choices |
| ---- | ----------- | ------- | -------- | ------- |
| s_period | Performance period. | 1d | True | 1d, 1w, 1m, 3m, 6m, 1y |
| s_type | Map filter type. | sp500 | True | sp500, world, full, etf |
![map](https://user-images.githubusercontent.com/46355364/154042399-ede7eb15-de7f-4de7-8541-3700ad2a97a0.png)
---