summaryrefslogtreecommitdiffstats
path: root/openbb_platform/openbb/package/derivatives_options.py
diff options
context:
space:
mode:
Diffstat (limited to 'openbb_platform/openbb/package/derivatives_options.py')
-rw-r--r--openbb_platform/openbb/package/derivatives_options.py16
1 files changed, 6 insertions, 10 deletions
diff --git a/openbb_platform/openbb/package/derivatives_options.py b/openbb_platform/openbb/package/derivatives_options.py
index 513b470d6dd..01765d5355a 100644
--- a/openbb_platform/openbb/package/derivatives_options.py
+++ b/openbb_platform/openbb/package/derivatives_options.py
@@ -27,7 +27,7 @@ class ROUTER_derivatives_options(Container):
provider: Annotated[
Optional[Literal["intrinio", "yfinance"]],
OpenBBField(
- description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'intrinio' if there is\n no default."
+ description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: intrinio, yfinance."
),
] = None,
**kwargs
@@ -39,9 +39,7 @@ class ROUTER_derivatives_options(Container):
symbol : str
Symbol to get data for.
provider : Optional[Literal['intrinio', 'yfinance']]
- The provider to use for the query, by default None.
- If None, the provider specified in defaults is selected or 'intrinio' if there is
- no default.
+ The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: intrinio, yfinance.
date : Optional[datetime.date]
The end-of-day date for options chains data. (provider: intrinio)
@@ -170,7 +168,7 @@ class ROUTER_derivatives_options(Container):
provider_choices={
"provider": self._get_provider(
provider,
- "/derivatives/options/chains",
+ "derivatives.options.chains",
("intrinio", "yfinance"),
)
},
@@ -192,7 +190,7 @@ class ROUTER_derivatives_options(Container):
provider: Annotated[
Optional[Literal["intrinio"]],
OpenBBField(
- description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'intrinio' if there is\n no default."
+ description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: intrinio."
),
] = None,
**kwargs
@@ -204,9 +202,7 @@ class ROUTER_derivatives_options(Container):
symbol : Optional[str]
Symbol to get data for. (the underlying symbol)
provider : Optional[Literal['intrinio']]
- The provider to use for the query, by default None.
- If None, the provider specified in defaults is selected or 'intrinio' if there is
- no default.
+ The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: intrinio.
start_date : Optional[datetime.date]
Start date of the data, in YYYY-MM-DD format. If no symbol is supplied, requests are only allowed for a single date. Use the start_date for the target date. Intrinio appears to have data beginning Feb/2022, but is unclear when it actually began. (provider: intrinio)
end_date : Optional[datetime.date]
@@ -277,7 +273,7 @@ class ROUTER_derivatives_options(Container):
provider_choices={
"provider": self._get_provider(
provider,
- "/derivatives/options/unusual",
+ "derivatives.options.unusual",
("intrinio",),
)
},