summaryrefslogtreecommitdiffstats
path: root/openbb_platform/openbb/package/currency.py
diff options
context:
space:
mode:
Diffstat (limited to 'openbb_platform/openbb/package/currency.py')
-rw-r--r--openbb_platform/openbb/package/currency.py16
1 files changed, 6 insertions, 10 deletions
diff --git a/openbb_platform/openbb/package/currency.py b/openbb_platform/openbb/package/currency.py
index e000f2d435e..b754ddec4c9 100644
--- a/openbb_platform/openbb/package/currency.py
+++ b/openbb_platform/openbb/package/currency.py
@@ -38,7 +38,7 @@ class ROUTER_currency(Container):
provider: Annotated[
Optional[Literal["fmp", "intrinio", "polygon"]],
OpenBBField(
- description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' 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: fmp, intrinio, polygon."
),
] = None,
**kwargs
@@ -59,9 +59,7 @@ class ROUTER_currency(Container):
query : Optional[str]
Query to search for currency pairs.
provider : Optional[Literal['fmp', 'intrinio', 'polygon']]
- The provider to use for the query, by default None.
- If None, the provider specified in defaults is selected or 'fmp' 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: fmp, intrinio, polygon.
Returns
-------
@@ -124,7 +122,7 @@ class ROUTER_currency(Container):
provider_choices={
"provider": self._get_provider(
provider,
- "/currency/search",
+ "currency.search",
("fmp", "intrinio", "polygon"),
)
},
@@ -160,7 +158,7 @@ class ROUTER_currency(Container):
provider: Annotated[
Optional[Literal["fmp", "polygon"]],
OpenBBField(
- description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' 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: fmp, polygon."
),
] = None,
**kwargs
@@ -176,9 +174,7 @@ class ROUTER_currency(Container):
counter_currencies : Union[List[str], str, None]
An optional list of counter currency symbols to filter for. None returns all.
provider : Optional[Literal['fmp', 'polygon']]
- The provider to use for the query, by default None.
- If None, the provider specified in defaults is selected or 'fmp' 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: fmp, polygon.
Returns
-------
@@ -280,7 +276,7 @@ class ROUTER_currency(Container):
provider_choices={
"provider": self._get_provider(
provider,
- "/currency/snapshots",
+ "currency.snapshots",
("fmp", "polygon"),
)
},