mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-07 09:52:13 +00:00
79046608b6
* Update generate_terminal_markdown.py * updates * update workflows * Automated Change * tests * tests * Automated Change * Update test_generate_docs.py * Automated Change * updates * Automated Change * Update gen-docs.yml * Update test.yml * Automated Change * Update test.yml * Automated Change * Update generate_sdk_markdown.py * Automated Change * test * Automated Change * testtt23 * Automated Change * Update generate_sdk_markdown.py * Automated Change * Automated Change * added empting reference folders before autogen docs * updates * Automated Change * update tests gitactions * Automated Change * up * Automated Change * Automated Change * update pytest * Automated Change * tests * Automated Change * examples update * Automated Change * Update generate_sdk_markdown.py * Automated Change * Update test.yml * Update generate_sdk_markdown.py * strip * Automated Change * Workflow : check test update * Automated Change * Automated Change * Automated Change * Update test.yml * Automated Change * Update test.yml * Automated Change * Automated Change * up * Automated Change * Update generate_sdk_markdown.py * Automated Change * update workflows * fix guides * testing * Update gh-pages.yml * Update gh-pages.yml Co-authored-by: tehcoderer <tehcoderer@users.noreply.github.com> Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com> Co-authored-by: Chavithra PARANA <chavithra@gmail.com> Co-authored-by: Chavithra <Chavithra@users.noreply.github.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
1.1 KiB
Vendored
1.1 KiB
Vendored
title, description
| title | description |
|---|---|
| similar | OpenBB SDK Function |
similar
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")