shorttermforecastdeclines

This function returns long-term well declines at a monthly rate. It sends a post request to the Hyperion V4 shorttermforecastdeclines endpoint.

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

Syntax

=SMXH4.shorttermforecastdeclines(aggregate_by,aggregation_type,county,date_prod_max,date_prod_min,first_production_month_max,first_production_month_min,modeled,operator,production_month,production_month_max,production_month_min,region_natgas,state_code,state_reported,sub_region_natgas,well_id)

---

Arguments

Parameter	Description	Example
aggregate_by	Specifies a parameter by which to aggregate data.	"date"
aggregation_type	The type of aggregation applied to data	"sum"
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"
modeled	The production numbers are from our forecast	True
operator	Limit search by the name of the operator whose wells to retrieve.	"A WILLIAMS OIL"
production_month	Specific production months of specific wells. Starts from 1 and increases by 1 for each subsequent month.	4
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"
state_reported	Has the state published any production numbers for this well	False
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 short-term forecast declines for a specific production_month and sub_region_natgas:

=SMXH4.shorttermforecastdeclines("","","","",   "S LA","","","","3","","","","","","")

---

Input:

Output:

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

=SMXH4.shorttermforecastdeclines("","","CONLEY MOTOR INNS INC","",   "","","","","","","","","","","")

---

Input:

Output:

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

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

---

Input:

Output:

---

Output Parameters

Field	Type	Description	Example
count	integer	Number of drilled but uncompleted wells (DUCs) on a specific date within the input date range.	2
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”
first_production_month	string [“YYYY-MM-DD”]	Start of date range for selecting wells that started producing in the specific month. Format: Format: “YYYY-MM-01”	“2009-10-01”
modeled	boolean	Indicates whether the production numbers are from the forecast model (True) or from pipescrapes (False).	True, False
operator	string	A well operator	“EXXON MOBIL”
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
prod_wet_gas_mcf_day	number	Daily wet gas production measured in thousand cubic feet per day (MCF/day).	16.870967
prod_wet_gas_mcf_month	number	Monthly wet gas production measured in thousand cubic feet per month (MCF/month).	523
production_month	integer	The production month to retrieve completions for. Defaults to the latest month available if not specified.	496
region_natgas	string	Region divisions based on natural gas production profiles.	“gulf”
state_code	string	Abbreviation of the state.	“TX”
state_reported	boolean	Indicates whether the data is sourced from state-reported records.	TRUE
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.