/shorttermforecast#
Returns short-term, monthly gas production forecasts for well APIs.
Endpoint#
POST |
https://hyperion.api.synmax.com/v4/shorttermforecast |
Parameters#
Query#
Parameter |
Type |
Description |
Example |
|---|---|---|---|
aggregate_by |
string array |
Fields to aggregate over |
region_natgas |
county |
string array |
A county |
CAMPBELL |
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 |
operator |
string array |
A well operator |
BILL BARRETT CORPORATION |
region_natgas |
string array |
Region divisions based on natural gas production profiles |
west |
state_code |
string array |
Oil/Gas classification based on EIA-defined gas/oil production ratios |
WY |
sub_region_natgas |
string array |
Subregion divisions based on natural gas production profiles |
Haynesville - TX |
well_id |
string array |
Subregion divisions based on natural gas production profiles |
4900552885 |
Response#
Parameter |
Type |
Description |
Example |
|---|---|---|---|
county |
string |
A county |
CAMPBELL |
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 |
operator |
string |
A well operator |
BILL BARRETT CORPORATION |
prod_dry_gas_mcf_day |
number |
— |
— |
prod_dry_gas_mcf_month |
number |
— |
— |
prod_oil_bbl_day |
number |
— |
— |
prod_oil_bbl_month |
number |
— |
— |
region_natgas |
string |
Region divisions based on natural gas production profiles |
west |
state_code |
string |
A state abbreviation |
WY |
sub_region_natgas |
string |
Subregion divisions based on natural gas production profiles |
Haynesville - TX |
well_id |
string |
A well identifier |
4900552885 |
Aggregation#
Supported parameters: county, date_prod, operator, region_natgas, state_code, sub_region_natgas
Normal Output#
county |
date_forecast_run |
date_prod |
operator |
prod_oil_bbl_day |
prod_oil_bbl_month |
prod_dry_gas_mcf_day |
prod_dry_gas_mcf_month |
region_natgas |
state_code |
sub_region_natgas |
well_id |
|---|---|---|---|---|---|---|---|---|---|---|---|
2025-06-08 |
2022-01-01 |
0.0 |
0.0 |
435.86660299881044 |
13511.864692963123 |
ok |
3500123281 |
||||
2025-06-08 |
2022-01-01 |
12.297419394216229 |
381.2200012207031 |
168.40302316363812 |
5220.493718072782 |
ok |
3500123722 |
||||
2025-06-08 |
2022-01-01 |
0.0 |
0.0 |
8.157930539634885 |
252.89584672868145 |
ok |
3500700236 |
||||
2025-06-08 |
2022-01-01 |
0.0 |
0.0 |
15.063062706427548 |
466.954943899254 |
ok |
3500716126 |
||||
2025-06-08 |
2022-01-01 |
0.0 |
0.0 |
22.929638583932615 |
710.8187961019111 |
ok |
3500736652 |
||||
2025-06-08 |
2022-01-01 |
0.0 |
0.0 |
11.304560890636914 |
350.4413876097443 |
ok |
3501110647 |
||||
2025-06-08 |
2022-01-01 |
0.0 |
0.0 |
12.469979539156181 |
386.56936571384165 |
ok |
3501122481 |
||||
2025-06-08 |
2022-01-01 |
6.1174193351499495 |
189.63999938964844 |
285.0905937992337 |
8837.808407776245 |
ok |
3501424568 |
||||
2025-06-08 |
2022-01-01 |
0.0 |
0.0 |
615.6032656140911 |
19083.701234036824 |
ok |
3501513019 |
||||
2025-06-08 |
2022-01-01 |
0.0 |
0.0 |
3.641933276622717 |
112.89993157530422 |
ok |
3501523659 |