mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-28 21:12:16 +00:00
* fix(docs): added margin between sections * feat: removed unused files; updated ga * fix: juan stuff doesnt work * fix: random fix * moon at noon * fix: update docusaurus config * Update controller_doc_classes.py * fix: temp fix * fix: temp fix * Update controller_doc_classes.py * fix: remove old content * fix: taggfix * init * fix: styling and moved file * Update generate_terminal_markdown.py * fix: removed unused images * fix: port new files * Update generate_sdk_markdown.py * Update controller_doc_classes.py Co-authored-by: teh_coderer <me@tehcoderer.com>
2.6 KiB
Vendored
2.6 KiB
Vendored
title, description
| title | description |
|---|---|
| cpsearch | OpenBB SDK Function |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
cpsearch
Search CoinPaprika. [Source: CoinPaprika]
Source Code: [link]
openbb.crypto.disc.cpsearch(query: str, category: Optional[Any] = None, modifier: Optional[Any] = None, sortby: str = "id", ascend: bool = True)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| query | str | phrase for search | None | False |
| category | Optional[Any] | one or more categories (comma separated) to search. Available options: currencies |
exchanges | icos |
| modifier | Optional[Any] | set modifier for search results. Available options: symbol_search - search only by symbol (works for currencies only) |
None | True |
| sortby | str | Key to sort data. The table can be sorted by every of its columns. Refer to API documentation (see https://api.coinpaprika.com/docs#tag/Tools/paths/~1search/get) |
id | True |
| ascend | bool | Flag to sort data descending | True | True |
Returns
| Type | Description |
|---|---|
| pd.DataFrame | Search Results Columns: Metric, Value |
Prints table showing Search over CoinPaprika. [Source: CoinPaprika]
Source Code: [link]
openbb.crypto.disc.cpsearch_chart(query: str, category: str = "all", limit: int = 10, sortby: str = "id", ascend: bool = True, export: str = "")
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| query | str | Search query | None | False |
| category | str | Categories to search: currencies | exchanges | icos |
| limit | int | Number of records to display | 10 | True |
| sortby | str | Key to sort data. The table can be sorted by every of its columns. Refer to API documentation (see https://api.coinpaprika.com/docs#tag/Tools/paths/~1search/get) |
id | True |
| ascend | bool | Flag to sort data descending | True | True |
| export | str | Export dataframe data to csv,json,xlsx file | True |
Returns
This function does not return anything