/dailyfrackedfeet#
Fracked feet per day combines daily well level completions with reported well lateral length to give an estimate of the daily number of horizontal feet being fracked.
This endpoint returns data aggregated by sub-region.
Endpoint#
POST |
https://hyperion.api.synmax.com/v3/dailyfrackedfeet |
Usage#
Python#
- daily_fracked_feet(end_date=None, region=[None], start_date=None, sub_region=[None])#
Returns fracked feet per day aggregated by sub-region.
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.daily_fracked_feet(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 |
|---|---|---|---|
region |
str arr |
Limit search by a list of regions (clusters of multiple major producing basins). |
|
sub_region |
str arr |
Limit search by a list of subregions (clusters of several counties forming a major producing basin). |
|
start_date |
str [“YYYY-MM-DD”] |
Limit search to a start date. |
|
end_date |
str [“YYYY-MM-DD”] |
Limit search to an end date. |
|
Response#
Parameter |
Type |
Description |
Example |
|---|---|---|---|
date |
str [“YYYY-MM-DD”] |
Date of observation. |
“2022-06-01” |
region |
str |
Aggregation of multiple major producing basins. |
“GULF” |
sub_region |
str |
Aggregation of several counties, typically representing a major producing basin. |
“S LA” |
fracked_feet |
float |
Aggregate fracked feet estimate. |
1057.5 |
Responses#
Normal Output#
date |
fracked_feet |
region |
sub_region |
|---|---|---|---|
2020-09-30 |
1062.2916666666665 |
gulf |
Central - TX |
2020-10-01 |
1062.2916666666665 |
gulf |
Central - TX |
2020-10-02 |
1062.2916666666665 |
gulf |
Central - TX |
2020-10-03 |
1062.2916666666665 |
gulf |
Central - TX |
2020-10-04 |
1062.2916666666665 |
gulf |
Central - TX |
2020-10-05 |
1062.2916666666665 |
gulf |
Central - TX |
2020-10-08 |
490.28846153846155 |
gulf |
Central - TX |
2020-10-09 |
490.28846153846155 |
gulf |
Central - TX |
2020-10-10 |
490.28846153846155 |
gulf |
Central - TX |
2020-10-11 |
490.28846153846155 |
gulf |
Central - TX |
Note
Output data will return as “null” when input data is invalid or does not exist.