wells

This function returns Well level details. Well level data derived from all sources. It sends a post request to the Hyperion V4 wells endpoint.

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

Syntax

=SMXH4.wells(aggregate_by,region_natgas,state_code,sub_region_natgas,operator,produced_basin,produced_formation,date_first_production_min,date_first_production_max,date_spud_min,date_spud_max,depth_min,depth_max,horizontal_length_min,horizontal_length_max,lat_surface_min,lat_surface_max,lon_surface_min,lon_surface_max,well_id,wellpad_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"
operator	Limit search by the name of the operator whose wells to retrieve.	"A WILLIAMS OIL"
produced_basin
producted_formation
date_first_production_min	A date in MM/DD/YYYY format	"11/27/2022"
date_first_production_max	A date in MM/DD/YYYY format	"12/27/2022"
date_spud_min	A date in MM/DD/YYYY format	"11/27/2022"
date_spud_max	A date in MM/DD/YYYY format	"12/27/2022"
depth_min
depth_max
horizontal_length_min
horizontal_length_max
lat_surface_min
lat_surface_max
lon_surface_min
lon_surface_max
well_id	A well identifier	"4900552885"
wellpad_id	A wellpad identifier	"717476"

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 well level details for specific region_natgas state_code and sub_region_natgas aggregated by the fields you want:

=SMXH4.wells("county;date_first_production;date_spud;region_natgas;sub_region_natgas;state_code;produced_formation;produced_basin;operator","","","","gulf","Central - TX","","TX","","","","","","","","","","","","","","")

---

Input:

Output:

---

Output Parameters

Field	Type	Description	Example
county	string	County in the state where the well is located.	“BEAUREGARD”
date_first_production	date	(Unsynced) date on which the well was first productive after completion.
date_spud	string	Spudding is the day the main drill bit enters the ground, which leads to the removal of rock, dirt, and sedimentary materials.
operator	string	A well operator	“EXXON MOBIL”
produced_basin
produced_formation
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”

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.