mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-08 10:22:09 +00:00
4ad995fdd0
* 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>
67 lines
1.5 KiB
Markdown
Vendored
67 lines
1.5 KiB
Markdown
Vendored
---
|
|
title: similar
|
|
description: Documentation for the 'similar' functionality in the OpenBB-finance package.
|
|
Includes details about the function, parameters and returns, and examples.
|
|
keywords:
|
|
- 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';
|
|
|
|
<HeadTitle title="stocks.ca.similar - Reference | OpenBB SDK Docs" />
|
|
|
|
Find similar tickers to a given symbol.
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/comparison_analysis/sdk_helpers.py#L15)]
|
|
|
|
```python
|
|
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:
|
|
|
|
```python
|
|
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:
|
|
|
|
```python
|
|
similar_tickers = openbb.stocks.ca.similar("AAPL", source="TSNE")
|
|
```
|
|
|
|
---
|