jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-02 23:41:27 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd08218c35aed534ad59309ff2ca99d08e94de6a
OpenBB/website/content/sdk/reference/etf/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

2.6 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
news The page provides documentation on how to get and display news for a given term using OpenBB's Python functions. It also describes parameters used in these functions and links to the related source codes.
Documentation
Python functions
News retrieval
NewsAPI
Source code
Parameters

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Get news for a given term. [Source: NewsAPI]

Source Code: [link]

openbb.etf.news(query: str, limit: int = 10, start_date: Optional[str] = None, show_newest: bool = True, sources: str = "")

Parameters

Name Type Description Default Optional
query str term to search on the news articles None False
start_date Optional[str] date to start searching articles from formatted YYYY-MM-DD None True
show_newest bool flag to show newest articles first True True
sources str sources to exclusively show news from (comma separated) True

Returns

Type Description
List[Tuple[pd.DataFrame, dict]] List of tuples containing news df in first index,
dict containing title of news df.

Prints table showing news for a given term. [Source: NewsAPI]

Source Code: [link]

openbb.etf.news_chart(query: str, limit: int = 3, start_date: Optional[str] = None, show_newest: bool = True, sources: str = "", export: str = "")

Parameters

Name Type Description Default Optional
query str term to search on the news articles None False
start_date Optional[str] date to start searching articles from formatted YYYY-MM-DD None True
limit int number of articles to display 3 True
show_newest bool flag to show newest articles first True True
sources str sources to exclusively show news from True
export str Export dataframe data to csv,json,xlsx file True

Returns

This function does not return anything