Files
OpenBB/website/versioned_docs/version-v3/sdk/reference/crypto/disc/cpsearch.md
Theodore Aptekarev f72bc8ccec Add Versioned Documentation (#5470)
* Adding versioning to docs

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-09-29 11:49:05 +02:00

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