productionbywell

This function returns well-level monthly oil and gas production. It sends a post request to the Hyperion V4 productionbywell endpoint.

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

Syntax

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

---

Arguments

Parameter	Description	Example
aggregate_by	Specifies a parameter by which to aggregate data.	"date"
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"
county	Limit search by county where the well is located.	"Winkler"
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
date_prod_min	A date in MM/DD/YYYY format	"1/6/2023"
date_prod_max	A date in MM/DD/YYYY format	"12/31/2023"
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. To retrieve production by a specific operator in a specific region_natgas:

=SMXH4.productionbywell("","EXXCEL OPERATING COMPANY","gulf","","","","","","","")

---

Input:

Output:

2. To retrieve production in a specific sub_region_natgas and county for a specific production month:

=SMXH4.productionbywell("","","","Central - TX","LIMESTONE","","5","","","")

---

Input:

Output:

3. To retrieve production aggregated by date_prod:

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

---

Input:

Output:

Output Parameters

Field	Type	Description	Example
county	string	County in the state where the well is located.	“BEAUREGARD”
date_prod	string	A date in MM/DD/YYYY format	“11/24/2022”
field_name	string	The name of a specific oil and gas field - as designated by the appropriate state agency.	"PEARSALL (AUSTIN CHALK)"
formation	string		"oil shale formation"
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_water_bbl_day	number	Daily water production measured in barrels per day(bbl/day).	9850.741909
prod_water_bbl_month	number	Monthly water production measured in barrels per month (bbl/month).	305373
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
range	string		16W
region_natgas	string	Region divisions based on natural gas production profiles.	“gulf”
section	string		34
state_code	string	Abbreviation of the state.	“TX”
sub_region_natgas	string	Subregion divisions based on natural gas production profiles.	“West - TX”
township	string		21N
well_id	string	Unique well identifier	“4238939426”
well_name	string	The name assigned to a well at a specific site.	SL 2259
well_no	string	The number assigned to a well at a specific site.	3

---

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.