Files
OpenBB/website/content/sdk/reference/crypto/onchain/hr.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

title, description, keywords
title description keywords
hr The hr Tab provides functionalities to return a dataframe with the mean hashrate of either btc or eth blockchain along with the symbol's price, over a specified interval. Additionally, the hr_chart function provides the ability to plot this data as a chart.
OpenBB.crypto.onchain.hr
OpenBB.crypto.onchain.hr_chart
mean hashrate
blockchain
btc
eth
symbol price
dataframe
plot
chart

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

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

Returns dataframe with mean hashrate of btc or eth blockchain and symbol price

Source Code: [link]

openbb.crypto.onchain.hr(symbol: str, interval: str = "24h", start_date: str = "2010-01-01", end_date: Optional[str] = None)

Parameters

Name Type Description Default Optional
symbol str Blockchain to check hashrate (BTC or ETH) None False
start_date str Initial date, format YYYY-MM-DD 2010-01-01 True
end_date str Final date, format YYYY-MM-DD None True
interval str Interval frequency (e.g., 24h) 24h True

Returns

Type Description
pd.DataFrame mean hashrate and symbol price over time

Plots dataframe with mean hashrate of btc or eth blockchain and symbol price.

Source Code: [link]

openbb.crypto.onchain.hr_chart(symbol: str, start_date: str = "2010-01-01", end_date: Optional[str] = None, interval: str = "24h", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)

Parameters

Name Type Description Default Optional
symbol str Blockchain to check mean hashrate (BTC or ETH) None False
start_date str Initial date, format YYYY-MM-DD 2010-01-01 True
end_date Optional[str] Final date, format YYYY-MM-DD None True
interval str Interval frequency (possible values are: 24, 1w, 1month) 24h True
export str Export dataframe data to csv,json,xlsx file True
external_axes Optional[List[plt.Axes]] External axes (2 axes are expected in the list), by default None None True

Returns

This function does not return anything