mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 07:51:49 +00:00
4400cd9a8f
* small changes - moving provider inside the core * uptade readme * lint * remove old provider readme * leftovers * refactor website examples * ruff * fix nox * relock * fix fails_to_deliver headers * fix for tests that have renamed endpoints * fix discovery * removed test for renamed endpoint * fix broken syntax - test_search_financial_attributes * fix cash/income/balance * fix derivatives tests * fix etf tests * fix news tests * fix regulators * black * wrong test param * sort equity gainers/losers by percent * platform markdown generation import * Hotfix/fix int tests core merge (#5779) * removing tests on old endpoint * removing visualization on old endpoint * fixing equity tests * fixing examples * fix news tests * fix index test * example * add comments * example --------- Co-authored-by: Diogo Sousa <montezdesousa@gmail.com> --------- Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: Diogo Sousa <montezdesousa@gmail.com> Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>
150 lines
6.0 KiB
Markdown
Vendored
150 lines
6.0 KiB
Markdown
Vendored
---
|
|
title: Global News
|
|
description: OpenBB Platform Data Model
|
|
---
|
|
|
|
<!-- markdownlint-disable MD012 MD031 MD033 -->
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
---
|
|
|
|
## Implementation details
|
|
|
|
### Class names
|
|
|
|
| Model name | Parameters class | Data class |
|
|
| ---------- | ---------------- | ---------- |
|
|
| `GlobalNews` | `GlobalNewsQueryParams` | `GlobalNewsData` |
|
|
|
|
### Import Statement
|
|
|
|
```python
|
|
from openbb_core.provider.standard_models.global_news import (
|
|
GlobalNewsData,
|
|
GlobalNewsQueryParams,
|
|
)
|
|
```
|
|
|
|
## Parameters
|
|
|
|
<Tabs>
|
|
<TabItem value="standard" label="Standard">
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| limit | int | The number of data entries to return. Here its the no. of articles to return. | 20 | True |
|
|
| provider | Literal['benzinga', 'biztoc', 'fmp', 'intrinio'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True |
|
|
</TabItem>
|
|
|
|
<TabItem value='benzinga' label='benzinga'>
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| limit | int | The number of data entries to return. Here its the no. of articles to return. | 20 | True |
|
|
| provider | Literal['benzinga', 'biztoc', 'fmp', 'intrinio'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True |
|
|
| display | Literal['headline', 'abstract', 'full'] | Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). | full | True |
|
|
| date | str | Date of the news to retrieve. | None | True |
|
|
| start_date | str | Start date of the news to retrieve. | None | True |
|
|
| end_date | str | End date of the news to retrieve. | None | True |
|
|
| updated_since | int | Number of seconds since the news was updated. | None | True |
|
|
| published_since | int | Number of seconds since the news was published. | None | True |
|
|
| sort | Literal['id', 'created', 'updated'] | Key to sort the news by. | created | True |
|
|
| order | Literal['asc', 'desc'] | Order to sort the news by. | desc | True |
|
|
| isin | str | The ISIN of the news to retrieve. | None | True |
|
|
| cusip | str | The CUSIP of the news to retrieve. | None | True |
|
|
| channels | str | Channels of the news to retrieve. | None | True |
|
|
| topics | str | Topics of the news to retrieve. | None | True |
|
|
| authors | str | Authors of the news to retrieve. | None | True |
|
|
| content_types | str | Content types of the news to retrieve. | None | True |
|
|
</TabItem>
|
|
|
|
<TabItem value='biztoc' label='biztoc'>
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| limit | int | The number of data entries to return. Here its the no. of articles to return. | 20 | True |
|
|
| provider | Literal['benzinga', 'biztoc', 'fmp', 'intrinio'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True |
|
|
| filter | Literal['crypto', 'hot', 'latest', 'main', 'media', 'source', 'tag'] | Filter by type of news. | latest | True |
|
|
| source | str | Filter by a specific publisher. Only valid when filter is set to source. | bloomberg | True |
|
|
| tag | str | Tag, topic, to filter articles by. Only valid when filter is set to tag. | None | True |
|
|
| term | str | Search term to filter articles by. This overrides all other filters. | None | True |
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|
|
## Data
|
|
|
|
<Tabs>
|
|
<TabItem value="standard" label="Standard">
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| date | datetime | The date of the data. Here it is the published date of the news. |
|
|
| title | str | Title of the news. |
|
|
| images | List[Dict[str, str]] | Images associated with the news. |
|
|
| text | str | Text/body of the news. |
|
|
| url | str | URL of the news. |
|
|
</TabItem>
|
|
|
|
<TabItem value='benzinga' label='benzinga'>
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| date | datetime | The date of the data. Here it is the published date of the news. |
|
|
| title | str | Title of the news. |
|
|
| images | List[Dict[str, str]] | Images associated with the news. |
|
|
| text | str | Text/body of the news. |
|
|
| url | str | URL of the news. |
|
|
| id | str | ID of the news. |
|
|
| author | str | Author of the news. |
|
|
| 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 | None |
|
|
</TabItem>
|
|
|
|
<TabItem value='biztoc' label='biztoc'>
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| date | datetime | The date of the data. Here it is the published date of the news. |
|
|
| title | str | Title of the news. |
|
|
| images | List[Dict[str, str]] | Images associated with the news. |
|
|
| text | str | Text/body of the news. |
|
|
| url | str | URL of the news. |
|
|
| favicon | str | Icon image for the source of the article. |
|
|
| tags | List[str] | Tags for the article. |
|
|
| id | str | Unique Article ID. |
|
|
| score | float | Search relevance score for the article. |
|
|
</TabItem>
|
|
|
|
<TabItem value='fmp' label='fmp'>
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| date | datetime | The date of the data. Here it is the published date of the news. |
|
|
| title | str | Title of the news. |
|
|
| images | List[Dict[str, str]] | Images associated with the news. |
|
|
| text | str | Text/body of the news. |
|
|
| url | str | URL of the news. |
|
|
| site | str | Site of the news. |
|
|
</TabItem>
|
|
|
|
<TabItem value='intrinio' label='intrinio'>
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| date | datetime | The date of the data. Here it is the published date of the news. |
|
|
| title | str | Title of the news. |
|
|
| images | List[Dict[str, str]] | Images associated with the news. |
|
|
| text | str | Text/body of the news. |
|
|
| url | str | URL of the news. |
|
|
| id | str | Article ID. |
|
|
| company | Dict[str, Any] | Company details related to the news article. |
|
|
</TabItem>
|
|
|
|
</Tabs>
|