search
Search available cryptocurrency pairs within a provider.
Example
from openbb import obb
obb.crypto.search()
obb.crypto.search("BTCUSD")
obb.crypto.search("ETH-USD")
Parameters
- standard
- fmp
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| query | str | Search query. | None | True |
| provider | Literal['fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. | fmp | True |
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| query | str | Search query. | None | True |
| provider | Literal['fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. | fmp | True |
Returns
OBBject
results : List[CryptoSearch]
Serializable results.
provider : Optional[Literal['fmp']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
Data
- standard
- fmp
| Name | Type | Description |
|---|---|---|
| symbol | str | Symbol representing the entity requested in the data. (Crypto) |
| name | str | Name of the crypto. |
| Name | Type | Description |
|---|---|---|
| symbol | str | Symbol representing the entity requested in the data. (Crypto) |
| name | str | Name of the crypto. |
| currency | str | The currency the crypto trades for. |
| exchange | str | The exchange code the crypto trades on. |
| exchange_name | str | The short name of the exchange the crypto trades on. |