mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 16:02:04 +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>
62 lines
1.5 KiB
Markdown
Vendored
62 lines
1.5 KiB
Markdown
Vendored
---
|
|
title: find
|
|
description: 'The page provides the information about a function that can find similar
|
|
coins by coin name, symbol or id. The tool supports multiple data sources including:
|
|
CoinGecko, CoinPaprika, Binance, and Coinbase and can return the data in a Pandas
|
|
DataFrame format.'
|
|
keywords:
|
|
- find similar coin
|
|
- cryptocurrency
|
|
- Cryptocurrency search
|
|
- CoinGecko
|
|
- CoinPaprika
|
|
- Binance
|
|
- Coinbase
|
|
- Data source of coins
|
|
- data frame
|
|
- openbb.crypto.find
|
|
- Crypto search function
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="crypto.find - Reference | OpenBB SDK Docs" />
|
|
|
|
Find similar coin by coin name,symbol or id.
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/crypto_models.py#L9)]
|
|
|
|
```python
|
|
openbb.crypto.find(query: str, source: str = "CoinGecko", key: str = "symbol", limit: int = 10)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| query | str | Cryptocurrency | None | False |
|
|
| source | str | Data source of coins. CoinGecko or CoinPaprika or Binance or Coinbase | CoinGecko | True |
|
|
| key | str | Searching key (symbol, id, name) | symbol | True |
|
|
| limit | int | Number of records to display | 10 | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| pd.DataFrame | DataFrame with 'limit' similar coins |
|
|
---
|
|
|
|
## Examples
|
|
|
|
```python
|
|
from openbb_terminal.sdk import openbb
|
|
openbb.crypto.find("polka", "CoinGecko", "name", 25)
|
|
```
|
|
|
|
---
|