jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-04 16:32:10 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd08218c35aed534ad59309ff2ca99d08e94de6a
OpenBB/website/content/sdk/reference/crypto/onchain/whales.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.7 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
whales Learn how to utilise Whale Alert's API with OpenBB Terminal for tracking high value transactions on major blockchains. This page contains detailed information on how to implement and use this feature to retrieve both live and historical onchain data from various cryptocurrencies.
Whale Alert API
blockchain transactions
onchain data
cryptocurrency
major blockchains
crypto whales
high value transactions
transaction tracking
data retrieval

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

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

Whale Alert's API allows you to retrieve live and historical transaction data from major blockchains.

Source Code: [link]

openbb.crypto.onchain.whales(min_value: int = 800000, limit: int = 100, sortby: str = "date", ascend: bool = False)

Parameters

Name Type Description Default Optional
min_value int Minimum value of trade to track. 800000 True
limit int Limit of transactions. Max 100 100 True
sortby str Key to sort by. date True
ascend str Sort in ascending order. False True

Returns

Type Description
pd.DataFrame Crypto wales transactions

Display huge value transactions from major blockchains. [Source: https://docs.whale-alert.io/]

Source Code: [link]

openbb.crypto.onchain.whales_chart(min_value: int = 800000, limit: int = 100, sortby: str = "date", ascend: bool = False, show_address: bool = False, export: str = "")

Parameters

Name Type Description Default Optional
min_value int Minimum value of trade to track. 800000 True
limit int Limit of transactions. Maximum 100 100 True
sortby str Key to sort by. date True
ascend str Sort in ascending order. False True
show_address bool Flag to show addresses of transactions. False True
export str Export dataframe data to csv,json,xlsx file True

Returns

This function does not return anything