longtermforecast

This function returns production forecasts for gas production of the lower 48 for the next 12 months. It sends a post request to the Hyperion V4 longtermforecast endpoint.

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

Syntax

=SMXH4.longtermforecast(aggregate_by,date_prod_max,date_prod_min,region_natgas,sub_region_natgas)

---

Arguments

Parameter	Description	Example
aggregate_by	Specifies a parameter by which to aggregate data.	"date"
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"
region_natgas	Region divisions based on natural gas production profiles.	"gulf"
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. To retrieve long-term forecast data for a specific region_natgas:

=SMXH4.longtermforecast("","northeast", "","","")

---

Input:

Output:

2. To retrieve long-term forecast data filtered and aggregated by date_prod:

=SMXH4.longtermforecast("date_prod","", "","","")

---

Input:

Output:

3. To retrieve long-term forecast data within a specific sub_region_natgas:

=SMXH4.longtermforecast("","", "Haynesville - LA","","")

---

Input:

Output:

---

Output Parameters

Field	Type	Description	Example
date_prod	string	A date in MM/DD/YYYY format	“11/24/2022”
prod_dry_gas_bcf_day	number	Dry gas production per day in bfc	0.43068065
prod_oil_bbl_day	number	Daily oil production measured in barrels per day (bbl/day).	8
region_natgas	string	Region divisions based on natural gas production profiles.	“gulf”
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.