jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-02 23:41:27 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd08218c35aed534ad59309ff2ca99d08e94de6a
OpenBB/website/content/sdk/reference/stocks/ca/similar.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.5 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
similar Documentation for the 'similar' functionality in the OpenBB-finance package. Includes details about the function, parameters and returns, and examples.
OpenBB-finance
similar tickers
stock comparison
stock analysis
python package
Finviz
Polygon
Finnhub
TSNE
stock symbols

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

Find similar tickers to a given symbol.

Source Code: [link]

openbb.stocks.ca.similar(symbol: str, source: Any = "Finviz")

Parameters

Name Type Description Default Optional
symbol str Symbol to find similar tickers to. None False
source str Source to get data for, by default "Finviz". Can be "Finviz", "Polygon", "Finnhub", or "TSNE" Finviz True

Returns

Type Description
List[str] List of similar tickers.

Examples

To get similar tickers to AAPL from Finviz:

from openbb_terminal.sdk import openbb
similar_tickers = openbb.stocks.ca.similar("AAPL)

To use our custom TSNE model for similar tickers in the SP500:

similar_tickers = openbb.stocks.ca.similar("AAPL", source="TSNE")