/dtils#
This endpoint returns DTIL data.
Endpoint#
GET |
https://hyperion.api.synmax.com/v3/dtils |
Usage#
Python#
- fetch_dtils()#
Returns number of DTIL wells on a wellpad, the operator name, frac job date and the til_date.
This function takes no parameters.
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.
⮞ Call the function.
result_df = client.fetch_dtils()
⮞ 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.
Response#
Parameter |
Type |
Description |
Example |
---|---|---|---|
bcfd |
float |
The total expected production from the DTILd wells on the wellpad |
0.087 |
frac_end |
string |
The date the frac job ended for the DTIL wells, if NULL then the wells have not completed fracking - Date formatting - [“YYYY-MM-DD”] |
“2023-08-26” |
operator_name |
string |
Operator of the wellpad. |
“CHK” |
til_date |
string |
The date the wells were TILd, if NULL then the wells are currently DTILs - Date formatting - [“YYYY-MM-DD”] |
“2023-10-06” |
wellpad_id |
integer |
Identifier of the wellpad. |
27248 |
wells |
integer |
The number of DTIL wells on the wellpad |
2 |
Responses#
Normal Output#
bcfd |
frac_end |
operator_name |
til_date |
wellpad_id |
wells |
---|---|---|---|---|---|
0.087 |
2023-08-26 |
CHK |
2023-10-06 |
460994 |
2 |
0.087 |
2023-09-09 |
CHK |
2023-10-08 |
467548 |
1 |
0.087 |
2023-09-26 |
CHK |
2023-10-25 |
467545 |
2 |
0.087 |
2023-10-09 |
CHK |
2023-10-19 |
453569 |
2 |
0.087 |
2023-11-01 |
CHK |
2023-11-02 |
462037 |
2 |
Note
Output data will return as “null” when input data is invalid or does not exist.