/productionbycountyandoperator

This endpoint returns oil and gas production data by county and operator at the monthly level.

Attention

This endpoint is deprecated. Please use /productionbywell with aggregation instead.

Row Limit

Currently limited to one million rows per request. This endpoint will throw an error when you exceed one millions rows for a single request. To avoid this error simply apply additional filters to your request.

Warning

A throttling mechanism with a rate limit of 300 requests per minute has been implemented for this endpoint. This is temporary and may be adjusted in the future.

Endpoint

POST	https://hyperion.api.synmax.com/v3/productionbycountyandoperator

Usage

Python

production_by_county_and_operator(operator=[None], state_code=[None], region=[None], sub_region=[None], start_date=None, end_date=None, aggregate_by=[None])

Returns oil production from a starting date to an ending date organized by county and operator.

Object returned is a pandas DataFrame.

⮞ Setup the client.

from synmax.hyperion import HyperionApiClient, ApiPayload
access_token = 'your access token goes here'
client = HyperionApiClient(access_token=access_token)

For a more detailed guide on setting up the Hyperion client, please see the Quickstart page.

⮞ Use parameters to narrow down your request.

payload = ApiPayload(start_date='2021-05-01', end_date='2022-06-25', sub_region=['S LA', 'West - TX'])

Tip

Narrow down your request to receive a faster response. Using no parameters will fetch the entire dataset which may take a very long time.

⮞ Call the function.

result_df = client.production_by_county_and_operator(payload)

⮞ Print the results or save them for later.

# Print the entire response as a string.
print(result_df.to_string())

# Create a CSV file from the output.
result_df.to_csv('output.csv')

# Print the number of items per column.
print(result_df.count())

For more information on outputting to different formats, please see the pandas DataFrame documentation.

Parameters

Query

Parameter	Type	Description	Example
operator	string array	Limit search to a list of well operators.	["ALLEN BROTHERS", "BP"]
state_code	string array	Limit search by a list of state codes.	["LA", "CO"]
region	string array	Limit search by a list of regions (clusters of multiple major producing basins).	["GULF", "WEST"]
sub_region	string array	Limit search by a list of subregions (clusters of several counties forming a major producing basin).	["S LA", "West - TX"]
start_date	string	Limit search to a start date. Date formatting - [“YYYY-MM-DD”]	"2022-06-01"
end_date	string	Limit search to an end date. Date formatting - [“YYYY-MM-DD”]	"2022-07-15"
aggregate_by	string array	Aggregate data by a list of parameters.	["date", "region"]

Aggregation

Aggregation provides an overview of overall productions levels for a particular operator or across a given region during a given timeframe.

Data is always implicitly aggregated by date. This means all other column data are grouped by date.

Supported parameters: operator, region, state_code, sub_region

Response

Parameter	Type	Description	Example
county	string	County in the state where the well is located.	“BEAUREGARD”
date	string	Unsynced date on which oil and gas production is observed. Date formatting - [“YYYY-MM-DD”]	“2022-06-01”
gas_daily	float	Average rate of gas production expressed per day (in BCF/day).	23.842
gas_monthly	integer	Amount of gas produced over one month (in MCF, or 1 thousand cubic feet).	980
oil_daily	float	The amount of oil produced in a single day (in BBLS, or barrels).	112.9570761
oil_monthly	integer	The amount of oil produced over one month (in BBLS, or barrels).	5650
operator_name	string	Operator of the well.	“PIE OPERATING, LLC”
region	string	Aggregation of multiple major producing basins.	“GULF”
state_code	string	Abbreviation of the state.	“LA”
sub_region	string	Aggregation of several counties, typically representing a major producing basin.	“S LA”
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

Note

Unsynced data in the date column provide 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 and not just the specific date at the start of the month.

---

Responses

Normal Output

county	date	gas_monthly	oil_monthly	operator_name	region	state_ab	sub_region	water_monthly
Red River	2018-01-01	17738	80	TDX ENERGY, LLC	gulf	LA	Haynesville - LA
Catahoula	2018-01-01		358	TENSAS DELTA EXPL CO., LLC	gulf	LA	N LA
Plaquemines	2018-01-01	16108	9032	TEXACO E & P INC.	gulf	LA	S LA
Cameron	2018-01-01	2	4	TEXACO, INC.	gulf	LA	S LA
Lafourche	2018-01-01	2	32	TEXACO, INC.	gulf	LA	S LA
St. Mary	2018-01-01		0	TEXACO, INC.	gulf	LA	S LA
Terrebonne	2018-01-01	214	248	TEXACO, INC.	gulf	LA	S LA
Lafayette	2018-01-01	33343	2635	TEXAS PETROLEUM INVESTMENT COMPANY	gulf	LA	S LA

Note

Output data will return as “null” when input data is invalid or does not exist.

Aggregated Output

Aggregated by…

operatorregionstate_codesub_region

payload = {
   'aggregate_by': 'operator'
}

aggregate_by	aggregate_by_filter_value	date	gas_daily	gas_monthly	oil_daily	oil_monthly	water_daily	water_monthly
operator	8 NORTH LLC	2022-01-01	0.0	10.0	28.0	878.0	17.0	557.0
operator	Energy LLC	2022-01-01	1310.0	40640.0	6.0	215.0	8.0	254.0
operator	ABRAXAS PETROLEUM CORPORATION	2022-01-01	8919.0	276515.0	1791.0	55596.0	49.0	1553.0
operator	ACHILLES OIL, LLC	2022-01-01	10.0	310.0	56.0	1795.0	810.0	25110.0
operator	ACOMA OIL CORP	2022-01-01	13.0	428.0	1.0	38.0	12.0	390.0
operator	ADVANCE ENERGY PARTNERS, LLC	2022-01-01	40203.0	1246326.0	18094.0	560964.0	44224.0	1370972.0
operator	ADVANCED WIRELESS COMMUNICATIONS LLC	2022-01-01	3121.0	96809.0	107.0	3334.0	891.0	27639.0
operator	AEON ENERGY CORP.	2022-01-01	0.0	0.0	3.0	94.0	414.0	12850.0
operator	AETHON ENERGY OPERATING LLC	2022-01-01	1976763.0	61279918.0	1509.0	46887.0	120322.0	3730020.0
operator	Albemarle Corporation	2022-01-01	0.0	0.0	48.0	1504.0	348397.0	10800313.0

Tip

To better explore using the aggregation functionality interactively, consider using our Excel Add-in. By familiarizing yourself with the available options, you can more efficiently query and process the data for your specific needs. To learn how to use the SynMax Excel Add-in, please refer to our Excel Add-in Documentation.