summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPratyush Shukla <ps4534@nyu.edu>2024-03-17 00:58:56 +0530
committerPratyush Shukla <ps4534@nyu.edu>2024-03-17 00:58:56 +0530
commit6aa2c297bde91fb0a7c9384803661a20ca7e204c (patch)
tree42d77bb46562a8f3bf807bc0d4a4cb9149fe0215
parent3599691dc03e0c86683a555658243bb256a897ad (diff)
updated static
-rw-r--r--openbb_platform/openbb/assets/reference.json330
-rw-r--r--openbb_platform/openbb/package/economy.py2
-rw-r--r--openbb_platform/openbb/package/equity_fundamental.py12
-rw-r--r--openbb_platform/openbb/package/equity_price.py10
-rw-r--r--openbb_platform/openbb/package/etf.py2
-rw-r--r--openbb_platform/openbb/package/index.py4
6 files changed, 339 insertions, 21 deletions
diff --git a/openbb_platform/openbb/assets/reference.json b/openbb_platform/openbb/assets/reference.json
index fd9de6d9d5d..a8f29d3346c 100644
--- a/openbb_platform/openbb/assets/reference.json
+++ b/openbb_platform/openbb/assets/reference.json
@@ -2760,6 +2760,13 @@
],
"fred": [
{
+ "name": "limit",
+ "type": "int",
+ "description": "The number of data entries to return.",
+ "default": 100000,
+ "optional": true
+ },
+ {
"name": "frequency",
"type": "Literal[None, 'a', 'q', 'm', 'w', 'd', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']",
"description": "Frequency aggregation to convert high frequency data to lower frequency. None = No change a = Annual q = Quarterly m = Monthly w = Weekly d = Daily wef = Weekly, Ending Friday weth = Weekly, Ending Thursday wew = Weekly, Ending Wednesday wetu = Weekly, Ending Tuesday wem = Weekly, Ending Monday wesu = Weekly, Ending Sunday wesa = Weekly, Ending Saturday bwew = Biweekly, Ending Wednesday bwem = Biweekly, Ending Monday",
@@ -4557,6 +4564,13 @@
],
"benzinga": [
{
+ "name": "action",
+ "type": "Literal['Downgrades', 'Maintains', 'Reinstates', 'Reiterates', 'Upgrades', 'Assumes', 'Initiates Coverage On', 'Terminates Coverage On', 'Removes', 'Suspends', 'Firm Dissolved']",
+ "description": "Description of the change in rating from firm's last rating.Note that all of these terms are precisely defined.",
+ "default": null,
+ "optional": true
+ },
+ {
"name": "action_change",
"type": "Literal['Announces', 'Maintains', 'Lowers', 'Raises', 'Removes', 'Adjusts']",
"description": "Description of the change in price target from firm's last price target.",
@@ -6967,9 +6981,24 @@
"optional": true
}
],
- "fmp": [],
+ "fmp": [
+ {
+ "name": "period",
+ "type": "Literal['annual', 'quarter']",
+ "description": "None",
+ "default": "annual",
+ "optional": true
+ }
+ ],
"intrinio": [
{
+ "name": "period",
+ "type": "Literal['annual', 'quarter']",
+ "description": "None",
+ "default": "annual",
+ "optional": true
+ },
+ {
"name": "fiscal_year",
"type": "int",
"description": "The specific fiscal year. Reports do not go beyond 2008.",
@@ -6979,6 +7008,13 @@
],
"polygon": [
{
+ "name": "period",
+ "type": "Literal['annual', 'quarter', 'ttm']",
+ "description": "None",
+ "default": "annual",
+ "optional": true
+ },
+ {
"name": "filing_date",
"type": "date",
"description": "Filing date of the financial statement.",
@@ -7070,7 +7106,15 @@
"optional": true
}
],
- "yfinance": []
+ "yfinance": [
+ {
+ "name": "period",
+ "type": "Literal['annual', 'quarter']",
+ "description": "None",
+ "default": "annual",
+ "optional": true
+ }
+ ]
},
"returns": {
"OBBject": [
@@ -8719,9 +8763,24 @@
"optional": true
}
],
- "fmp": [],
+ "fmp": [
+ {
+ "name": "period",
+ "type": "Literal['annual', 'quarter']",
+ "description": "None",
+ "default": "annual",
+ "optional": true
+ }
+ ],
"intrinio": [
{
+ "name": "period",
+ "type": "Literal['annual', 'quarter', 'ttm', 'ytd']",
+ "description": "None",
+ "default": "annual",
+ "optional": true
+ },
+ {
"name": "fiscal_year",
"type": "int",
"description": "The specific fiscal year. Reports do not go beyond 2008.",
@@ -8731,6 +8790,13 @@
],
"polygon": [
{
+ "name": "period",
+ "type": "Literal['annual', 'quarter']",
+ "description": "None",
+ "default": "annual",
+ "optional": true
+ },
+ {
"name": "filing_date",
"type": "date",
"description": "Filing date of the financial statement.",
@@ -8822,7 +8888,15 @@
"optional": true
}
],
- "yfinance": []
+ "yfinance": [
+ {
+ "name": "period",
+ "type": "Literal['annual', 'quarter']",
+ "description": "None",
+ "default": "annual",
+ "optional": true
+ }
+ ]
},
"returns": {
"OBBject": [
@@ -9585,6 +9659,20 @@
],
"intrinio": [
{
+ "name": "period",
+ "type": "Literal['annual', 'quarter']",
+ "description": "None",
+ "default": "annual",
+ "optional": true
+ },
+ {
+ "name": "statement_type",
+ "type": "Literal['balance', 'income', 'cash']",
+ "description": "Cash flow statements are reported as YTD, Q4 is the same as FY.",
+ "default": "income",
+ "optional": true
+ },
+ {
"name": "fiscal_year",
"type": "int",
"description": "The specific fiscal year. Reports do not go beyond 2008.",
@@ -10789,9 +10877,24 @@
"optional": true
}
],
- "fmp": [],
+ "fmp": [
+ {
+ "name": "period",
+ "type": "Literal['annual', 'quarter']",
+ "description": "None",
+ "default": "annual",
+ "optional": true
+ }
+ ],
"intrinio": [
{
+ "name": "period",
+ "type": "Literal['annual', 'quarter', 'ttm', 'ytd']",
+ "description": "None",
+ "default": "annual",
+ "optional": true
+ },
+ {
"name": "fiscal_year",
"type": "int",
"description": "The specific fiscal year. Reports do not go beyond 2008.",
@@ -10801,6 +10904,13 @@
],
"polygon": [
{
+ "name": "period",
+ "type": "Literal['annual', 'quarter', 'ttm']",
+ "description": "None",
+ "default": "annual",
+ "optional": true
+ },
+ {
"name": "filing_date",
"type": "date",
"description": "Filing date of the financial statement.",
@@ -10892,7 +11002,15 @@
"optional": true
}
],
- "yfinance": []
+ "yfinance": [
+ {
+ "name": "period",
+ "type": "Literal['annual', 'quarter']",
+ "description": "None",
+ "default": "annual",
+ "optional": true
+ }
+ ]
},
"returns": {
"OBBject": [
@@ -13983,9 +14101,24 @@
"optional": true
}
],
- "fmp": [],
+ "fmp": [
+ {
+ "name": "period",
+ "type": "Literal['annual', 'quarter', 'ttm']",
+ "description": "Time period of the data to return.",
+ "default": "annual",
+ "optional": true
+ }
+ ],
"intrinio": [
{
+ "name": "period",
+ "type": "Literal['annual', 'quarter', 'ttm', 'ytd']",
+ "description": "Time period of the data to return.",
+ "default": "annual",
+ "optional": true
+ },
+ {
"name": "fiscal_year",
"type": "int",
"description": "The specific fiscal year. Reports do not go beyond 2008.",
@@ -17268,9 +17401,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 +17449,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 +17484,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.",
@@ -17849,7 +18019,15 @@
"optional": true
}
],
- "fmp": []
+ "fmp": [
+ {
+ "name": "symbol",
+ "type": "str",
+ "description": "The ticker symbol.",
+ "default": "",
+ "optional": false
+ }
+ ]
},
"model": "PricePerformance"
},
@@ -18107,6 +18285,13 @@
],
"sec": [
{
+ "name": "name",
+ "type": "str",
+ "description": "None",
+ "default": null,
+ "optional": true
+ },
+ {
"name": "cik",
"type": "str",
"description": "Central Index Key",
@@ -19515,9 +19700,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'.",
@@ -19548,6 +19748,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.",
@@ -19576,9 +19783,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.",
@@ -21453,7 +21675,15 @@
"optional": true
}
],
- "fmp": [],
+ "fmp": [
+ {
+ "name": "symbol",
+ "type": "str",
+ "description": "The ticker symbol.",
+ "default": "",
+ "optional": false
+ }
+ ],
"intrinio": [
{
"name": "max_annualized",
@@ -22708,7 +22938,15 @@
"optional": true
}
],
- "fmp": []
+ "fmp": [
+ {
+ "name": "symbol",
+ "type": "str",
+ "description": "The ticker symbol.",
+ "default": "",
+ "optional": false
+ }
+ ]
},
"model": "EtfHoldingsPerformance"
},
@@ -24739,7 +24977,15 @@
"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": "limit",
@@ -24751,6 +24997,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": "sort",
"type": "Literal['asc', 'desc']",
"description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.",
@@ -24765,7 +25018,15 @@
"optional": true
}
],
- "yfinance": []
+ "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
+ }
+ ]
},
"returns": {
"OBBject": [
@@ -24923,7 +25184,15 @@
"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": "limit",
@@ -24935,6 +25204,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": "sort",
"type": "Literal['asc', 'desc']",
"description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.",
@@ -24949,7 +25225,15 @@
"optional": true
}
],
- "yfinance": []
+ "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
+ }
+ ]
},
"returns": {
"OBBject": [
@@ -25086,7 +25370,15 @@
"optional": true
}
],
- "fmp": []
+ "fmp": [
+ {
+ "name": "symbol",
+ "type": "Literal['dowjones', 'sp500', 'nasdaq']",
+ "description": "None",
+ "default": "dowjones",
+ "optional": true
+ }
+ ]
},
"returns": {
"OBBject": [
diff --git a/openbb_platform/openbb/package/economy.py b/openbb_platform/openbb/package/economy.py
index b14cf8a76bd..da34fcd25db 100644
--- a/openbb_platform/openbb/package/economy.py
+++ b/openbb_platform/openbb/package/economy.py
@@ -756,6 +756,8 @@ class ROUTER_economy(Container):
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fred' if there is
no default.
+ limit : int
+ The number of data entries to return. (provider: fred)
frequency : Literal[None, 'a', 'q', 'm', 'w', 'd', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']
Frequency aggregation to convert high frequency data to lower frequency.
diff --git a/openbb_platform/openbb/package/equity_fundamental.py b/openbb_platform/openbb/package/equity_fundamental.py
index 862cb291ef4..29e16e72f47 100644
--- a/openbb_platform/openbb/package/equity_fundamental.py
+++ b/openbb_platform/openbb/package/equity_fundamental.py
@@ -82,6 +82,8 @@ class ROUTER_equity_fundamental(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.
+ period : Optional[Union[Literal['annual', 'quarter'], Literal['annual', 'quarter', 'ttm']]]
+ None (provider: fmp, intrinio, polygon, yfinance)
fiscal_year : Optional[int]
The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)
filing_date : Optional[datetime.date]
@@ -602,6 +604,8 @@ class ROUTER_equity_fundamental(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.
+ period : Optional[Union[Literal['annual', 'quarter'], Literal['annual', 'quarter', 'ttm', 'ytd']]]
+ None (provider: fmp, intrinio, polygon, yfinance)
fiscal_year : Optional[int]
The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)
filing_date : Optional[datetime.date]
@@ -1652,6 +1656,8 @@ class ROUTER_equity_fundamental(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.
+ period : Optional[Union[Literal['annual', 'quarter'], Literal['annual', 'quarter', 'ttm', 'ytd'], Literal['annual', 'quarter', 'ttm']]]
+ None (provider: fmp, intrinio, polygon, yfinance)
fiscal_year : Optional[int]
The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)
filing_date : Optional[datetime.date]
@@ -3103,6 +3109,8 @@ class ROUTER_equity_fundamental(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.
+ period : Union[Literal['annual', 'quarter', 'ttm'], Literal['annual', 'quarter', 'ttm', 'ytd']]
+ Time period of the data to return. (provider: fmp, intrinio)
fiscal_year : Optional[int]
The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)
@@ -3313,6 +3321,10 @@ class ROUTER_equity_fundamental(Container):
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.
+ period : Literal['annual', 'quarter']
+ None
+ statement_type : Literal['balance', 'income', 'cash']
+ Cash flow statements are reported as YTD, Q4 is the same as FY. (provider: intrinio)
fiscal_year : Optional[int]
The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)
diff --git a/openbb_platform/openbb/package/equity_price.py b/openbb_platform/openbb/package/equity_price.py
index 52e106d9081..7c95f11464d 100644
--- a/openbb_platform/openbb/package/equity_price.py
+++ b/openbb_platform/openbb/package/equity_price.py
@@ -72,6 +72,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]
@@ -354,6 +356,8 @@ class ROUTER_equity_price(Container):
PricePerformance
----------------
+ symbol : Optional[str]
+ Symbol representing the entity requested in the data.
one_day : Optional[float]
One-day return.
wtd : Optional[float]
@@ -374,16 +378,18 @@ class ROUTER_equity_price(Container):
Year to date return.
one_year : Optional[float]
One-year return.
+ two_year : Optional[float]
+ Two-year return.
three_year : Optional[float]
Three-year return.
+ four_year : Optional[float]
+ Four-year
five_year : Optional[float]
Five-year return.
ten_year : Optional[float]
Ten-year return.
max : Optional[float]
Return from the beginning of the time series.
- symbol : Optional[str]
- The ticker symbol. (provider: fmp)
Examples
--------
diff --git a/openbb_platform/openbb/package/etf.py b/openbb_platform/openbb/package/etf.py
index fba9012a51e..13f55c4fdee 100644
--- a/openbb_platform/openbb/package/etf.py
+++ b/openbb_platform/openbb/package/etf.py
@@ -232,6 +232,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]
diff --git a/openbb_platform/openbb/package/index.py b/openbb_platform/openbb/package/index.py
index 0d945611d79..091b95ccd8a 100644
--- a/openbb_platform/openbb/package/index.py
+++ b/openbb_platform/openbb/package/index.py
@@ -121,6 +121,8 @@ class ROUTER_index(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.
+ symbol : Literal['dowjones', 'sp500', 'nasdaq']
+ None
<