ducsbyoperator#
This function returns the count of drilled but uncompleted wells by county and operator. It sends a post request to the Hyperion V4 ducsbyoperator endpoint.
In the Formula Builder, select Hyperion 4.0, then choose the ducsbyoperator function from the Enter Function dropdown. Once selected, click Insert to automatically add the formula to Excel.
Syntax#
=SMXH4.ducsbyoperator(aggregate_by,region_natgas,state_code,sub_region_natgas,county,operator,date_observed_min,date_observed_max)
Arguments#
Parameter |
Description |
Example |
|---|---|---|
aggregate_by |
Specifies a parameter by which to aggregate data. |
|
region_natgas |
Region divisions based on natural gas production profiles. |
|
state_code |
Limit search by the state code where the wells are located. |
|
sub_region_natgas |
Subregion divisions based on natural gas production profiles. |
|
county |
Limit search by county where the well is located. |
|
operator |
Limit search by the name of the operator whose wells to retrieve. |
|
date_observed_min |
A date in MM/DD/YYYY format |
|
date_observed_max |
A date in MM/DD/YYYY format |
|
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.
Examples#
To retrieve DUCs for a specific operator and region_natgas:
=SMXH4.ducsbyoperator("","EXXON MOBIL","west", "","", "","","")
Input:
Output:
To retrieve DUCs with a specific sub_region_natgas:
=SMXH4.ducsbyoperator("","","", "S LA","", "","","")
Input:
Output:
To retrieve DUCs for a specific state code and operator:
=SMXH4.ducsbyoperator("","EXXON MOBIL","", "","", "CO","","")
Input:
Output:
To retrieve DUCs aggregated by date range:
=SMXH4.ducsbyoperator("","","", "","", "","1/12/2022","1/30/2022")
Input:
Output:
Output Parameters#
Field |
Type |
Description |
Example |
|---|---|---|---|
county |
|
County in the state where the well is located. |
“BEAUREGARD” |
date_observed |
|
A date in MM/DD/YYYY format |
|
ducs_count |
|
Number of drilled but uncompleted (DUC) wells. |
|
operator |
|
A well operator |
“EXXON MOBIL” |
region_natgas |
|
Region divisions based on natural gas production profiles. |
“gulf” |
state_code |
|
Abbreviation of the state. |
“TX” |
sub_region_natgas |
|
Subregion divisions based on natural gas production profiles. |
“West - TX” |
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.