/longtermforecast#
This endpoint returns long-term production forecasts use public producer guidance with an adjustment for private producer activity of the lower 48 and its subregions for the next 12 months.
Endpoint#
POST |
https://hyperion.api.synmax.com/v3/longtermforecast |
Usage#
Python#
- long_term_forecast(end_date=None, region=[None], start_date=None, sub_region=[None])#
Returns a long term production forecast for the next 12 months for the lower 48. The forecast is provided at a monthly granularity.
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.long_term_forecast(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 |
|---|---|---|---|
end_date |
str [“YYYY-MM-DD”] |
Limit search to an end date. |
|
region |
str arr |
Limit search by a list of regions (clusters of multiple major producing basins). |
|
start_date |
str [“YYYY-MM-DD”] |
Limit search to a start date. |
|
sub_region |
str arr |
Limit search by a list of subregions (clusters of several counties forming a major producing basin). |
|
Response#
Parameter |
Type |
Description |
Example |
|---|---|---|---|
date |
str [“YYYY-MM-DD”] |
Forecasted month (unsynced). |
“2022-11-01” |
gas_daily |
float |
Average rate of gas production expressed per day (in BCF/day). |
23.842 |
oil_daily |
float |
The amount of oil produced in a single day (in BBLS, or barrels). |
112.9570761 |
region |
str |
Aggregation of multiple major producing basins. |
“GULF” |
state_ab |
str |
Abbreviation of the state. |
“LA” |
Responses#
Normal Output#
date |
gas_daily |
oil_daily |
region |
sub_region |
|---|---|---|---|---|
2022-12-01 |
0.269483871 |
southeast |
AL |
|
2023-01-01 |
0.269483871 |
southeast |
AL |
|
2023-02-01 |
0.269483871 |
southeast |
AL |
|
2023-03-01 |
0.2 |
southeast |
AL |
|
2023-04-01 |
0.2932 |
10.0 |
southeast |
AL |
2023-05-01 |
0.14287821 |
10.0 |
southeast |
AL |
2023-06-01 |
0.288166667 |
10.0 |
southeast |
AL |
2023-07-01 |
0.289258065 |
10.0 |
southeast |
AL |
2023-08-01 |
0.279419355 |
10.0 |
southeast |
AL |
2023-09-01 |
0.4 |
10.0 |
southeast |
AL |
Note
Output data will return as “null” when input data is invalid or does not exist.