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: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance.
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
limit: Annotated[int, Ge(ge=0)]
The number of data entries to return.
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance.
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
limit: Annotated[int, Ge(ge=0)]
The number of data entries to return.
date: date | str
A specific date to get data for.
display: Literal['headline', 'abstract', 'full']
Default: full
Specify headline only (headline), headline + teaser (abstract), or headline + full body (full).
updated_since: int
Number of seconds since the news was updated.
published_since: int
Number of seconds since the news was published.
sort: Literal['id', 'created', 'updated']
Default: created
Key to sort the news by.
order: Literal['asc', 'desc']
Default: desc
Order to sort the news by.
isin: str
The company's ISIN.
cusip: str
The company's CUSIP.
channels: str
Channels of the news to retrieve.
topics: str
Topics of the news to retrieve.
authors: str
Authors of the news to retrieve.
content_types: str
Content types of the news to retrieve.
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance.
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
limit: Annotated[int, Ge(ge=0)]
The number of data entries to return.
page: int
Default: 0
Page number of the results. Use in combination with limit.
press_release: bool
When true, will return only press releases for the given symbol(s).
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance.
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
limit: Annotated[int, Ge(ge=0)]
The number of data entries to return.
source: Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases']
The source of the news article.
sentiment: Literal['positive', 'neutral', 'negative']
Return news only from this source.
language: str
Filter by language. Unsupported for yahoo source.
topic: str
Filter by topic. Unsupported for yahoo source.
word_count_greater_than: int
News stories will have a word count greater than this value. Unsupported for yahoo source.
word_count_less_than: int
News stories will have a word count less than this value. Unsupported for yahoo source.
is_spam: bool
Filter whether it is marked as spam or not. Unsupported for yahoo source.
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.
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.
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance.
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
limit: Annotated[int, Ge(ge=0)]
The number of data entries to return.
order: Literal['asc', 'desc']
Default: desc
Sort order of the articles.
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance.
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
limit: Annotated[int, Ge(ge=0)]
The number of data entries to return.
offset: int
Default: 0
Page offset, used in conjunction with limit.
source: str | list[str]
A comma-separated list of the domains requested. Multiple items allowed for provider(s): tiingo.
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance.
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
limit: Annotated[int, Ge(ge=0)]
The number of data entries to return.
page: int
Default: 1
The page number to start from. Use with limit.
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance.
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
limit: Annotated[int, Ge(ge=0)]
The number of data entries to return.
Data
- standard
- benzinga
- fmp
- intrinio
- polygon
- tiingo
- tmx
- yfinance
date: Union[datetime, str]
The date of the data. The date of publication.
title: str
Title of the article.
author: str
Author of the article.
excerpt: str
Excerpt of the article text.
body: str
Body of the article text.
images: Any
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. The date of publication.
title: str
Title of the article.
author: str
Author of the article.
excerpt: str
Excerpt of the article text.
body: str
Body of the article text.
images: Any
Images associated with the article.
url: str
URL to the article.
symbols: str
Symbols associated with the article.
channels: str
Channels associated with the news.
tags: str
Tags associated with the news.
updated: datetime
Updated date of the news.
id: str
Article ID.
original_id: str
Original ID of the news article.
date: Union[datetime, str]
The date of the data. The date of publication.
title: str
Title of the article.
author: str
Author of the article.
excerpt: str
Excerpt of the article text.
body: str
Body of the article text.
images: Any
Images associated with the article.
url: str
URL to the article.
symbols: str
Symbols associated with the article.
source: str
Name of the news site.
date: Union[datetime, str]
The date of the data. The date of publication.
title: str
Title of the article.
author: str
Author of the article.
excerpt: str
Excerpt of the article text.
body: str
Body of the article text.
images: Any
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. The date of publication.
title: str
Title of the article.
author: str
Author of the article.
excerpt: str
Excerpt of the article text.
body: str
Body of the article text.
images: Any
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. The date of publication.
title: str
Title of the article.
author: str
Author of the article.
excerpt: str
Excerpt of the article text.
body: str
Body of the article text.
images: Any
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. The date of publication.
title: str
Title of the article.
author: str
Author of the article.
excerpt: str
Excerpt of the article text.
body: str
Body of the article text.
images: Any
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. The date of publication.
title: str
Title of the article.
author: str
Author of the article.
excerpt: str
Excerpt of the article text.
body: str
Body of the article text.
images: Any
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