summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPratyush Shukla <ps4534@nyu.edu>2024-03-15 00:54:33 +0530
committerPratyush Shukla <ps4534@nyu.edu>2024-03-15 00:54:33 +0530
commit9a1fd255a3c97696c7aa9e2b22fc7ea28f68e35e (patch)
tree3d948cfa7da3a6d811e77f267ebbb75a4213c3e4
parenteaf569100a22e6e5a26172de855c64d37a3be524 (diff)
update static
-rw-r--r--openbb_platform/openbb/assets/reference.json98
-rw-r--r--openbb_platform/openbb/package/equity_price.py9
-rw-r--r--openbb_platform/openbb/package/etf.py9
3 files changed, 83 insertions, 33 deletions
diff --git a/openbb_platform/openbb/assets/reference.json b/openbb_platform/openbb/assets/reference.json
index bdbae0cf973..790ab5b8303 100644
--- a/openbb_platform/openbb/assets/reference.json
+++ b/openbb_platform/openbb/assets/reference.json
@@ -17229,7 +17229,7 @@
"message": null
},
"description": "Get historical price data for a given stock. This includes open, high, low, close, and volume.",
- "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.historical(symbol='AAPL', provider='fmp')\nobb.equity.price.historical(symbol='AAPL', interval='1d', provider='intrinio')\n```\n\n",
+ "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.historical(symbol='AAPL', provider='fmp')\nobb.equity.price.historical(symbol='AAPL', interval=1d, provider='intrinio')\n```\n\n",
"parameters": {
"standard": [
{
@@ -17240,13 +17240,6 @@
"optional": false
},
{
- "name": "interval",
- "type": "str",
- "description": "Time interval of the data to return.",
- "default": "1d",
- "optional": true
- },
- {
"name": "start_date",
"type": "Union[date, str]",
"description": "Start date of the data, in YYYY-MM-DD format.",
@@ -17268,9 +17261,24 @@
"optional": true
}
],
- "fmp": [],
+ "fmp": [
+ {
+ "name": "interval",
+ "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']",
+ "description": "Time interval of the data to return.",
+ "default": "1d",
+ "optional": true
+ }
+ ],
"intrinio": [
{
+ "name": "interval",
+ "type": "Literal['1m', '5m', '10m', '15m', '30m', '60m', '1h', '1d', '1W', '1M', '1Q', '1Y']",
+ "description": "Time interval of the data to return.",
+ "default": "1d",
+ "optional": true
+ },
+ {
"name": "start_time",
"type": "datetime.time",
"description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'.",
@@ -17301,6 +17309,13 @@
],
"polygon": [
{
+ "name": "interval",
+ "type": "str",
+ "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y",
+ "default": "1d",
+ "optional": true
+ },
+ {
"name": "adjustment",
"type": "Literal['splits_only', 'unadjusted']",
"description": "The adjustment factor to apply. Default is splits only.",
@@ -17329,9 +17344,24 @@
"optional": true
}
],
- "tiingo": [],
+ "tiingo": [
+ {
+ "name": "interval",
+ "type": "Literal['1d', '1W', '1M', '1Y']",
+ "description": "Time interval of the data to return.",
+ "default": "1d",
+ "optional": true
+ }
+ ],
"yfinance": [
{
+ "name": "interval",
+ "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']",
+ "description": "Time interval of the data to return.",
+ "default": "1d",
+ "optional": true
+ },
+ {
"name": "extended_hours",
"type": "bool",
"description": "Include Pre and Post market data.",
@@ -19474,13 +19504,6 @@
"optional": false
},
{
- "name": "interval",
- "type": "str",
- "description": "Time interval of the data to return.",
- "default": "1d",
- "optional": true
- },
- {
"name": "start_date",
"type": "Union[date, str]",
"description": "Start date of the data, in YYYY-MM-DD format.",
@@ -19502,9 +19525,24 @@
"optional": true
}
],
- "fmp": [],
+ "fmp": [
+ {
+ "name": "interval",
+ "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']",
+ "description": "Time interval of the data to return.",
+ "default": "1d",
+ "optional": true
+ }
+ ],
"intrinio": [
{
+ "name": "interval",
+ "type": "Literal['1m', '5m', '10m', '15m', '30m', '60m', '1h', '1d', '1W', '1M', '1Q', '1Y']",
+ "description": "Time interval of the data to return.",
+ "default": "1d",
+ "optional": true
+ },
+ {
"name": "start_time",
"type": "datetime.time",
"description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'.",
@@ -19535,6 +19573,13 @@
],
"polygon": [
{
+ "name": "interval",
+ "type": "str",
+ "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y",
+ "default": "1d",
+ "optional": true
+ },
+ {
"name": "adjustment",
"type": "Literal['splits_only', 'unadjusted']",
"description": "The adjustment factor to apply. Default is splits only.",
@@ -19563,9 +19608,24 @@
"optional": true
}
],
- "tiingo": [],
+ "tiingo": [
+ {
+ "name": "interval",
+ "type": "Literal['1d', '1W', '1M', '1Y']",
+ "description": "Time interval of the data to return.",
+ "default": "1d",
+ "optional": true
+ }
+ ],
"yfinance": [
{
+ "name": "interval",
+ "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']",
+ "description": "Time interval of the data to return.",
+ "default": "1d",
+ "optional": true
+ },
+ {
"name": "extended_hours",
"type": "bool",
"description": "Include Pre and Post market data.",
diff --git a/openbb_platform/openbb/package/equity_price.py b/openbb_platform/openbb/package/equity_price.py
index 52e106d9081..3407164132d 100644
--- a/openbb_platform/openbb/package/equity_price.py
+++ b/openbb_platform/openbb/package/equity_price.py
@@ -32,10 +32,6 @@ class ROUTER_equity_price(Container):
description="Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance."
),
],
- interval: Annotated[
- Optional[str],
- OpenBBCustomParameter(description="Time interval of the data to return."),
- ] = "1d",
start_date: Annotated[
Union[datetime.date, None, str],
OpenBBCustomParameter(
@@ -62,8 +58,6 @@ class ROUTER_equity_price(Container):
----------
symbol : Union[str, List[str]]
Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.
- interval : Optional[str]
- Time interval of the data to return.
start_date : Union[datetime.date, None, str]
Start date of the data, in YYYY-MM-DD format.
end_date : Union[datetime.date, None, str]
@@ -72,6 +66,8 @@ class ROUTER_equity_price(Container):
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.
+ interval : Union[Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d'], Literal['1m', '5m', '10m', '15m', '30m', '60m', '1h', '1d', '1W', '1M', '1Q', '1Y'], str, Literal['1d', '1W', '1M', '1Y'], Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']]
+ Time interval of the data to return. (provider: fmp, intrinio, polygon, tiingo, yfinance)
start_time : Optional[datetime.time]
Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. (provider: intrinio)
end_time : Optional[datetime.time]
@@ -183,7 +179,6 @@ class ROUTER_equity_price(Container):
},
standard_params={
"symbol": symbol,
- "interval": interval,
"start_date": start_date,
"end_date": end_date,
},
diff --git a/openbb_platform/openbb/package/etf.py b/openbb_platform/openbb/package/etf.py
index 663014c576d..3f70786b2f1 100644
--- a/openbb_platform/openbb/package/etf.py
+++ b/openbb_platform/openbb/package/etf.py
@@ -192,10 +192,6 @@ class ROUTER_etf(Container):
description="Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance."
),
],
- interval: Annotated[
- Optional[str],
- OpenBBCustomParameter(description="Time interval of the data to return."),
- ] = "1d",
start_date: Annotated[
Union[datetime.date, None, str],
OpenBBCustomParameter(
@@ -222,8 +218,6 @@ class ROUTER_etf(Container):
----------
symbol : Union[str, List[str]]
Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.
- interval : Optional[str]
- Time interval of the data to return.
start_date : Union[datetime.date, None, str]
Start date of the data, in YYYY-MM-DD format.
end_date : Union[datetime.date, None, str]
@@ -232,6 +226,8 @@ class ROUTER_etf(Container):
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.
+ interval : Union[Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d'], Literal['1m', '5m', '10m', '15m', '30m', '60m', '1h', '1d', '1W', '1M', '1Q', '1Y'], str, Literal['1d', '1W', '1M', '1Y'], Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']]
+ Time interval of the data to return. (provider: fmp, intrinio, polygon, tiingo, yfinance)
start_time : Optional[datetime.time]
Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. (provider: intrinio)
end_time : Optional[datetime.time]
@@ -345,7 +341,6 @@ class ROUTER_etf(Container):
},
standard_params={
"symbol": symbol,
- "interval": interval,
"start_date": start_date,
"end_date": end_date,
},