jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-04 00:12:29 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd08218c35aed534ad59309ff2ca99d08e94de6a
OpenBB/website/content/sdk/reference/crypto/onchain/tv.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

2.8 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
tv This documentation provides coding references and details about two functions related to the OpenBB Crypto Onchain Decentralized Exchange: one function to get token volume and another to view and print this data. Available parameters and return types are also discussed.
Decentralized Exchange
Token Volume
OpenBB Crypto Onchain
ERC20 token symbol
Trade amount currency
Sort data
Data ascending
Parameter details
Return types
Source code

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

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

Get token volume on different Decentralized Exchanges. [Source: https://graphql.bitquery.io/]

Source Code: [link]

openbb.crypto.onchain.tv(symbol: str = "UNI", trade_amount_currency: str = "USD", sortby: str = "tradeAmount", ascend: bool = True)

Parameters

Name Type Description Default Optional
symbol str ERC20 token symbol. UNI True
trade_amount_currency str Currency to display trade amount in. USD True
sortby str Key by which to sort data tradeAmount True
ascend bool Flag to sort data ascending True True

Returns

Type Description
pd.DataFrame Token volume on Decentralized Exchanges

Prints table showing token volume on different Decentralized Exchanges.

Source Code: [link]

openbb.crypto.onchain.tv_chart(symbol: str = "WBTC", trade_amount_currency: str = "USD", limit: int = 10, sortby: str = "tradeAmount", ascend: bool = True, export: str = "")

Parameters

Name Type Description Default Optional
symbol str ERC20 token symbol or address WBTC True
trade_amount_currency str Currency of displayed trade amount. Default: USD USD True
limit int Number of records to display 10 True
sortby str Key by which to sort data tradeAmount True
ascend bool Flag to sort data ascending True True
export str Export dataframe data to csv,json,xlsx file True

Returns

Type Description
pd.DataFrame Token volume on different decentralized exchanges