rigs

This function returns location specific to a wellpad and its operating dates. It sends a post request to the Hyperion V4 rigs endpoint.

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

Syntax

=SMXH4.rigs(aggregate_by,county,date_observed_max,date_observed_min,operator,region_natgas,rig_class,state_code,sub_region_natgas)

---

Arguments

Parameter	Description	Example
aggregate_by	Specifies a parameter by which to aggregate data.	"date"
county	Limit search by county where the well is located.	"Winkler"
date_observed_max	A date in MM/DD/YYYY format	"11/24/2023"
date_observed_min	A date in MM/DD/YYYY format	"1/2/2023"
operator	Limit search by the name of the operator whose wells to retrieve.	"A WILLIAMS OIL"
region_natgas	Region divisions based on natural gas production profiles.	"gulf"
rig_class	Oil/Gas classification based on EIA-defined gas/oil production ratios	"oil"
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"

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 rigs for all operators in a specific operator:

=SMXH4.rigs("","CAMERON ENERGY CO","","","","","","","")

---

Input:

Output:

2. To retrieve rigs for a specific county and sub_region_natgas:

=SMXH4.rigs("","","","S LA","VERNON","","","","")

---

Input:

Output:

3. To retrieve rigs for all operators in a specific rig_class and region_natgas:

=SMXH4.rigs("","","northeast","","","","","","oil")

---

Input:

Output:

4. To retrieve rigs aggregated by county:

=SMXH4.rigs("county","","","","","","","","")

---

Input:

Output:

---

Output Parameters

Field	Type	Description	Example
count	integer		2
county	string	County in the state where the well is located.	“BEAUREGARD”
date_observed	string	A date in MM/DD/YYYY format	"11/24/2022"
lat	string	The latitude of the location, in decimal degrees; follows the WGS 84/EPSG:4326 coordinate system.	“32.2483475”
long	string	The longitude of the location, in decimal degrees; follows the WGS 84/EPSG:4326 coordinate system.	“-93.39548666666667”
operator	string	A well operator	“EXXON MOBIL”
region_natgas	string	Region divisions based on natural gas production profiles.	“gulf”
rig_class	string	Oil/Gas classification based on EIA-defined gas/oil production ratios	“oil”
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

---

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.