Files
OpenBB/website/content/sdk/reference/economy/perfmap.md
jose-donato 2e7eb4c9b6 New documentation website (#3526)
* fix(docs): added margin between sections

* feat: removed unused files; updated ga

* fix: juan stuff doesnt work

* fix: random fix

* moon at noon

* fix: update docusaurus config

* Update controller_doc_classes.py

* fix: temp fix

* fix: temp fix

* Update controller_doc_classes.py

* fix: remove old content

* fix: taggfix

* init

* fix: styling and moved file

* Update generate_terminal_markdown.py

* fix: removed unused images

* fix: port new files

* Update generate_sdk_markdown.py

* Update controller_doc_classes.py

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 16:47:03 +00:00

34 lines
715 B
Markdown
Vendored

---
title: perfmap
description: OpenBB SDK Function
---
# perfmap
Opens Finviz map website in a browser. [Source: Finviz]
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/finviz_model.py#L42)]
```python
openbb.economy.perfmap(period: str = "1d", map_filter: str = "sp500")
```
---
## Parameters
| Name | Type | Description | Default | Optional |
| ---- | ---- | ----------- | ------- | -------- |
| period | str | Performance period. Available periods are 1d, 1w, 1m, 3m, 6m, 1y. | 1d | True |
| scope | str | Map filter. Available map filters are sp500, world, full, etf. | None | True |
---
## Returns
This function does not return anything
---