mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 16:02:04 +00:00
4ad995fdd0
* 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>
3.1 KiB
Vendored
3.1 KiB
Vendored
title, description, keywords
| title | description | keywords | ||||||
|---|---|---|---|---|---|---|---|---|
| mkt | An extensive guide and source code for working with cryptocurrency market data from the CoinPaprika API using Python with OpenBB finance. It includes sections on how to fetch all markets for a given cryptocurrency and print tables that display market information. |
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
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