Files
OpenBB/website/content/sdk/reference/crypto/disc/cpsearch.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

3.1 KiB
Vendored

title, description, keywords
title description keywords
cpsearch Documentation for 'cpsearch', a cryptocurrency discovery function in OpenBBTerminal using the CoinPaprika API. This page provides details about parameters, source code links and data return types.
docusaurus
cpsearch
coinPaprika
cryptocurrency
search
crypto discovery
search parameters
coinPaprika API
data analytics

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

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

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