/filterregions#
Returns region reference data.
Endpoint#
POST |
https://hyperion.api.synmax.com/v4/filterregions |
Request Examples#
curl -X POST "https://hyperion.api.synmax.com/v4/filterregions" \
-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)
filter_regions_resp = hyperion_api_client.filter_regions({})
filter_regions_df = filter_regions_resp.df()
filter_regions_df.head()
Parameters#
Query#
Parameter |
Type |
Description |
Example |
|---|---|---|---|
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 |
Response#
Parameter |
Type |
Description |
Example |
|---|---|---|---|
county |
string |
A county |
CAMPBELL |
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 |