jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 21:12:16 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f68929fa1efaa5e9abb7911029e287c975b37fd3
OpenBB/website/content/sdk/reference/etf/news.md
teh_coderer 79046608b6 Docs Fix (#3543) 
* Update generate_terminal_markdown.py

* updates

* update workflows

* Automated Change

* tests

* tests

* Automated Change

* Update test_generate_docs.py

* Automated Change

* updates

* Automated Change

* Update gen-docs.yml

* Update test.yml

* Automated Change

* Update test.yml

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* test

* Automated Change

* testtt23

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* Automated Change

* added empting reference folders before autogen docs

* updates

* Automated Change

* update tests gitactions

* Automated Change

* up

* Automated Change

* Automated Change

* update pytest

* Automated Change

* tests

* Automated Change

* examples update

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* Update test.yml

* Update generate_sdk_markdown.py

* strip

* Automated Change

* Workflow : check test update

* Automated Change

* Automated Change

* Automated Change

* Update test.yml

* Automated Change

* Update test.yml

* Automated Change

* Automated Change

* up

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* update workflows

* fix guides

* testing

* Update gh-pages.yml

* Update gh-pages.yml

Co-authored-by: tehcoderer <tehcoderer@users.noreply.github.com>
Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
Co-authored-by: Chavithra <Chavithra@users.noreply.github.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
2022-11-25 17:19:08 -05:00

2.2 KiB
Vendored
Raw Blame History

title, description
title description
news OpenBB SDK Function

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

news

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