Files
OpenBB/website/content/sdk/reference/crypto/onchain/whales.md
jose-donato 2e7eb4c9b6 New documentation website (#3526)
* fix(docs): added margin between sections

* feat: removed unused files; updated ga

* fix: juan stuff doesnt work

* fix: random fix

* moon at noon

* fix: update docusaurus config

* Update controller_doc_classes.py

* fix: temp fix

* fix: temp fix

* Update controller_doc_classes.py

* fix: remove old content

* fix: taggfix

* init

* fix: styling and moved file

* Update generate_terminal_markdown.py

* fix: removed unused images

* fix: port new files

* Update generate_sdk_markdown.py

* Update controller_doc_classes.py

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 16:47:03 +00:00

2.1 KiB
Vendored

title, description
title description
whales OpenBB SDK Function

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

whales

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