File size: 5,933 Bytes
203c118 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 |
### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###
from typing import Literal, Optional
from openbb_core.app.model.field import OpenBBField
from openbb_core.app.model.obbject import OBBject
from openbb_core.app.static.container import Container
from openbb_core.app.static.utils.decorators import exception_handler, validate
from openbb_core.app.static.utils.filters import filter_inputs
from typing_extensions import Annotated
class ROUTER_index(Container):
"""/index
available
constituents
/price
"""
def __repr__(self) -> str:
return self.__doc__ or ""
@exception_handler
@validate
def available(
self,
provider: Annotated[
Optional[Literal["fmp", "yfinance"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, yfinance."
),
] = None,
**kwargs
) -> OBBject:
"""All indices available from a given provider.
Parameters
----------
provider : str
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, yfinance.
Returns
-------
OBBject
results : list[AvailableIndices]
Serializable results.
provider : Optional[str]
Provider name.
warnings : Optional[list[Warning_]]
list of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
AvailableIndices
----------------
name : Optional[str]
Name of the index.
currency : Optional[str]
Currency the index is traded in.
stock_exchange : Optional[str]
Stock exchange where the index is listed. (provider: fmp)
exchange_short_name : Optional[str]
Short name of the stock exchange where the index is listed. (provider: fmp)
code : Optional[str]
ID code for keying the index in the OpenBB Terminal. (provider: yfinance)
symbol : Optional[str]
Symbol for the index. (provider: yfinance)
Examples
--------
>>> from openbb import obb
>>> obb.index.available(provider='fmp')
>>> obb.index.available(provider='yfinance')
""" # noqa: E501
return self._run(
"/index/available",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"index.available",
("fmp", "yfinance"),
)
},
standard_params={},
extra_params=kwargs,
)
)
@exception_handler
@validate
def constituents(
self,
symbol: Annotated[str, OpenBBField(description="Symbol to get data for.")],
provider: Annotated[
Optional[Literal["fmp"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp."
),
] = None,
**kwargs
) -> OBBject:
"""Get Index Constituents.
Parameters
----------
provider : str
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp.
symbol : str
Symbol to get data for.
Returns
-------
OBBject
results : list[IndexConstituents]
Serializable results.
provider : Optional[str]
Provider name.
warnings : Optional[list[Warning_]]
list of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
IndexConstituents
-----------------
symbol : str
Symbol representing the entity requested in the data.
name : Optional[str]
Name of the constituent company in the index.
sector : Optional[str]
Sector the constituent company in the index belongs to. (provider: fmp)
sub_sector : Optional[str]
Sub-sector the constituent company in the index belongs to. (provider: fmp)
headquarter : Optional[str]
Location of the headquarter of the constituent company in the index. (provider: fmp)
date_first_added : Optional[Union[date, str]]
Date the constituent company was added to the index. (provider: fmp)
cik : Optional[int]
Central Index Key (CIK) for the requested entity. (provider: fmp)
founded : Optional[Union[date, str]]
Founding year of the constituent company in the index. (provider: fmp)
Examples
--------
>>> from openbb import obb
>>> obb.index.constituents(symbol='dowjones', provider='fmp')
""" # noqa: E501
return self._run(
"/index/constituents",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"index.constituents",
("fmp",),
)
},
standard_params={
"symbol": symbol,
},
extra_params=kwargs,
)
)
@property
def price(self):
# pylint: disable=import-outside-toplevel
from . import index_price
return index_price.ROUTER_index_price(command_runner=self._command_runner)
|