mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-29 21:42:22 +00:00
* 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>
2.8 KiB
Vendored
2.8 KiB
Vendored
title, description
| title | description |
|---|---|
| news | OpenBB SDK Function |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
news
Get recent posts from CryptoPanic news aggregator platform. [Source: https://cryptopanic.com/]
Source Code: [link]
openbb.crypto.dd.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 |
| region | str | Filter news by regions. Available regions are: en (English), de (Deutsch), nl (Dutch), 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. |
Prints table showing recent posts from CryptoPanic news aggregator platform.
Source Code: [link]
openbb.crypto.dd.news_chart(post_kind: str = "news", region: str = "en", filter_: Optional[str] = None, source: Optional[str] = None, symbol: Optional[str] = None, limit: int = 25, ascend: bool = True, 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 |
| region | str | Filter news by regions. Available regions are: en (English), de (Deutsch), nl (Dutch), es (Español), fr (Français), it (Italiano), pt (Português), ru (Русский) |
en | True |
| ascend | bool | Sort in ascending order. | True | True |
| export | str | Export dataframe data to csv,json,xlsx file | True |
Returns
This function does not return anything