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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
"""ETF 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_etf.discovery.discovery_router import router as discovery_router
router = Router(prefix="", description="Exchange Traded Funds market data.")
router.include_router(discovery_router)
# pylint: disable=unused-argument
@router.command(
model="EtfSearch",
examples=[
APIEx(
description="An empty query returns the full list of ETFs from the provider.",
parameters={"provider": "fmp"},
),
APIEx(
description="The query will return results from text-based fields containing the term.",
parameters={"query": "commercial real estate", "provider": "fmp"},
),
],
)
async def search(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject:
"""Search for ETFs.
An empty query returns the full list of ETFs from the provider.
"""
return await OBBject.from_query(Query(**locals()))
@router.command(
model="EtfHistorical",
operation_id="etf_historical",
examples=[
APIEx(parameters={"symbol": "SPY", "provider": "fmp"}),
APIEx(parameters={"symbol": "SPY", "provider": "yfinance"}),
APIEx(
description="This function accepts multiple tickers.",
parameters={"symbol": "SPY,IWM,QQQ,DJIA", "provider": "yfinance"},
),
],
)
async def historical(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject:
"""ETF Historical Market Price."""
return await OBBject.from_query(Query(**locals()))
@router.command(
model="EtfInfo",
examples=[
APIEx(parameters={"symbol": "SPY", "provider": "fmp"}),
APIEx(
description="This function accepts multiple tickers.",
parameters={"symbol": "SPY,IWM,QQQ,DJIA", "provider": "fmp"},
),
],
)
async def info(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject:
"""ETF Information Overview."""
return await OBBject.from_query(Query(**locals()))
@router.command(
model="EtfSectors",
examples=[APIEx(parameters={"symbol": "SPY", "provider": "fmp"})],
)
async def sectors(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject:
"""ETF Sector weighting."""
return await OBBject.from_query(Query(**locals()))
@router.command(
model="EtfCountries",
examples=[APIEx(parameters={"symbol": "VT", "provider": "fmp"})],
)
async def countries(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject:
"""ETF Country weighting."""
return await OBBject.from_query(Query(**locals()))
@router.command(
model="EtfPricePerformance",
examples=[
APIEx(parameters={"symbol": "QQQ", "provider": "fmp"}),
APIEx(parameters={"symbol": "SPY,QQQ,IWM,DJIA", "provider": "fmp"}),
],
)
async def price_performance(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject:
"""Price performance as a return, over different periods."""
return await OBBject.from_query(Query(**locals()))
@router.command(
model="EtfHoldings",
examples=[
APIEx(parameters={"symbol": "XLK", "provider": "fmp"}),
APIEx(
description="Including a date (FMP, SEC) will return the holdings as per NPORT-P filings.",
parameters={"symbol": "XLK", "date": "2022-03-31", "provider": "fmp"},
),
APIEx(
description="The same data can be returned from the SEC directly.",
parameters={"symbol": "XLK", "date": "2022-03-31", "provider": "sec"},
),
],
)
async def holdings(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject:
"""Get the holdings for an individual ETF."""
return await OBBject.from_query(Query(**locals()))
@router.command(
model="EtfHoldingsDate",
examples=[APIEx(parameters={"symbol": "XLK", "provider": "fmp"})],
)
async def holdings_date(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject:
"""Use this function to get the holdings dates, if available."""
return await OBBject.from_query(Query(**locals()))
@router.command(
model="EtfHoldingsPerformance",
deprecated=True,
deprecation=OpenBBDeprecationWarning(
message="This endpoint is deprecated; pass a list of holdings symbols directly to"
+ " `/equity/price/performance` instead.",
since=(4, 1),
expected_removal=(4, 2),
),
examples=[APIEx(parameters={"symbol": "XLK", "provider": "fmp"})],
)
async def holdings_performance(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject:
"""Get the recent price performance of each ticker held in the ETF."""
return await OBBject.from_query(Query(**locals()))
@router.command(
model="EtfEquityExposure",
examples=[
APIEx(parameters={"symbol": "MSFT", "provider": "fmp"}),
APIEx(
description="This function accepts multiple tickers.",
parameters={"symbol": "MSFT,AAPL", "provider": "fmp"},
),
],
)
async def equity_exposure(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject:
"""Get the exposure to ETFs for a specific stock."""
return await OBBject.from_query(Query(**locals()))
|
