/stfaggregatedhistory#
Subregion aggregated histories of all shorttermforecasts.
Endpoint#
POST |
https://hyperion.api.synmax.com/v4/stfaggregatedhistory |
Request Examples#
curl -X POST "https://hyperion.api.synmax.com/v4/stfaggregatedhistory" \
-H "Content-Type: application/json" \
-H "Access-Key: $API_TOKEN" \
-d '{}'
from synmax.hyperion.v4 import HyperionApiClient
SYNMAX_ACCESS_TOKEN = "<YOUR_API_TOKEN>"
hyperion_api_client = HyperionApiClient(access_token=SYNMAX_ACCESS_TOKEN)
short_term_forecast_aggregated_history_resp = hyperion_api_client.short_term_forecast_aggregated_history({})
short_term_forecast_aggregated_history_df = short_term_forecast_aggregated_history_resp.df()
short_term_forecast_aggregated_history_df.head()
Parameters#
Query#
Parameter |
Type |
Description |
Example |
|---|---|---|---|
date_forecast_run |
string |
A date in YYYY-MM-DD format |
2021-11-24 |
date_prod_max |
string |
A date in YYYY-MM-DD format |
2021-11-24 |
date_prod_min |
string |
A date in YYYY-MM-DD format |
2021-11-24 |
sub_region_natgas |
string array |
Subregion divisions based on natural gas production profiles |
Haynesville - TX |
Response#
Parameter |
Type |
Description |
Example |
|---|---|---|---|
date_forecast_run |
string |
A date in YYYY-MM-DD format |
2021-11-24 |
date_prod |
string |
A date in YYYY-MM-DD format |
2021-11-24 |
prod_dry_gas_bcf_day |
number |
Daily dry gas production in billion cubic feet |
— |
prod_oil_mbbl_day |
number |
Daily oil production in million barrels |
— |
sub_region_natgas |
string |
Subregion divisions based on natural gas production profiles |
Haynesville - TX |
Normal Output#
date_forecast_run |
date_prod |
prod_dry_gas_bcf_day |
prod_oil_mbbl_day |
sub_region_natgas |
|---|---|---|---|---|
2021-01-15 |
2020-10-01 00:00:00 |
3.632093286 |
Haynesville - TX |
|
2021-01-15 |
2020-11-01 00:00:00 |
3.856358352 |
Haynesville - TX |
|
2021-02-15 |
2020-11-01 00:00:00 |
4.056174672 |
Haynesville - TX |
|
2021-03-15 |
2020-11-01 00:00:00 |
0.0 |
Haynesville - TX |
|
2021-01-15 |
2020-12-01 00:00:00 |
4.066950179 |
Haynesville - TX |
|
2021-02-15 |
2020-12-01 00:00:00 |
4.21624451 |
Haynesville - TX |
|
2021-03-15 |
2020-12-01 00:00:00 |
4.092956553 |
Haynesville - TX |
|
2021-01-15 |
2021-01-01 00:00:00 |
4.225460516 |
Haynesville - TX |
|
2021-02-15 |
2021-01-01 00:00:00 |
4.339776135 |
Haynesville - TX |
|
2021-03-15 |
2021-01-01 00:00:00 |
4.37764833 |
Haynesville - TX |