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>
91 lines
2.2 KiB
Markdown
Vendored
91 lines
2.2 KiB
Markdown
Vendored
---
|
|
title: hold
|
|
description: Comprehensive guides to holding Bitcoin and Ethereum by public companies.
|
|
Details on visualizing the hold data and exporting it to your preferred data format
|
|
(csv, json, xlsx). Source references to CoinGecko. Includes links to source codes.
|
|
keywords:
|
|
- cryptocurrency
|
|
- bitcoin
|
|
- ethereum
|
|
- public companies
|
|
- data visualization
|
|
- CoinGecko
|
|
- bar graph
|
|
- dataframe
|
|
- openbb.crypto.ov.hold
|
|
- openbb.crypto.ov.hold_chart
|
|
- csv
|
|
- json
|
|
- xlsx
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="crypto.ov.hold - Reference | OpenBB SDK Docs" />
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
<Tabs>
|
|
<TabItem value="model" label="Model" default>
|
|
|
|
Returns public companies that holds ethereum or bitcoin [Source: CoinGecko]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/pycoingecko_model.py#L102)]
|
|
|
|
```python
|
|
openbb.crypto.ov.hold(endpoint: str = "bitcoin")
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| endpoint | str | "bitcoin" or "ethereum" | bitcoin | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| List[Union[str, pd.DataFrame]] | - str: Overall statistics<br/>- pd.DataFrame: Companies holding crypto |
|
|
---
|
|
|
|
</TabItem>
|
|
<TabItem value="view" label="Chart">
|
|
|
|
Shows overview of public companies that holds ethereum or bitcoin. [Source: CoinGecko]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/pycoingecko_view.py#L135)]
|
|
|
|
```python
|
|
openbb.crypto.ov.hold_chart(symbol: str, show_bar: bool = False, export: str = "", limit: int = 15)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| symbol | str | Cryptocurrency: ethereum or bitcoin | None | False |
|
|
| show_bar | bool | Whether to show a bar graph for the data | False | True |
|
|
| export | str | Export dataframe data to csv,json,xlsx | | True |
|
|
| limit | int | The number of rows to show | 15 | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
This function does not return anything
|
|
|
|
---
|
|
|
|
</TabItem>
|
|
</Tabs>
|