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

74 lines
1.5 KiB
Markdown
Vendored

---
title: stats
description: OpenBB SDK Function
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# stats
<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>