Files
OpenBB/website/content/platform/data_models/EuropeanIndices.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

2.6 KiB
Vendored

title, description
title description
Historical European Indices OpenBB Platform Data Model

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


Implementation details

Class names

Model name Parameters class Data class
EuropeanIndices EuropeanIndicesQueryParams EuropeanIndicesData

Import Statement

from openbb_core.provider.standard_models.european_indices import (
EuropeanIndicesData,
EuropeanIndicesQueryParams,
)

Parameters

Name Type Description Default Optional
symbol Union[str, List[str]] Symbol to get data for. False
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['cboe'] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default. cboe True
Name Type Description Default Optional
symbol Union[str, List[str]] Symbol to get data for. False
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['cboe'] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default. cboe True
interval Literal['1m', '1d'] Data granularity. 1d True

Data

Name Type Description
date datetime The date of the data.
close float The close price.
Name Type Description
date datetime The date of the data.
close float The close price.
open float Opening price for the interval. Only valid when interval is 1m.
high float High price for the interval. Only valid when interval is 1m.
low float Low price for the interval. Only valid when interval is 1m.
utc_datetime datetime UTC datetime. Only valid when interval is 1m.