mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-12 04:13:06 +00:00
4ad995fdd0
* 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>
71 lines
1.8 KiB
Markdown
Vendored
71 lines
1.8 KiB
Markdown
Vendored
---
|
|
title: events
|
|
description: Implement our economic calendar for selected countries and specific dates
|
|
functionality in your application using OpenBB. Use it to analyze global economic
|
|
trends or forecast market movements.
|
|
keywords:
|
|
- economic calendar
|
|
- financial market events
|
|
- global economy
|
|
- market analysis
|
|
- economic forecast
|
|
- economic events
|
|
- countries economy
|
|
- economic data retrieval
|
|
- market trends
|
|
- predictive analytics
|
|
- economic indicators
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="economy.events - Reference | OpenBB SDK Docs" />
|
|
|
|
Get economic calendar for countries between specified dates
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/nasdaq_model.py#L21)]
|
|
|
|
```python
|
|
openbb.economy.events(countries: Union[List[str], str] = "", start_date: Optional[str] = None, end_date: Optional[str] = None)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| countries | [List[str],str] | List of countries to include in calendar. Empty returns all | | True |
|
|
| start_date | Optional[str] | Start date for calendar | None | True |
|
|
| end_date | Optional[str] | End date for calendar | None | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| pd.DataFrame | Economic calendar |
|
|
---
|
|
|
|
## Examples
|
|
|
|
|
|
Get todays economic calendar for the United States
|
|
|
|
```python
|
|
from openbb_terminal.sdk import openbb
|
|
calendar = openbb.economy.events("United States")
|
|
```
|
|
|
|
|
|
To get multiple countries for a given date, pass the same start and end date as well as
|
|
a list of countries
|
|
|
|
```python
|
|
calendars = openbb.economy.events(["United States","Canada"], start_date="2022-11-18", end_date="2022-11-18")
|
|
```
|
|
|
|
---
|