jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 13:01:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ea9cedbb2e77b633a43578c69b4e89bfa5c5f7cb
OpenBB/website/content/platform/data_models/EconomicCalendar.md
Henrique Joaquim 4400cd9a8f Merge provider and core into core (#5774) 
* 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>
2023-11-22 13:48:01 +00:00

5.7 KiB
Vendored
Raw Blame History

title, description
title description
Economic Calendar OpenBB Platform Data Model

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Implementation details

Class names

Model name Parameters class Data class
EconomicCalendar EconomicCalendarQueryParams EconomicCalendarData

Import Statement

from openbb_core.provider.standard_models.economic_calendar import (
EconomicCalendarData,
EconomicCalendarQueryParams,
)

Parameters

Name Type Description Default Optional
start_date Union[date, str] Start date of the data, in YYYY-MM-DD format. None True
end_date Union[date, str] End date of the data, in YYYY-MM-DD format. None True
provider Literal['fmp', 'nasdaq', 'tradingeconomics'] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. fmp True
Name Type Description Default Optional
start_date Union[date, str] Start date of the data, in YYYY-MM-DD format. None True
end_date Union[date, str] End date of the data, in YYYY-MM-DD format. None True
provider Literal['fmp', 'nasdaq', 'tradingeconomics'] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. fmp True
country Union[List[str], str] Country of the event None True
Name Type Description Default Optional
start_date Union[date, str] Start date of the data, in YYYY-MM-DD format. None True
end_date Union[date, str] End date of the data, in YYYY-MM-DD format. None True
provider Literal['fmp', 'nasdaq', 'tradingeconomics'] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. fmp True
country Union[List[str], str] Country of the event None True
importance Literal['Low', 'Medium', 'High'] Importance of the event. None True
group Literal['interest rate', 'inflation', 'bonds', 'consumer', 'gdp', 'government', 'housing', 'labour', 'markets', 'money', 'prices', 'trade', 'business'] Grouping of events None True

Data

Name Type Description
date datetime The date of the data.
country str Country of event.
event str Event name.
reference str Abbreviated period for which released data refers to.
source str Source of the data.
sourceurl str Source URL.
actual Union[str, float] Latest released value.
previous Union[str, float] Value for the previous period after the revision (if revision is applicable).
consensus Union[str, float] Average forecast among a representative group of economists.
forecast Union[str, float] Trading Economics projections
url str Trading Economics URL
importance Union[Literal[0, 1, 2, 3], str] Importance of the event. 1-Low, 2-Medium, 3-High
currency str Currency of the data.
unit str Unit of the data.
Name Type Description
date datetime The date of the data.
country str Country of event.
event str Event name.
reference str Abbreviated period for which released data refers to.
source str Source of the data.
sourceurl str Source URL.
actual Union[str, float] Latest released value.
previous Union[str, float] Value for the previous period after the revision (if revision is applicable).
consensus Union[str, float] Average forecast among a representative group of economists.
forecast Union[str, float] Trading Economics projections
url str Trading Economics URL
importance Union[Literal[0, 1, 2, 3], str] Importance of the event. 1-Low, 2-Medium, 3-High
currency str Currency of the data.
unit str Unit of the data.
change float Value change since previous.
change_percent float Percentage change since previous.
updated_at datetime Last updated timestamp.
created_at datetime Created at timestamp.
Name Type Description
date datetime The date of the data.
country str Country of event.
event str Event name.
reference str Abbreviated period for which released data refers to.
source str Source of the data.
sourceurl str Source URL.
actual Union[str, float] Latest released value.
previous Union[str, float] Value for the previous period after the revision (if revision is applicable).
consensus Union[str, float] Average forecast among a representative group of economists.
forecast Union[str, float] Trading Economics projections
url str Trading Economics URL
importance Union[Literal[0, 1, 2, 3], str] Importance of the event. 1-Low, 2-Medium, 3-High
currency str Currency of the data.
unit str Unit of the data.
description str Event description.