Files
OpenBB/website/content/platform/data_models/EuropeanIndexConstituents.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.5 KiB
Vendored

title, description
title description
European Index Constituents OpenBB Platform Data Model

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


Implementation details

Class names

Model name Parameters class Data class
EuropeanIndexConstituents EuropeanIndexConstituentsQueryParams EuropeanIndexConstituentsData

Import Statement

from openbb_core.provider.standard_models.european_index_constituents import (
EuropeanIndexConstituentsData,
EuropeanIndexConstituentsQueryParams,
)

Parameters

Name Type Description Default Optional
symbol Union[str, List[str]] Symbol to get data for. False
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

Data

Name Type Description
symbol str Symbol representing the entity requested in the data. The symbol is the constituent company in the index.
price float Current price of the constituent company in the index.
open float The open price.
high float The high price.
low float The low price.
close float The close price.
volume float The trading volume.
Name Type Description
symbol str Symbol representing the entity requested in the data. The symbol is the constituent company in the index.
price float Current price of the constituent company in the index.
open float The open price.
high float The high price.
low float The low price.
close float The close price.
volume float The trading volume.
prev_close float Previous closing price.
change float Change in price.
change_percent float Change in price as a percentage.
tick str Whether the last sale was an up or down tick.
last_trade_timestamp datetime Last trade timestamp for the symbol.
exchange_id int The Exchange ID number.
seqno int Sequence number of the last trade on the tape.
asset_type str Type of asset.