Files
OpenBB/website/content/terminal/reference/economy/performance.md
teh_coderer 79046608b6 Docs Fix (#3543)
* Update generate_terminal_markdown.py

* updates

* update workflows

* Automated Change

* tests

* tests

* Automated Change

* Update test_generate_docs.py

* Automated Change

* updates

* Automated Change

* Update gen-docs.yml

* Update test.yml

* Automated Change

* Update test.yml

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* test

* Automated Change

* testtt23

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* Automated Change

* added empting reference folders before autogen docs

* updates

* Automated Change

* update tests gitactions

* Automated Change

* up

* Automated Change

* Automated Change

* update pytest

* Automated Change

* tests

* Automated Change

* examples update

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* Update test.yml

* Update generate_sdk_markdown.py

* strip

* Automated Change

* Workflow : check test update

* Automated Change

* Automated Change

* Automated Change

* Update test.yml

* Automated Change

* Update test.yml

* Automated Change

* Automated Change

* up

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* update workflows

* fix guides

* testing

* Update gh-pages.yml

* Update gh-pages.yml

Co-authored-by: tehcoderer <tehcoderer@users.noreply.github.com>
Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
Co-authored-by: Chavithra <Chavithra@users.noreply.github.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
2022-11-25 17:19:08 -05:00

8.4 KiB
Vendored

title, description
title description
performance OpenBB Terminal Function

performance

View group (sectors, industry or country) performance data. [Source: Finviz]

Usage

performance [-g {sector,industry,basic_materials,communication_services,consumer_cyclical,consumer_defensive,energy,financial,healthcare,industrials,real_Estate,technology,utilities,country,capitalization}] [-s {Name,Week,Month,3Month,6Month,1Year,YTD,Recom,AvgVolume,RelVolume,Change,Volume}] [-r]

Parameters

Name Description Default Optional Choices
group Data group (sector, industry or country) sector True sector, industry, basic_materials, communication_services, consumer_cyclical, consumer_defensive, energy, financial, healthcare, industrials, real_Estate, technology, utilities, country, capitalization
sortby Column to sort by Name True Name, Week, Month, 3Month, 6Month, 1Year, YTD, Recom, AvgVolume, RelVolume, Change, Volume
reverse Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. False True None

Examples

2022 Feb 15, 05:25 (🦋) /economy/ $ performance
                                                         Group Performance Data
┌────────────────────────┬───────┬───────┬────────┬────────┬───────┬───────┬───────┬────────────────┬───────────┬────────┬─────────────┐
│ Name                   │ Week  │ Month │ 3Month │ 6Month │ 1Year │ YTD   │ Recom │ AvgVolume [1M] │ RelVolume │ Change │ Volume [1M] │
├────────────────────────┼───────┼───────┼────────┼────────┼───────┼───────┼───────┼────────────────┼───────────┼────────┼─────────────┤
│ Utilities              │ -0.02 │ -0.04 │ -0.01  │ -0.03  │ 0.04  │ -0.07 │ 2.33  │ 148.49         │ 1.10      │ -0.01  │ 163.32      │
├────────────────────────┼───────┼───────┼────────┼────────┼───────┼───────┼───────┼────────────────┼───────────┼────────┼─────────────┤
│ Technology             │ -0.02 │ -0.07 │ -0.13  │ -0.05  │ 0.01  │ -0.13 │ 1.98  │ 1590.00        │ 0.91      │ -0.00  │ 1440.00     │
├────────────────────────┼───────┼───────┼────────┼────────┼───────┼───────┼───────┼────────────────┼───────────┼────────┼─────────────┤
│ Real Estate            │ -0.02 │ -0.08 │ -0.08  │ -0.04  │ 0.07  │ -0.12 │ 2.22  │ 331.13         │ 1.13      │ -0.01  │ 373.51      │
├────────────────────────┼───────┼───────┼────────┼────────┼───────┼───────┼───────┼────────────────┼───────────┼────────┼─────────────┤
│ Industrials            │ -0.01 │ -0.07 │ -0.09  │ -0.06  │ 0.06  │ -0.08 │ 2.26  │ 627.31         │ 0.97      │ -0.00  │ 611.51      │
├────────────────────────┼───────┼───────┼────────┼────────┼───────┼───────┼───────┼────────────────┼───────────┼────────┼─────────────┤
│ Healthcare             │ -0.02 │ -0.04 │ -0.10  │ -0.11  │ -0.05 │ -0.10 │ 2.05  │ 1600.00        │ 0.79      │ -0.01  │ 1260.00     │
├────────────────────────┼───────┼───────┼────────┼────────┼───────┼───────┼───────┼────────────────┼───────────┼────────┼─────────────┤
│ Financial              │ -0.01 │ -0.03 │ -0.02  │ 0.01   │ 0.14  │ 0.01  │ 2.20  │ 969.06         │ 1.05      │ -0.01  │ 1020.00     │
├────────────────────────┼───────┼───────┼────────┼────────┼───────┼───────┼───────┼────────────────┼───────────┼────────┼─────────────┤
│ Energy                 │ -0.01 │ 0.07  │ 0.16   │ 0.34   │ 0.43  │ 0.20  │ 2.24  │ 675.13         │ 1.09      │ -0.02  │ 738.17      │
├────────────────────────┼───────┼───────┼────────┼────────┼───────┼───────┼───────┼────────────────┼───────────┼────────┼─────────────┤
│ Consumer Defensive     │ -0.01 │ -0.03 │ -0.00  │ -0.01  │ 0.04  │ -0.03 │ 2.23  │ 443.50         │ 0.97      │ -0.00  │ 432.15      │
├────────────────────────┼───────┼───────┼────────┼────────┼───────┼───────┼───────┼────────────────┼───────────┼────────┼─────────────┤
│ Consumer Cyclical      │ -0.00 │ -0.08 │ -0.15  │ -0.07  │ -0.12 │ -0.10 │ 2.05  │ 1250.00        │ 0.83      │ 0.00   │ 1040.00     │
├────────────────────────┼───────┼───────┼────────┼────────┼───────┼───────┼───────┼────────────────┼───────────┼────────┼─────────────┤
│ Communication Services │ -0.01 │ -0.07 │ -0.16  │ -0.14  │ -0.05 │ -0.10 │ 1.88  │ 731.80         │ 0.94      │ 0.00   │ 690.29      │
├────────────────────────┼───────┼───────┼────────┼────────┼───────┼───────┼───────┼────────────────┼───────────┼────────┼─────────────┤
│ Basic Materials        │ 0.02  │ -0.03 │ -0.01  │ -0.03  │ 0.06  │ -0.02 │ 2.21  │ 461.26         │ 1.11      │ -0.01  │ 514.01      │
└────────────────────────┴───────┴───────┴────────┴────────┴───────┴───────┴───────┴────────────────┴───────────┴────────┴─────────────┘