diff options
Diffstat (limited to 'openbb_platform/openbb/package/regulators_sec.py')
| -rw-r--r-- | openbb_platform/openbb/package/regulators_sec.py | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/openbb_platform/openbb/package/regulators_sec.py b/openbb_platform/openbb/package/regulators_sec.py index 0dc6319c271..b0d674356e8 100644 --- a/openbb_platform/openbb/package/regulators_sec.py +++ b/openbb_platform/openbb/package/regulators_sec.py @@ -46,6 +46,8 @@ class ROUTER_regulators_sec(Container): The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. + use_cache : Optional[bool] + Whether or not to use cache for the request, default is True. (provider: sec) Returns ------- @@ -115,7 +117,7 @@ class ROUTER_regulators_sec(Container): query : str Search query. use_cache : Optional[bool] - Whether or not to use cache. If True, cache will store for seven days. + Whether or not to use cache. provider : Optional[Literal['sec']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is @@ -139,7 +141,7 @@ class ROUTER_regulators_sec(Container): ------------------ name : Optional[str] The name of the institution. (provider: sec) - cik : Optional[Union[int, str]] + cik : Optional[Union[str, int]] Central Index Key (CIK) (provider: sec) Examples @@ -262,7 +264,7 @@ class ROUTER_regulators_sec(Container): query : str Search query. use_cache : Optional[bool] - Whether or not to use cache. If True, cache will store for seven days. + Whether or not to use cache. provider : Optional[Literal['sec']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is @@ -357,7 +359,7 @@ class ROUTER_regulators_sec(Container): query : str Search query. use_cache : Optional[bool] - Whether or not to use cache. If True, cache will store for seven days. + Whether or not to use cache. provider : Optional[Literal['sec']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is |