completions

This function returns well completions, providing well-level frac job data organized by date. It sends a post request to the Hyperion V4 completions endpoint.

In the Formula Builder, select Hyperion 4.0, then choose the completions function from the Enter Function dropdown. Once selected, click Insert to automatically add the formula to Excel.

Syntax

=SMXH4.completions(aggregate_by,region_natgas,state_code,sub_region_natgas,county,operator,completion_class,date_completion_start_min,date_completion_start_max,date_completion_end_min,date_completion_end_max)

---

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"
completion_class	Oil/Gas classification based on EIA-defined gas/oil production ratios.	"oil"
date_completion_start_min	Completion start date minimum (format: “MM/DD/YYYY”).	"12/1/2021"
date_completion_start_max	Completion start date maximum (format: “MM/DD/YYYY”).	"12/31/2021"
date_completion_end_min	Completion end date minimum (format: “MM/DD/YYYY”).	"12/1/2022"
date_completion_end_max	Completion end date maximum (format: “MM/DD/YYYY”).	"12/31/2022"

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 completions for all operators in a specific region_natgas:

=SMXH4.completions("","","gulf","","","","","","","")

---

Input:

Output:

2. To retrieve completions for a specific operator and region_natgas:

=SMXH4.completions("","COMSTOCK","gulf","","","","","","","")

---

Input:

Output:

3. To retrieve completions with a specific date range and sub_region_natgas:

=SMXH4.completions("","","", "S LA","", "","1/2/2022","12/31/2024","","","")

---

Input:

Output:

---

Output Parameters

Field	Type	Description	Example
completion_class	string	Classifies wells as either oil or gas wells based on the GOR definition from the EIA.	“oil”
county	string	County in the state where the well is located.	“BEAUREGARD”
date_completion_start	date	Start date of well completion (format: “MM/DD/YYYY”).	“9/22/2021”
date_completion_end	date	End date of well completion (format: “MM/DD/YYYY”).	“9/26/2021”
operator	string	A well operator	“EXXON MOBIL”
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”
wellpad_id	string	Identifier of the wellpad.	27248
well_id	string	Unique well identifier	“4238939426”

Note

Wellpads located in Canada are tracked and identified by a prefix ‘C’ in the wellpad id.

---

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.