Index Sectors
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
IndexSectors | IndexSectorsQueryParams | IndexSectorsData |
Import Statement
from openbb_core.provider.standard_models.index_sectors import (
IndexSectorsData,
IndexSectorsQueryParams,
)
Parameters
- standard
- tmx
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Symbol to get data for. | False | |
| provider | Literal['tmx'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tmx' if there is no default. | tmx | True |
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Symbol to get data for. | False | |
| provider | Literal['tmx'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tmx' if there is no default. | tmx | True |
| use_cache | bool | Whether to use a cached request. All Index data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 1 day. | True | True |
Data
- standard
- tmx
| Name | Type | Description |
|---|---|---|
| sector | str | The sector name. |
| weight | float | The weight of the sector in the index. |
| Name | Type | Description |
|---|---|---|
| sector | str | The sector name. |
| weight | float | The weight of the sector in the index. |