/gas_demand#
Fetch daily U.S. natural gas demand by sector and region
Endpoint#
POST |
https://hyperion.api.synmax.com/v4/gas_demand |
Request Examples#
curl -X POST "https://hyperion.api.synmax.com/v4/gas_demand" \
-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)
gas_demand_resp = hyperion_api_client.gas_demand()
gas_demand_df = gas_demand_resp.df()
gas_demand_df.head()
# Example of a Windows PowerShell request to the gas_demand endpoint.
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("access_key", "<YOUR_API_TOKEN>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-RestMethod 'https://hyperion.api.synmax.com/v4/gas_demand' -Method 'POST' -Headers $headers -Body $body
$response | ConvertTo-Json
Parameters#
Query#
Parameter |
Type |
Description |
Example |
|---|---|---|---|
date_max |
string |
End of demand date range (inclusive) |
— |
date_min |
string |
Start of demand date range (inclusive) |
— |
demand_type |
string array |
Demand type / category |
— |
model_scenario |
string array |
Demand model scenario; currently baseline. |
— |
region |
string array |
An array of strings |
— |
updated_at_max |
string |
Only include rows updated at or before this timestamp, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS) |
— |
updated_at_min |
string |
Only include rows updated at or after this timestamp, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS) |
— |
weather_scenario |
string array |
Weather scenario identifier; currently baseline. |
— |
Response#
Parameter |
Type |
Description |
Example |
|---|---|---|---|
date |
string |
Gas day |
— |
demand_type |
string |
Demand type / category |
Electric Power |
gas_demand_bcf_day |
number |
Daily demand or trade-flow rate in Bcf/d |
— |
model_scenario |
string |
Demand model scenario |
— |
region |
string |
CONUS or one of the five EIA gas storage regions |
South Central |
updated_at |
string |
Last update timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SS) |
— |
weather_scenario |
string |
Weather scenario identifier |
— |
Normal Output#
date |
region |
demand_type |
gas_demand_bcf_day |
updated_at |
model_scenario |
weather_scenario |
|---|---|---|---|---|---|---|
2024-02-11 |
CONUS |
Pipeline & Distribution Use |
3.88095077242307 |
2026-08-10T20:32:00.451022+00:00 |
baseline |
baseline |
2024-02-10 |
CONUS |
Pipeline & Distribution Use |
3.7369182738239948 |
2026-08-10T20:32:00.451016+00:00 |
baseline |
baseline |
2024-02-09 |
CONUS |
Pipeline & Distribution Use |
3.6826501575687036 |
2026-08-10T20:32:00.451011+00:00 |
baseline |
baseline |
2024-02-08 |
CONUS |
Pipeline & Distribution Use |
3.7671251252454296 |
2026-08-10T20:32:00.451006+00:00 |
baseline |
baseline |
2024-02-07 |
CONUS |
Pipeline & Distribution Use |
3.9736646653098093 |
2026-08-10T20:32:00.451001+00:00 |
baseline |
baseline |
2024-02-06 |
CONUS |
Pipeline & Distribution Use |
4.231621354517026 |
2026-08-10T20:32:00.450996+00:00 |
baseline |
baseline |
2024-02-05 |
CONUS |
Pipeline & Distribution Use |
4.098130266772949 |
2026-08-10T20:32:00.450991+00:00 |
baseline |
baseline |
2024-02-04 |
CONUS |
Pipeline & Distribution Use |
3.9290214896320808 |
2026-08-10T20:32:00.450986+00:00 |
baseline |
baseline |
2026-08-04 |
South Central |
Pipeline & Distribution Use |
1.8436246943111994 |
2026-08-10T20:32:00.482878+00:00 |
baseline |
baseline |
2026-08-03 |
South Central |
Pipeline & Distribution Use |
1.8246069297130771 |
2026-08-10T20:32:00.482873+00:00 |
baseline |
baseline |