Company News
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
CompanyNews | CompanyNewsQueryParams | CompanyNewsData |
Import Statement
from openbb_core.provider.standard_models.company_news import (
CompanyNewsData,
CompanyNewsQueryParams,
)
Parameters
- standard
- benzinga
- fmp
- intrinio
- polygon
- tiingo
- tmx
- yfinance
symbol: Union[str, list[str]]
Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance.
• Optional: True
start_date: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
limit: Annotated[int, Ge(ge=0)]
The number of data entries to return.
• Default: 2500
• Optional: True
symbol: Union[str, list[str]]
Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance.
• Optional: True
start_date: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
limit: Annotated[int, Ge(ge=0)]
The number of data entries to return.
• Default: 2500
• Optional: True
date: Union[date, str]
A specific date to get data for.
• Optional: True
display: Literal['headline', 'abstract', 'full']
Specify headline only (headline), headline + teaser (abstract), or headline + full body (full).
• Default: full
• Optional: True
updated_since: int
Number of seconds since the news was updated.
• Optional: True
published_since: int
Number of seconds since the news was published.
• Optional: True
sort: Literal['id', 'created', 'updated']
Key to sort the news by.
• Default: created
• Optional: True
order: Literal['asc', 'desc']
Order to sort the news by.
• Default: desc
• Optional: True
isin: str
The company's ISIN.
• Optional: True
cusip: str
The company's CUSIP.
• Optional: True
channels: str
Channels of the news to retrieve.
• Optional: True
topics: str
Topics of the news to retrieve.
• Optional: True
authors: str
Authors of the news to retrieve.
• Optional: True
content_types: str
Content types of the news to retrieve.
• Optional: True
symbol: Union[str, list[str]]
Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance.
• Optional: True
start_date: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
limit: Annotated[int, Ge(ge=0)]
The number of data entries to return.
• Default: 2500
• Optional: True
page: int
Page number of the results. Use in combination with limit.
• Default: 0
• Optional: True
symbol: Union[str, list[str]]
Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance.
• Optional: True
start_date: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
limit: Annotated[int, Ge(ge=0)]
The number of data entries to return.
• Default: 2500
• Optional: True
source: Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases']
The source of the news article.
• Optional: True
sentiment: Literal['positive', 'neutral', 'negative']
Return news only from this source.
• Optional: True
language: str
Filter by language. Unsupported for yahoo source.
• Optional: True
topic: str
Filter by topic. Unsupported for yahoo source.
• Optional: True
word_count_greater_than: int
News stories will have a word count greater than this value. Unsupported for yahoo source.
• Optional: True
word_count_less_than: int
News stories will have a word count less than this value. Unsupported for yahoo source.
• Optional: True
is_spam: bool
Filter whether it is marked as spam or not. Unsupported for yahoo source.
• Optional: True
business_relevance_greater_than: float
News stories will have a business relevance score more than this value. Unsupported for yahoo source. Value is a decimal between 0 and 1.
• Optional: True
business_relevance_less_than: float
News stories will have a business relevance score less than this value. Unsupported for yahoo source. Value is a decimal between 0 and 1.
• Optional: True
symbol: Union[str, list[str]]
Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance.
• Optional: True
start_date: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
limit: Annotated[int, Ge(ge=0)]
The number of data entries to return.
• Default: 2500
• Optional: True
order: Literal['asc', 'desc']
Sort order of the articles.
• Default: desc
• Optional: True
symbol: Union[str, list[str]]
Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance.
• Optional: True
start_date: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
limit: Annotated[int, Ge(ge=0)]
The number of data entries to return.
• Default: 2500
• Optional: True
offset: int
Page offset, used in conjunction with limit.
• Default: 0
• Optional: True
source: Union[str, list[str]]
A comma-separated list of the domains requested. Multiple items allowed for provider(s): tiingo.
• Optional: True
symbol: Union[str, list[str]]
Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance.
• Optional: True
start_date: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
limit: Annotated[int, Ge(ge=0)]
The number of data entries to return.
• Default: 2500
• Optional: True
page: int
The page number to start from. Use with limit.
• Default: 1
• Optional: True
symbol: Union[str, list[str]]
Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance.
• Optional: True
start_date: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
limit: Annotated[int, Ge(ge=0)]
The number of data entries to return.
• Default: 2500
• Optional: True
Data
- standard
- benzinga
- fmp
- intrinio
- polygon
- tiingo
- tmx
- yfinance
date: Union[datetime, str]
The date of the data. Here it is the published date of the article.
title: str
Title of the article.
text: str
Text/body of the article.
images: list[Dict[str, str]]
Images associated with the article.
url: str
URL to the article.
symbols: str
Symbols associated with the article.
date: Union[datetime, str]
The date of the data. Here it is the published date of the article.
title: str
Title of the article.
text: str
Text/body of the article.
images: list[Dict[str, str]]
URL to the images of the news.
url: str
URL to the article.
symbols: str
Symbols associated with the article.
id: str
Article ID.
author: str
Author of the article.
teaser: str
Teaser of the news.
channels: str
Channels associated with the news.
stocks: str
Stocks associated with the news.
tags: str
Tags associated with the news.
updated: datetime
Updated date of the news.
date: Union[datetime, str]
The date of the data. Here it is the published date of the article.
title: str
Title of the article.
text: str
Text/body of the article.
images: list[Dict[str, str]]
Images associated with the article.
url: str
URL to the article.
symbols: str
Symbols associated with the article.
source: str
Name of the news source.
date: Union[datetime, str]
The date of the data. Here it is the published date of the article.
title: str
Title of the article.
text: str
Text/body of the article.
images: list[Dict[str, str]]
Images associated with the article.
url: str
URL to the article.
symbols: str
Symbols associated with the article.
source: str
The source of the news article.
summary: str
The summary of the news article.
topics: str
The topics related to the news article.
word_count: int
The word count of the news article.
business_relevance: float
How strongly correlated the news article is to the business
sentiment: str
The sentiment of the news article - i.e, negative, positive.
sentiment_confidence: float
The confidence score of the sentiment rating.
language: str
The language of the news article.
spam: bool
Whether the news article is spam.
copyright: str
The copyright notice of the news article.
id: str
Article ID.
security: IntrinioSecurity
The Intrinio Security object. Contains the security details related to the news article.
date: Union[datetime, str]
The date of the data. Here it is the published date of the article.
title: str
Title of the article.
text: str
Text/body of the article.
images: list[Dict[str, str]]
Images associated with the article.
url: str
URL to the article.
symbols: str
Symbols associated with the article.
source: str
Source of the article.
tags: str
Keywords/tags in the article
id: str
Article ID.
amp_url: str
AMP URL.
publisher: PolygonPublisher
Publisher of the article.
date: Union[datetime, str]
The date of the data. Here it is the published date of the article.
title: str
Title of the article.
text: str
Text/body of the article.
images: list[Dict[str, str]]
Images associated with the article.
url: str
URL to the article.
symbols: str
Symbols associated with the article.
tags: str
Tags associated with the news article.
article_id: int
Unique ID of the news article.
source: str
News source.
crawl_date: datetime
Date the news article was crawled.
date: Union[datetime, str]
The date of the data. Here it is the published date of the article.
title: str
Title of the article.
text: str
Text/body of the article.
images: list[Dict[str, str]]
Images associated with the article.
url: str
URL to the article.
symbols: str
Symbols associated with the article.
source: str
Source of the news.
date: Union[datetime, str]
The date of the data. Here it is the published date of the article.
title: str
Title of the article.
text: str
Text/body of the article.
images: list[Dict[str, str]]
Images associated with the article.
url: str
URL to the article.
symbols: str
Symbols associated with the article.
source: str
Source of the news article