mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 07:51:49 +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>
55 lines
1.3 KiB
Markdown
Vendored
55 lines
1.3 KiB
Markdown
Vendored
---
|
|
title: news
|
|
description: This documentation page provides detailed information on how to retrieve
|
|
news articles using the OpenBBTerminal's function 'openbb.news'. The function allows
|
|
users to specify search terms, sources, and sorting parameters. Examples of using
|
|
the function are also provided.
|
|
keywords:
|
|
- News
|
|
- Feedparser
|
|
- Source Code
|
|
- openbb news
|
|
- News Article Search
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="news - Reference | OpenBB SDK Docs" />
|
|
|
|
Get news for a given term and source. [Source: Feedparser]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/feedparser_model.py#L13)]
|
|
|
|
```python
|
|
openbb.news(term: str = "", sources: str = "", sort: str = "published")
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| term | str | term to search on the news articles | | True |
|
|
| sources | str | sources to exclusively show news from (separated by commas) | | True |
|
|
| sort | str | the column to sort by | published | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| pd.DataFrame | term to search on the news articles |
|
|
---
|
|
|
|
## Examples
|
|
|
|
```python
|
|
from openbb_terminal.sdk import openbb
|
|
openbb.news()
|
|
```
|
|
|
|
---
|