mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-05 00:42:19 +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>
92 lines
2.9 KiB
Markdown
Vendored
92 lines
2.9 KiB
Markdown
Vendored
---
|
|
title: events
|
|
description: The page provides detailed documentation on how to get all events related
|
|
to a given cryptocurrency like conferences, start date of futures trading. It also
|
|
provides insights into how to sort, limit and export these events using the OpenBBTerminal
|
|
methods.
|
|
keywords:
|
|
- cryptocurrency events
|
|
- cryptocurrency futures trading
|
|
- cryptocurrency conferences
|
|
- sorting cryptocurrency data
|
|
- exporting cryptocurrency data
|
|
- cryptocurrency
|
|
- data frame
|
|
- python cryptocurrency project
|
|
- CoinPaprika API
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="crypto.dd.events - Reference | OpenBB SDK Docs" />
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
<Tabs>
|
|
<TabItem value="model" label="Model" default>
|
|
|
|
Get all events related to given coin like conferences, start date of futures trading etc.
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinpaprika_model.py#L74)]
|
|
|
|
```python
|
|
openbb.crypto.dd.events(symbol: str = "BTC", sortby: str = "date", ascend: bool = False)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| symbol | str | Cryptocurrency symbol (e.g. BTC) | BTC | True |
|
|
| sortby | str | Key by which to sort data. Every column name is valid<br/>(see for possible values:<br/>https://api.coinpaprika.com/docs#tag/Coins/paths/~1coins~1%7Bcoin_id%7D~1events/get). | date | True |
|
|
| ascend | bool | Flag to sort data ascending | False | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| pd.DataFrame | Events found for given coin<br/>Columns: id, date , date_to, name, description, is_conference, link, proof_image_link |
|
|
---
|
|
|
|
</TabItem>
|
|
<TabItem value="view" label="Chart">
|
|
|
|
Prints table showing all events for given coin id. [Source: CoinPaprika]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinpaprika_view.py#L132)]
|
|
|
|
```python
|
|
openbb.crypto.dd.events_chart(symbol: str = "BTC", limit: int = 10, sortby: str = "date", ascend: bool = False, links: bool = False, export: str = "")
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| symbol | str | Cryptocurrency symbol (e.g. BTC) | BTC | True |
|
|
| limit | int | Number of records to display | 10 | True |
|
|
| sortby | str | Key by which to sort data. Every column name is valid<br/>(see for possible values:<br/>https://api.coinpaprika.com/docs#tag/Coins/paths/~1coins~1%7Bcoin_id%7D~1events/get). | date | True |
|
|
| ascend | bool | Flag to sort data ascending | False | True |
|
|
| links | bool | Flag to display urls | False | True |
|
|
| export | str | Export dataframe data to csv,json,xlsx file | | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
This function does not return anything
|
|
|
|
---
|
|
|
|
</TabItem>
|
|
</Tabs>
|