Files
OpenBB/website/content/sdk/reference/economy/valuation.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

1.3 KiB
Vendored

title, description, keywords
title description keywords
valuation This is a documentation page about the openbb.economy.valuation function from OpenBB that uses Finviz data to get group valuation data. It allows for sorting by column and in ascending order, returning these results in a dataframe.
group valuation data
finance sector
performance data
sort by column
ascending order
Finviz
GitHub
dataframe

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

Get group (sectors, industry or country) valuation data. [Source: Finviz]

Source Code: [link]

openbb.economy.valuation(group: str = "sector", sortby: str = "Name", ascend: bool = True)

Parameters

Name Type Description Default Optional
group str Group by category. Available groups can be accessed through get_groups(). sector True
sortby str Column to sort by Name True
ascend bool Flag to sort in ascending order True True

Returns

Type Description
pd.DataFrame dataframe with valuation/performance data