mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-02 23:41:27 +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>
8.9 KiB
Vendored
8.9 KiB
Vendored
title, description, keywords
| title | description | keywords | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| performance | Documentation for the Performance function that helps to view group data, including sectors, industries, and countries. It details usage, parameters, and provides examples of Performance function use. |
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
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 │
└────────────────────────┴───────┴───────┴────────┴────────┴───────┴───────┴───────┴────────────────┴───────────┴────────┴─────────────┘