shorttermforecast

This function returns short-term, monthly gas production forecasts for well APIs. It sends a post request to the Hyperion V4 shorttermforecast endpoint.

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

Syntax

=SMXH4.shorttermforecast(aggregate_by,county,date_prod_max,date_prod_min,operator,region_natgas,state_code,sub_region_natgas,well_id)

---

Arguments

Parameter	Description	Example
aggregate_by	Specifies a parameter by which to aggregate data.	"date"
county	Limit search by county where the well is located.	"Winkler"
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"
operator	Limit search by the name of the operator whose wells to retrieve.	"A WILLIAMS OIL"
region_natgas	Region divisions based on natural gas production profiles.	"gulf"
state_code	Limit search by the state code where the wells are located.	"CO"
sub_region_natgas	Subregion divisions based on natural gas production profiles.	"S LA"
well_id	A well identifier	"4900552885"

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 for a specific county and sub_region_natgas:

=SMXH4.shorttermforecast("","","","S LA","CONCORDIA","","","","")

---

Input:

Output:

2. Get a short-term forecast for a specific operator:

=SMXH4.shorttermforecast("","ENERGYPRO INC","","","","","","","")

---

Input:

Output:

3. Get a short-term forecast aggregated by region_natgas:

=SMXH4.shorttermforecast("region_natgas","","","","","","","","")

---

Input:

Output:

---

Output Parameters

Field	Type	Description	Example
county	string	County in the state where the well is located.	“BEAUREGARD”
date_forecast_run	string	A date in MM/DD/YYYY format	“11/24/2021”
date_prod	string	A date in MM/DD/YYYY format	“11/24/2022”
operator	string	A well operator	“EXXON MOBIL”
prod_dry_gas_mcf_day	number	Daily dry gas production measured in thousand cubic feet per day (MCF/day).	27.55712903
prod_dry_gas_mcf_month	number	Monthly dry gas production measured in thousand cubic feet per month (MCF/month).	854.271
prod_oil_bbl_day	number	Daily oil production measured in barrels per day (bbl/day).	8
prod_oil_bbl_month	number	Monthly oil production measured in barrels per month (bbl/month).	29
region_natgas	string	Region divisions based on natural gas production profiles.	“gulf”
state_code	string	Abbreviation of the state.	“TX”
sub_region_natgas	string	Subregion divisions based on natural gas production profiles.	“West - TX”
well_id	string	Unique well identifier	“4238939426”

---

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.