Rigs

This endpoint provides users with rig locations specific to a wellpad and its operating dates.

Syntax

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

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"
Rig Class	Specifies either oil or gas wells based on the GOR definition from the EIA.	"oil"

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. To retrieve rigs for all operators in a specific region:

=@SMX.Rigs(,,"GULF")

2. To retrieve rigs for a specific operator and state:

=SMX.Rigs(,"SHELL",,,"LA")

3. To retrieve rigs with a start date and an end date for a specific operator and state:

=SMX.Rigs(,"COMSTOCK",,,"LA","2022-1-1","2022-12-31")

4. To retrieve rigs aggregated by date:

=SMX.Rigs("date")

---

Output Parameters

Field	Type	Description	Example
county	string	County in the state where the well is located.	“BEAUREGARD”
date	string [“YYYY-MM-DD”]	Date on which a rig is operating.	“2022-06-01”
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_name	string	Operator of the well.	“PIE OPERATING, LLC”
region	string	Aggregation of multiple major producing basins.	“GULF”
rig_class	string	Classifies wells as either oil or gas wells based on the GOR definition from the EIA.	“oil”
rigs_count	int	Number of rigs operating on a particular date.	133
state_ab	string	Abbreviation of the state.	“LA”
sub_region	string	Aggregation of several counties, typically representing a major producing basin.	“S LA”
wellpad_id	string	Identifier of the wellpad.	27248

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