stfaggregatedhistory

This function returns historic versions of the ShortTermForecasts on a sub-region aggregated level.

The sub-region aggregated data is more tractable for higher level analysis in comparison to the more detailed and much larger well-level ShortTermForecastHistory dataset.

---

Note

• This function offers sub-region aggregated versions of all historical SynMax ShortTermForecasts going back in three days increments until 2021-01-15.

• Each version of the ShortTermForecast can be uniquely identified by the forecast_run_date.

• Incomplete state data is accounted for in our forecasts. For example, if state data is incomplete for a month prior to the start_date, we fill in the missing data before each forecasting.

• Production numbers are reported on a dry basis.

It sends a post request to the Hyperion V4 stfaggregatedhistory endpoint.

In the Formula Builder, select Hyperion 4.0, then choose the stfaggregatedhistory function from the Enter Function dropdown. Next, select the required fields and click Insert to automatically add the formula to Excel.

Syntax

=SMXH4.stfaggregatedhistory(sub_region_natgas,date_forecast_run,date_prod_min,date_prod_max)

---

Arguments

Parameter	Description	Example
date_forecast_run	Date of nearest forecast (unsynced). (format: “YYYY-MM-DD”)	"2025-11-14"
date_prod_max	A date in MM/DD/YYYY format	"12/31/2023"
date_prod_min	A date in MM/DD/YYYY format	"1/6/2023"
sub_region_natgas	Subregion divisions based on natural gas production profiles.	"S LA"

Note

Performance considerations: This function may take some time to retrieve and organize large amounts of data. For best performance, it is recommended to limit the number of input parameters and retrieve only the data needed for analysis.

Note

No Data: Output data will return “No Data” when input data is invalid or does not exist.

Examples

1. Get a short-term forecast aggregated history for a specific dateforecastrun:

=SMXH4.stfaggregatedhistory("","","","2025-11-14")

---

Input:

Output:

2. Get short-term forecast aggregated history for a specific subregion and dateforecastrun:

=SMXH4.stfaggregatedhistory("Central - TX","","","2025-11-14")

---

Input:

Output:

Output Parameters

Field	Type	Description	Example
date_forecast_run	string	A date in MM/DD/YYYY format	“11/24/2021”
date_prod	string	A date in MM/DD/YYYY format	“1/1/2022 0:00”
prod_dry_gas_bcf_day	number	Dry gas production per day in bfc	0.43068065
prod_oil_mbbl_day	number	Daily oil production measured in barrels per day (mbbl/day).	8
sub_region_natgas	string	Subregion divisions based on natural gas production profiles.	“West - TX”

---

Errors

Functions may return the following error messages:

Error	Description
#VALUE!	Input parameters are invalid or cannot be parsed.
#REF!	The function cannot retrieve data from the SynMaxax API due to a network or connectivity issue.
!!! EXCEPTION	Invalid input parameters. Make sure dates are enclosed in quotes. Check if the API key is valid. To know more about how to use an API key, please check the section on authentication.
#No Data	Input data is invalid or does not exist.

Note

You can also check the logs for more information on errors. You can access the logs by clicking on SynMax Commodities on the Excel ribbon and then clicking on Logs.