ShortTermForecast

This endpoint returns short-term, monthly gas production forecasts for well APIs. Average rate of gas production is expressed in BCF/day.

Short-term forecasting achieves two primary functions:

• Removing gaps that exist in state data by predicting unreported gas production.

• Predicting future gas production up to three months from a given date.

---

Syntax

=SMX.ShortTermForecast(Aggregate By, Operator, State Code, Region, Subregion, County, Start Date, End Date)

Arguments

Parameter	Description	Example
Aggregate By	Specifies a parameter by which to aggregate data.	"date"
Operator	Limit search by the name of the operator whose wells to retrieve.	"A WILLIAMS OIL"
State Code	Limit search by the state code where the wells are located.	"CO"
Region	Limit search by the name of the region where the wells are located.	"west"
Subregion	Limit search by the name of the subregion where the wells are located.	"Haynesville - TX"
County	Limit search by county where the well is located.	"Winkler"
Start Date	Limit search to a start date [“YYYY-MM-DD”].	"2022-12-01"
End Date	Limit search to an end date [“YYYY-MM-DD”].	"2022-12-01"

Data can be aggregated by: county, date, operator, region, state_code, sub_region.

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 operator and region:

=SMX.ShortTermForecast(,"SHELL","GULF")

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

=SMX.ShortTermForecast(,,,"S LA")

3. Get a short-term forecast for a specific subregion:

=SMX.ShortTermForecast(,"SHELL",,,,"2023-1-1","2024-1-1")

4. Get a short-term forecast aggregated by operator:

=SMX.ShortTermForecast("operator")

---

Output Parameters

Field	Type	Description	Example
api	integer	An API is a unique, permanent, numeric identifier assigned to each well drilled.	1701121257
county_name	string	County in the state where the well is located.	“BEAUREGARD”
date	string [“YYYY-MM-DD”]	Forecasted month (unsynced).	“2022-11-01”
forecast_run_date	string [“YYYY-MM-DD”]	Date of forecast generation (unsynced).	“2022-11-01”
gas_daily	float	Average rate of gas production expressed per day (in BCF/day).	23.842
gas_monthly	integer	Amount of gas produced over one month (in MMCF, or 1 million cubic feet).	98801
operator_name	string	Operator of the well.	“PIE OPERATING, LLC”
region	string	Aggregation of multiple major producing basins.	“GULF”
state_ab	string	Abbreviation of the state.	“LA”
sub_region	string	Aggregation of several counties, typically representing a major producing basin.	“S LA”

Note

Unsynced data in the date column provides a date at the start of the month. However, the actual reported date is for the end of the month.

For example, if the reported date is “2022-1-10”, this means the data pertains to the month of January and was actually reported on “2022-01-31”.

This means that you should ideally interpret the reported date as representing the whole month, not just the specific date at the start of the month.

---

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 Energy on the Excel ribbon and then clicking on Logs.