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
|
"""Futures Router."""
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
router = Router(prefix="/futures")
# pylint: disable=unused-argument
@router.command(
model="FuturesHistorical",
examples=[
APIEx(parameters={"symbol": "ES", "provider": "yfinance"}),
APIEx(
description="Enter multiple symbols.",
parameters={"symbol": "ES,NQ", "provider": "yfinance"},
),
APIEx(
description='Enter expiration dates as "YYYY-MM".',
parameters={
"symbol": "ES",
"provider": "yfinance",
"expiration": "2025-12",
},
),
],
)
async def historical(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject:
"""Historical futures prices."""
return await OBBject.from_query(Query(**locals()))
@router.command(
model="FuturesCurve",
examples=[
APIEx(parameters={"symbol": "VX", "provider": "cboe", "date": "2024-06-25"}),
APIEx(
description="Enter a date to get the term structure from a historical date.",
parameters={"symbol": "NG", "provider": "yfinance", "date": "2023-01-01"},
),
],
)
async def curve(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject:
"""Futures Term Structure, current or historical."""
return await OBBject.from_query(Query(**locals()))
|