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
|
"""Index Router."""
from openbb_core.app.deprecation import OpenBBDeprecationWarning
from openbb_core.app.model.command_context import CommandContext
from openbb_core.app.model.example import APIEx
from openbb_core.app.model.obbject import OBBject
from openbb_core.app.provider_interface import (
ExtraParams,
ProviderChoices,
StandardParams,
)
from openbb_core.app.query import Query
from openbb_core.app.router import Router
from openbb_index.price.price_router import router as price_router
router = Router(prefix="", description="Indices data.")
router.include_router(price_router)
# pylint: disable=unused-argument
@router.command(
model="MarketIndices",
deprecated=True,
deprecation=OpenBBDeprecationWarning(
message="This endpoint is deprecated; use `/index/price/historical` instead.",
since=(4, 1),
expected_removal=(4, 3),
),
examples=[APIEx(parameters={"symbol": "^IBEX", "provider": "fmp"})],
)
async def market(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject:
"""Historical Market Indices."""
return await OBBject.from_query(Query(**locals()))
@router.command(
model="IndexConstituents",
examples=[
APIEx(parameters={"symbol": "dowjones", "provider": "fmp"}),
APIEx(
description="Providers other than FMP will use the ticker symbol.",
parameters={"symbol": "BEP50P", "provider": "cboe"},
),
],
)
async def constituents(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject:
"""Index Constituents."""
return await OBBject.from_query(Query(**locals()))
@router.command(
model="IndexSnapshots",
examples=[
APIEx(parameters={"provider": "tmx"}),
APIEx(parameters={"region": "us", "provider": "cboe"}),
],
)
async def snapshots(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject:
"""Index Snapshots. Current levels for all indices from a provider, grouped by `region`."""
return await OBBject.from_query(Query(**locals()))
@router.command(
model="AvailableIndices",
examples=[
APIEx(parameters={"provider": "fmp"}),
APIEx(parameters={"provider": "yfinance"}),
],
)
async def available(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject:
"""All indices available from a given provider."""
return await OBBject.from_query(Query(**locals()))
@router.command(
model="IndexSearch",
examples=[
APIEx(parameters={"provider": "cboe"}),
APIEx(parameters={"query": "SPX", "provider": "cboe"}),
],
)
async def search(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject:
"""Filters indices for rows containing the query."""
return await OBBject.from_query(Query(**locals()))
@router.command(
model="SP500Multiples",
examples=[
APIEx(parameters={"provider": "nasdaq"}),
APIEx(parameters={"series_name": "shiller_pe_year", "provider": "nasdaq"}),
],
)
async def sp500_multiples(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject:
"""Historical S&P 500 multiples and Shiller PE ratios."""
return await OBBject.from_query(Query(**locals()))
@router.command(
model="IndexSectors",
examples=[APIEx(parameters={"symbol": "^TX60", "provider": "tmx"})],
)
async def sectors(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject:
"""Index Sectors. Sector weighting of an index."""
return await OBBject.from_query(Query(**locals()))
|
