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

title, description
title description
ETF Information Overview OpenBB Platform Data Model

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


Implementation details

Class names

Model name Parameters class Data class
EtfInfo EtfInfoQueryParams EtfInfoData

Import Statement

from openbb_core.provider.standard_models.etf_info import (
EtfInfoData,
EtfInfoQueryParams,
)

Parameters

Name Type Description Default Optional
symbol Union[str, List[str]] Symbol to get data for. (ETF) False
provider Literal['fmp'] 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

Data

Name Type Description
symbol str Symbol representing the entity requested in the data. (ETF)
name str Name of the ETF.
inception_date str Inception date of the ETF.
Name Type Description
symbol str Symbol representing the entity requested in the data. (ETF)
name str Name of the ETF.
inception_date str Inception date of the ETF.
asset_class str Asset class of the ETF.
aum float Assets under management.
avg_volume float Average trading volume of the ETF.
cusip str CUSIP of the ETF.
description str Description of the ETF.
domicile str Domicile of the ETF.
etf_company str Company of the ETF.
expense_ratio float Expense ratio of the ETF.
isin str ISIN of the ETF.
nav float Net asset value of the ETF.
nav_currency str Currency of the ETF's net asset value.
website str Website link of the ETF.
holdings_count int Number of holdings in the ETF.