mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-09 02:42:36 +00:00
79046608b6
* 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>
1.2 KiB
Vendored
1.2 KiB
Vendored
title, description
| title | description |
|---|---|
| events | OpenBB SDK Function |
events
Get economic calendar for countries between specified dates
Source Code: [link]
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
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
calendars = openbb.economy.events(["United States","Canada"], start_date="2022-11-18", end_date="2022-11-18")