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

84 lines
2.0 KiB
Markdown
Vendored

---
title: stats
description: This page consists of detailed guidelines on how to utilise stats and
stats_chart functions. It shows how one can leverage these functions to get NFT
collection stats and print tables showcasing these stats, respectively sourced from
opensea.io.
keywords:
- stats function
- stats_chart function
- NFT collection stats
- OpenSea data
- NFT data
- slug
- data export
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="crypto.nft.stats - Reference | OpenBB SDK Docs" />
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<Tabs>
<TabItem value="model" label="Model" default>
Get stats of a nft collection [Source: opensea.io]
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/nft/opensea_model.py#L17)]
```python
openbb.crypto.nft.stats(slug: str)
```
---
## Parameters
| Name | Type | Description | Default | Optional |
| ---- | ---- | ----------- | ------- | -------- |
| slug | str | Opensea collection slug. If the name of the collection is Mutant Ape Yacht Club the slug is mutant-ape-yacht-club | None | False |
---
## Returns
| Type | Description |
| ---- | ----------- |
| pd.DataFrame | collection stats |
---
</TabItem>
<TabItem value="view" label="Chart">
Prints table showing collection stats. [Source: opensea.io]
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/nft/opensea_view.py#L15)]
```python
openbb.crypto.nft.stats_chart(slug: str, export: str)
```
---
## Parameters
| Name | Type | Description | Default | Optional |
| ---- | ---- | ----------- | ------- | -------- |
| slug | str | Opensea collection slug.<br/>If the name of the collection is Mutant Ape Yacht Club the slug is mutant-ape-yacht-club | None | False |
| export | str | Export dataframe data to csv,json,xlsx file | None | False |
---
## Returns
This function does not return anything
---
</TabItem>
</Tabs>