ProductionByWell

This endpoint returns monthly oil and gas production figures for a specific well. Oil production and gas production volumes are displayed in BBLS (barrels) and MMCF (1 million cubic feet) respectively.

Syntax

=SMX.ProductionByWell(Aggregate By, Operator, State Code, Region, Subregion, County, Production Month, Start Date, End Date)

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"
Production Month	Limit search by the number of elapsed months from the date of well completion.	"2"
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"

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 production by a specific operator in a specific region:

=SMX.ProductionByWell(,"ZACHARY EXPLORATION", "GULF",,,)

2. To retrieve production in a specific subregion for a specific production month:

=SMX.ProductionByWell(,,,"S LA",,1)

3. To retrieve production with a start date and an end date for a specific operator and subregion:

=SMX.ProductionByWell(,"ZACHARY EXPLORATION",,"S LA",,,"2021-6-1","2022-6-1")

4. To retrieve production aggregated by sub_region:

=SMX.ProductionByWell("sub_region")

---

Output Parameters

Field	Type	Description	Example
api	integer	An API is a unique, permanent, numeric identifier assigned to each well drilled.	1701121257
county	string	County in the state where the well is located.	“BEAUREGARD”
date	string [“YYYY-MM-DD”]	Unsynced date on which oil and gas production starts.	“2022-06-01”
field_name	string	The name of a specific oil and gas field - as designated by the appropriate state agency.	“Caddo Pine Island”
formation	string	Definition of the geological makeup (formation) at a specific well.	“oil shale formation”
gas_daily	float	Average rate of gas production expressed per day (in BCF/day).	23.842
gas_monthly	float	Amount of gas produced over one month (in MMCF, or 1 million cubic feet).	98801.0
oil_daily	float	The amount of oil produced in a single day (in BBLS, or barrels).	112.9570761
oil_monthly	float	The amount of oil produced over one month (in BBLS, or barrels).	279.5
operator_name	string	Operator of the well.	“PIE OPERATING, LLC”
production_month	integer	The production month to retrieve completions for. Defaults to the latest month available if not specified.	496
range	string	Ranges are columns of townships set side-by-side. Range numbers start at the meridian that passes through the point of origin of each system and runs east to west.	“16W”
region	string	Aggregation of multiple major producing basins.	“GULF”
section	integer	A section is a further subdivision of a township, represented by a numerical value between 1 and 36. Each section is about 1 square mile.	“34”
state_ab	string	Abbreviation of the state.	“LA”
sub_region	string	Aggregation of several counties, typically representing a major producing basin.	“S LA”
township	string	Townships are divisions of a county, shaped as squares with 6 miles to a side. Township squares are gridded and numbered according to their position north or south of the baseline.	“21N”
water_daily	float	The amount of water extracted from the well during a single day (in BBLs, or barrels).	23.296827
water_monthly	integer	The amount of water extracted from the well during a one-month production period (in BBLs, or barrels).	947
well_name	string	The name assigned to a well at a specific site.	“SL 2259”
well_no	string	The number assigned to a well at a specific site.	“058”

Note

Unsynced data in the date column provides a date at the start of the month. However, the actual reported date is for the end of the month.

For example, if the reported date is “2022-1-10”, this means the data pertains to the month of January and was actually reported on “2022-01-31”.

This means that you should ideally interpret the reported date as representing the whole month, not just the specific date at the start of the month.

---

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.