Etf Equity Exposure
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EtfEquityExposure | EtfEquityExposureQueryParams | EtfEquityExposureData |
Import Statement
from openbb_core.provider.standard_models.etf_equity_exposure import (
EtfEquityExposureData,
EtfEquityExposureQueryParams,
)
Parameters
- standard
- fmp
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | Union[str, List[str]] | Symbol to get data for. (Stock) Multiple items allowed for provider(s): fmp. | False | |
| provider | Literal['fmp'] | The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. | None | True |
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | Union[str, List[str]] | Symbol to get data for. (Stock) Multiple items allowed for provider(s): fmp. | False | |
| provider | Literal['fmp'] | The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. | None | True |
Data
- standard
- fmp
| Name | Type | Description |
|---|---|---|
| equity_symbol | str | The symbol of the equity requested. |
| etf_symbol | str | The symbol of the ETF with exposure to the requested equity. |
| shares | float | The number of shares held in the ETF. |
| weight | float | The weight of the equity in the ETF, as a normalized percent. |
| market_value | Union[float, int] | The market value of the equity position in the ETF. |
| Name | Type | Description |
|---|---|---|
| equity_symbol | str | The symbol of the equity requested. |
| etf_symbol | str | The symbol of the ETF with exposure to the requested equity. |
| shares | float | The number of shares held in the ETF. |
| weight | float | The weight of the equity in the ETF, as a normalized percent. |
| market_value | Union[float, int] | The market value of the equity position in the ETF. |