/completions

Completion is the process in which a well is enabled to produce oil or gas.

By default, this endpoint returns data aggregated by API.

The start_date and end_date refer to the point in time when the completion process started and ended, respectively.

Endpoint

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

Usage

Python

well_completion(aggregate_by=[None], completion_class=None, county=[None], end_date=None, operator=[None], region=[None], start_date=None, state_code=[None], sub_region=[None])

Returns well completions in a specific county, region, subregion or state from a start date to an end date.

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.well_completion(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
completion_class	str	Limit search to either oil or gas wells based on the GOR definition from the EIA.	"gas"
county	str arr	Limit search by a list of counties.	["Beauregard", "Coleman", "Colorado"]
end_date	str [“YYYY-MM-DD”]	Limit search to an end date.	"2022-07-15"
operator	str arr	Limit search to a list of well operators.	["ALLEN BROTHERS", "BP"]
region	str arr	Limit search by a list of regions (clusters of multiple major producing basins).	["GULF", "WEST"]
start_date	str [“YYYY-MM-DD”]	Limit search to a start date.	"2022-06-01"
state_code	str arr	Limit search by a list of state codes.	["LA", "CO"]
sub_region	str arr	Limit search by a list of subregions (clusters of several counties forming a major producing basin).	["S LA", "West - TX"]

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: county, date, end_date, operator, region, state_code, sub_region

Response

Parameter	Type	Description	Example
api	int	An API is a unique, permanent, numeric identifier assigned to each well drilled.	1701121257
completion_class	str	Classifies wells as either oil or gas wells based on the GOR definition from the EIA.	“gas”
county	str	County in the state where the well is located.	“BEAUREGARD”
end_date	str [“YYYY-MM-DD”]	End date of fracking.	“2022-06-01”
operator_name	str	Operator of the well.	“PIE OPERATING, LLC”
region	str	Aggregation of multiple major producing basins.	“GULF”
start_date	str [“YYYY-MM-DD”]	Start date of fracking.	“2020-06-27”
state_ab	str	Abbreviation of the state.	“LA”
sub_region	str	Aggregation of several counties, typically representing a major producing basin.	“S LA”
wellpad_id	int	Identifier of the wellpad.	27248

---

Responses

Normal Output

api	completion_class	county	end_date	operator_name	region	start_date	state_ab	sub_region	wellpad_id
500109848	oil	ADAMS	2021-06-19	GREAT WESTERN OPERATING COMPANY LLC	west	2021-05-25	CO	Colorado wo SJ	335150
500109870	oil	ADAMS	2023-01-03	PDC ENERGY	west	2022-11-22	CO	Colorado wo SJ	228506
500109871	oil	ADAMS	2023-01-03	PDC ENERGY	west	2022-11-22	CO	Colorado wo SJ	228506
500109872	oil	ADAMS	2023-01-03	PDC ENERGY	west	2022-11-22	CO	Colorado wo SJ	228506
500109873	oil	ADAMS	2021-03-12	PDC ENERGY	west	2021-02-04	CO	Colorado wo SJ	228506
500109874	oil	ADAMS	2023-01-03	PDC ENERGY	west	2022-11-22	CO	Colorado wo SJ	228506
500109875	oil	ADAMS	2023-01-03	PDC ENERGY	west	2022-11-22	CO	Colorado wo SJ	228506
500109877	oil	ADAMS	2021-03-12	PDC ENERGY	west	2021-02-04	CO	Colorado wo SJ	228506
500109879	oil	ADAMS	2023-01-03	PDC ENERGY	west	2022-11-22	CO	Colorado wo SJ	228506
500109880	oil	ADAMS	2021-03-12	PDC ENERGY	west	2021-02-04	CO	Colorado wo SJ	228506

Note

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

Aggregated Output

Aggregated by…

countydateoperatorregionstate_codesub_region

payload = {
   'aggregate_by': 'county'
}

completions_count	county	end_date
1	CAMPBELL	1/3/2021
1	EDDY	1/6/2021
1	MITCHELL	1/6/2021
4	MIDLAND	1/7/2021
2	REEVES	1/7/2021
1	WILLIAMS	1/7/2021
2	CONVERSE	1/10/2021
1	EDDY	1/11/2021
3	MARTIN	1/11/2021

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.