mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-04 00:12:29 +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>
98 lines
3.1 KiB
Markdown
Vendored
98 lines
3.1 KiB
Markdown
Vendored
---
|
|
title: mt
|
|
description: The page includes details about different functions used in cryptocurrency
|
|
due diligence, specifically handling and plotting Messari timeseries data. This
|
|
includes parameters and return values for each function, including the crypto symbol,
|
|
timeseries_id, interval frequency, start and end date. Also discusses exporting
|
|
these dataframes and using matplotlib for visualizing data.
|
|
keywords:
|
|
- messari_timeseries
|
|
- crypto_symbol
|
|
- timeseries_id
|
|
- start_date
|
|
- end_date
|
|
- interval_frequency
|
|
- export_dataframe
|
|
- cryptocurrency_due_diligence
|
|
- openbb_terminal
|
|
- OpenBB-finance
|
|
- matplotlib
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="crypto.dd.mt - Reference | OpenBB SDK Docs" />
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
<Tabs>
|
|
<TabItem value="model" label="Model" default>
|
|
|
|
Returns messari timeseries
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/messari_model.py#L124)]
|
|
|
|
```python
|
|
openbb.crypto.dd.mt(symbol: str, timeseries_id: str, interval: str = "1d", start_date: Optional[str] = None, end_date: Optional[str] = None)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| symbol | str | Crypto symbol to check messari timeseries | None | False |
|
|
| timeseries_id | str | Messari timeserie id | None | False |
|
|
| interval | str | Interval frequency (possible values are: 5m, 15m, 30m, 1h, 1d, 1w) | 1d | True |
|
|
| start | Optional[str] | Initial date like string (e.g., 2021-10-01) | None | True |
|
|
| end | Optional[str] | End date like string (e.g., 2021-10-01) | None | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| Tuple[pd.DataFrame, str] | Messari timeseries over time,<br/>Timeseries title |
|
|
---
|
|
|
|
</TabItem>
|
|
<TabItem value="view" label="Chart">
|
|
|
|
Plots messari timeseries
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/messari_view.py#L103)]
|
|
|
|
```python
|
|
openbb.crypto.dd.mt_chart(symbol: str, timeseries_id: str, start_date: Optional[str] = None, end_date: Optional[str] = None, interval: str = "1d", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| symbol | str | Crypto symbol to check market cap dominance | None | False |
|
|
| timeseries_id | str | Obtained by api.crypto.dd.get_mt command | None | False |
|
|
| start_date | Optional[str] | Initial date like string (e.g., 2021-10-01) | None | True |
|
|
| end_date | Optional[str] | End date like string (e.g., 2021-10-01) | None | True |
|
|
| interval | str | Interval frequency (possible values are: 5m, 15m, 30m, 1h, 1d, 1w) | 1d | True |
|
|
| export | str | Export dataframe data to csv,json,xlsx file | | True |
|
|
| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
This function does not return anything
|
|
|
|
---
|
|
|
|
</TabItem>
|
|
</Tabs>
|