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

93 lines
3.3 KiB
Markdown
Vendored

---
title: news
description: This documentation is for a news aggregator platform on the OpenBB Terminal
which fetches recent posts from CryptoPanic. It details available functions, parameters,
returns and the source code link.
keywords:
- CryptoPanic
- news aggregator
- parameters
- returns
- crypto news
- filter options
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="crypto.ov.news - Reference | OpenBB SDK Docs" />
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<Tabs>
<TabItem value="model" label="Model" default>
Get recent posts from CryptoPanic news aggregator platform. [Source: https://cryptopanic.com/]
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/cryptopanic_model.py#L158)]
```python
openbb.crypto.ov.news(limit: int = 60, post_kind: str = "news", filter_: Optional[str] = None, region: str = "en", source: Optional[str] = None, symbol: Optional[str] = None, sortby: str = "published_at", ascend: bool = True)
```
---
## Parameters
| Name | Type | Description | Default | Optional |
| ---- | ---- | ----------- | ------- | -------- |
| limit | int | number of news to fetch | 60 | True |
| post_kind | str | Filter by category of news. Available values: news or media. | news | True |
| filter_ | Optional[str] | Filter by kind of news. One from list: rising|hot|bullish|bearish|important|saved|lol | None | True |
| region | str | Filter news by regions. Available regions are: en (English), de (Deutsch), nl (Dutch),<br/>es (Español), fr (Français), it (Italiano), pt (Português), ru (Русский) | en | True |
| sortby | str | Key to sort by. | published_at | True |
| ascend | bool | Sort in ascend order. | True | True |
---
## Returns
| Type | Description |
| ---- | ----------- |
| pd.DataFrame | DataFrame with recent news from different sources filtered by provided parameters. |
---
</TabItem>
<TabItem value="view" label="Chart">
Display recent posts from CryptoPanic news aggregator platform.
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/cryptopanic_view.py#L17)]
```python
openbb.crypto.ov.news_chart(post_kind: str = "news", region: str = "en", filter_: Optional[str] = None, limit: int = 25, sortby: str = "published_at", ascend: bool = False, links: bool = False, export: str = "")
```
---
## Parameters
| Name | Type | Description | Default | Optional |
| ---- | ---- | ----------- | ------- | -------- |
| limit | int | number of news to display | 25 | True |
| post_kind | str | Filter by category of news. Available values: news or media. | news | True |
| filter_ | Optional[str] | Filter by kind of news. One from list: rising|hot|bullish|bearish|important|saved|lol | None | True |
| region | str | Filter news by regions. Available regions are: en (English), de (Deutsch), nl (Dutch),<br/>es (Español), fr (Français), it (Italiano), pt (Português), ru (Русский) | en | True |
| sortby | str | Key to sort by. | published_at | True |
| ascend | bool | Sort in ascending order. | False | True |
| links | bool | Show urls for news | False | True |
| export | str | Export dataframe data to csv,json,xlsx file | | True |
---
## Returns
This function does not return anything
---
</TabItem>
</Tabs>