OpenBB/website/content/terminal/reference/economy/events.md

title, description, keywords

title	description	keywords
events	This page of the documentation provides comprehensive instructions on how to use the 'events' feature of our API. It allows users to fetch economic events from various countries within a specified date range. Important options include setting the importance and category of events.	economy economic calendar global financial events events tracking country wise economic events importance event category API usage financial market data analysis finance data

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

Economic calendar. If no start or end dates, default is the current day high importance events.

Usage

events [-c {argentina,australia,austria,bahrain,bangladesh,belgium,bosnia,botswana,brazil,bulgaria,canada,cayman_islands,chile,china,colombia,costa_rica,croatia,cyprus,czech_republic,denmark,dubai,ecuador,egypt,estonia,euro_zone,finland,france,germany,greece,hong_kong,hungary,iceland,india,indonesia,iraq,ireland,israel,italy,ivory_coast,jamaica,japan,jordan,kazakhstan,kenya,kuwait,latvia,lebanon,lithuania,luxembourg,malawi,malaysia,malta,mauritius,mexico,mongolia,montenegro,morocco,namibia,netherlands,new_zealand,nigeria,norway,oman,pakistan,palestine,peru,philippines,poland,portugal,qatar,romania,russia,rwanda,saudi_arabia,serbia,singapore,slovakia,slovenia,south_africa,south_korea,spain,sri_lanka,sweden,switzerland,taiwan,tanzania,thailand,tunisia,turkey,uganda,ukraine,united_kingdom,united_states,venezuela,vietnam,zambia,zimbabwe,all}] [-s START_DATE] [-e END_DATE] [-d SPEC_DATE] [-i {high,medium,low,all}] [--categories {employment,credit,balance,economic_activity,central_banks,bonds,inflation,confidence_index}]

---

Parameters

Name	Description	Default	Optional	Choices
country	Display calendar for specific country.		True	argentina, australia, austria, bahrain, bangladesh, belgium, bosnia, botswana, brazil, bulgaria, canada, cayman_islands, chile, china, colombia, costa_rica, croatia, cyprus, czech_republic, denmark, dubai, ecuador, egypt, estonia, euro_zone, finland, france, germany, greece, hong_kong, hungary, iceland, india, indonesia, iraq, ireland, israel, italy, ivory_coast, jamaica, japan, jordan, kazakhstan, kenya, kuwait, latvia, lebanon, lithuania, luxembourg, malawi, malaysia, malta, mauritius, mexico, mongolia, montenegro, morocco, namibia, netherlands, new_zealand, nigeria, norway, oman, pakistan, palestine, peru, philippines, poland, portugal, qatar, romania, russia, rwanda, saudi_arabia, serbia, singapore, slovakia, slovenia, south_africa, south_korea, spain, sri_lanka, sweden, switzerland, taiwan, tanzania, thailand, tunisia, turkey, uganda, ukraine, united_kingdom, united_states, venezuela, vietnam, zambia, zimbabwe, all
start_date	The start date of the data (format: YEAR-MONTH-DAY, i.e. 2010-12-31)	2022-11-25	True	None
end_date	The start date of the data (format: YEAR-MONTH-DAY, i.e. 2010-12-31)	2022-11-25	True	None
spec_date	Get a specific date for events. Overrides start and end dates.	None	True	None
importance	Event importance classified as high, medium, low or all.	None	True	high, medium, low, all
category	[INVESTING source only] Event category.	None	True	employment, credit, balance, economic_activity, central_banks, bonds, inflation, confidence_index

---

Examples

2022 Oct 20, 15:19 (🦋) /economy/ $ events -c united_kingdom,spain -s 2022-10-20 -e 2022-11-05 -l 15

                                                Economic Calendar
┏━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━┓
┃ Time (GMT) ┃ Country        ┃ Event                              ┃ actual ┃ consensus ┃ previous ┃ Date       ┃
┡━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━┩
│ 04:40      │ Spain          │ Spanish 3-Year Bonos Auction       │ 2.663% │ -         │ 1.416%   │ 2022-10-20 │
├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤
│ 04:40      │ Spain          │ Spanish 7-Year Obligacion Auction  │ 3.247% │ -         │ 1.550%   │ 2022-10-20 │
├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤
│ 19:01      │ United Kingdom │ GfK Consumer Confidence            │ -      │ -52       │ -49      │ 2022-10-20 │
├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤
│ 02:00      │ United Kingdom │ Core Retail Sales                  │ -      │ -0.3%     │ -1.6%    │ 2022-10-21 │
├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤
│ 02:00      │ United Kingdom │ Core Retail Sales                  │ -      │ -4.1%     │ -5.0%    │ 2022-10-21 │
├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤
│ 02:00      │ United Kingdom │ Public Sector Net Borrowing        │ -      │ 12.30B    │ 11.06B   │ 2022-10-21 │
├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤
│ 02:00      │ United Kingdom │ Public Sector Net Cash Requirement │ -      │ -         │ 5.321B   │ 2022-10-21 │
├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤
│ 02:00      │ United Kingdom │ Retail Sales                       │ -      │ -5.0%     │ -5.4%    │ 2022-10-21 │
├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤
│ 02:00      │ United Kingdom │ Retail Sales                       │ -      │ -0.5%     │ -1.6%    │ 2022-10-21 │
├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤
│ 04:30      │ United Kingdom │ BoE Consumer Credit                │ -      │ -         │ 1.077B   │ 2022-10-21 │
├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤
│ 04:30      │ United Kingdom │ M4 Money Supply                    │ -      │ -         │ -0.2%    │ 2022-10-21 │
├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤
│ 04:30      │ United Kingdom │ Mortgage Approvals                 │ -      │ 62.00K    │ 74.34K   │ 2022-10-21 │
├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤
│ 04:30      │ United Kingdom │ Mortgage Lending                   │ -      │ 4.90B     │ 6.14B    │ 2022-10-21 │
├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤
│ 15:30      │ United Kingdom │ CFTC GBP speculative net positions │ -      │ -         │ -39.2K   │ 2022-10-21 │
├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤
│ 14:00      │ United Kingdom │ BoE MPC Member Mann                │ -      │ -         │ -        │ 2022-10-22 │
└────────────┴────────────────┴────────────────────────────────────┴────────┴───────────┴──────────┴────────────┘

---