/fraccrews

This endpoint provides users with frac crew location specific to a wellpad and its operating dates.

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/fraccrews

Usage

Python

frac_crews(aggregate_by=[None], county=[None], end_date=None, frac_class=None, operator=[None], region=[None], service_company=[None], start_date=None, state_code=[None], sub_region=[None])

Returns frac crew locations by wellpad and 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.frac_crews(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
aggregate_by	string array	Aggregate data by a list of parameters.	["date", "region"]
county	string array	Limit search by a list of counties.	["Beauregard", "Coleman", "Colorado"]
end_date	string	Limit search to an end date. Date formatting - [“YYYY-MM-DD”]	"2022-07-15"
frac_class	string	Limit search to either oil or gas wells based on the GOR definition from the EIA.	"gas"
operator	string array	Limit search to a list of well operators.	["ALLEN BROTHERS", "BP"]
region	string array	Limit search by a list of regions (clusters of multiple major producing basins).	["GULF", "WEST"]
service_company	string array	Limit search by a list of companies contracted by the operator to perform the frac job.	["Liberty"]
start_date	string	Limit search to a start date. Date formatting - [“YYYY-MM-DD”]	"2022-06-01"
state_code	string array	Limit search by a list of state codes.	["LA", "CO"]
sub_region	string array	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, operator, region, service_company state_code, sub_region

Response

Parameter	Type	Description	Example
county	string	County in the state where the well is located.	“BEAUREGARD”
date	string	Frac crew location date. Date formatting - [“YYYY-MM-DD”]	“2022-06-01”
frac_class	string	Classifies wells as either oil or gas wells based on the GOR definition from the EIA.	“gas”
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”
service_company	string	Company contracted by the operator to perform the frac job.	“Liberty”
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.

---

Responses

Normal Output

county	date	frac_class	lat	long	operator_name	region	service_company	state_ab	sub_region	wellpad_id
WELD	2021-10-30	oil	40.3700375	-104.427201875	BILL BARRETT CORPORATION	west	Liberty	CO	Colorado wo SJ	916
WELD	2021-10-31	oil	40.3700375	-104.427201875	BILL BARRETT CORPORATION	west	Liberty	CO	Colorado wo SJ	916
WELD	2021-11-01	oil	40.3700375	-104.427201875	BILL BARRETT CORPORATION	west	Liberty	CO	Colorado wo SJ	916
WELD	2021-11-02	oil	40.3700375	-104.427201875	BILL BARRETT CORPORATION	west	Liberty	CO	Colorado wo SJ	916
WELD	2021-11-03	oil	40.3700375	-104.427201875	BILL BARRETT CORPORATION	west	Liberty	CO	Colorado wo SJ	916
WELD	2021-11-04	oil	40.3700375	-104.427201875	BILL BARRETT CORPORATION	west	Liberty	CO	Colorado wo SJ	916
WELD	2021-11-05	oil	40.3700375	-104.427201875	BILL BARRETT CORPORATION	west	Liberty	CO	Colorado wo SJ	916
WELD	2021-11-06	oil	40.3700375	-104.427201875	BILL BARRETT CORPORATION	west	Liberty	CO	Colorado wo SJ	916
WELD	2021-11-07	oil	40.3700375	-104.427201875	BILL BARRETT CORPORATION	west	Liberty	CO	Colorado wo SJ	916
WELD	2021-11-08	oil	40.3700375	-104.427201875	BILL BARRETT CORPORATION	west	Liberty	CO	Colorado wo SJ	916

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'
}

county	date	frac_crews_count
ARAPAHOE	2022-11-01	1
COCHRAN	2022-11-01	1
ADAMS	2022-11-01	2
CAMPBELL	2022-11-01	3
INDIANA	2022-11-01	1
BLAINE	2022-11-01	3
ATASCOSA	2022-11-01	1
JACKSON	2022-11-01	1
DE SOTO	2022-11-01	5
FRIO	2022-11-01	1

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.