Files
OpenBB/website/versioned_docs/version-v3/sdk/reference/crypto/dd/mkt.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
mkt OpenBB SDK Function

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

mkt

All markets for given coin and currency [Source: CoinPaprika]

Source Code: [link]

openbb.crypto.dd.mkt(symbol: str = "BTC", quotes: str = "USD", sortby: str = "pct_volume_share", ascend: bool = True)

Parameters

Name Type Description Default Optional
symbol str Cryptocurrency symbol (e.g. BTC) BTC True
quotes str Comma separated list of quotes to return.
Example: quotes=USD,BTC
Allowed values:
BTC, ETH, USD, EUR, PLN, KRW, GBP, CAD, JPY, RUB, TRY, NZD, AUD, CHF, UAH, HKD, SGD, NGN,
PHP, MXN, BRL, THB, CLP, CNY, CZK, DKK, HUF, IDR, ILS, INR, MYR, NOK, PKR, SEK, TWD, ZAR,
VND, BOB, COP, PEN, ARS, ISK
USD True
sortby str Key by which to sort data. Every column name is valid (see for possible values:
https://api.coinpaprika.com/v1).
pct_volume_share True
ascend bool Flag to sort data ascending True True

Returns

Type Description
pd.DataFrame All markets for given coin and currency

Prints table showing all markets for given coin id. [Source: CoinPaprika]

Source Code: [link]

openbb.crypto.dd.mkt_chart(from_symbol: str = "BTC", to_symbol: str = "USD", limit: int = 20, sortby: str = "pct_volume_share", ascend: bool = True, links: bool = False, export: str = "")

Parameters

Name Type Description Default Optional
from_symbol str Cryptocurrency symbol (e.g. BTC) BTC True
to_symbol str Quoted currency USD True
limit int Number of records to display 20 True
sortby str Key by which to sort data. Every column name is valid (see for possible values:
https://api.coinpaprika.com/v1).
pct_volume_share True
ascend bool Flag to sort data ascending True True
links bool Flag to display urls False True
export str Export dataframe data to csv,json,xlsx file True

Returns

This function does not return anything