jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-03 07:51:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd08218c35aed534ad59309ff2ca99d08e94de6a
OpenBB/website/content/sdk/reference/stocks/fa/similar_dfs.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.6 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
similar_dfs The similar_dfs function in OpenBB is documented on this page. This function is used for generating dataframes for similar companies by taking inputs such as a ticker symbol, the output from the yfinance.info function and the number of similar companies to produce. The option of filtering based on market cap is also provided. Going through this documentation provides valuable information to understand the use and functioning of the similar_dfs function.
similar_dfs
dataframes
similar companies
stocks
fundamental analysis
yfinance.info function
ticker symbol
market cap

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

Get dataframes for similar companies

Source Code: [link]

openbb.stocks.fa.similar_dfs(symbol: str, info: Dict[str, Any], n: int, no_filter: bool = False)

Parameters

Name Type Description Default Optional
symbol str The ticker symbol to create a dataframe for None False
into Dict[str,Any] The dictionary produced from the yfinance.info function None True
n int The number of similar companies to produce None False
no_filter bool True means that we do not filter based on market cap False True

Returns

Type Description
List[str, pd.DataFrame] A list of similar companies