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/ca/screener.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
Raw Blame History

title, description, keywords
title description keywords
screener This documentation page provides an overview of the Screener feature in the OpenBB Terminal, demonstrating how to use it to compare similar companies.
Stock Screener
Comparison Analysis
Similar Companies
Finviz
Finnhub
Polygon
Technical Analysis
Financial Analysis

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

Screener Overview.

Source Code: [link]

openbb.stocks.ca.screener(similar: List[str], data_type: str = "overview")

Parameters

Name Type Description Default Optional
similar List of similar companies.
Comparable companies can be accessed through
finnhub_peers(), finviz_peers(), polygon_peers().		 None False
data_type str Data type between: overview, valuation, financial, ownership, performance, technical overview True

Returns

Type Description
pd.DataFrame Dataframe with overview, valuation, financial, ownership, performance or technical