/glossary#
Returns available filter parameters and values for drop down menus.
Endpoint#
POST |
https://hyperion.api.synmax.com/v4/glossary |
Request Examples#
curl -X POST "https://hyperion.api.synmax.com/v4/glossary" \
-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)
glossary_resp = hyperion_api_client.glossary({})
glossary_df = glossary_resp.df()
glossary_df.head()
Parameters#
Query#
Parameter |
Type |
Description |
Example |
|---|---|---|---|
category |
string array |
The category of the data |
Production |
completion_class |
string array |
Oil/Gas classification based on EIA-defined gas/oil production ratios |
oil |
county |
string array |
A county |
CAMPBELL |
date_forecast_run |
string |
A date in YYYY-MM-DD format |
2021-11-24 |
filter_type |
string |
The type of filter to apply |
— |
frac_class |
string array |
Oil/Gas classification based on EIA-defined gas/oil production ratios |
oil |
operator |
string array |
A well operator |
BILL BARRETT CORPORATION |
produced_basin |
string array |
The basin that the well produces |
HAYNESVILLE BASIN |
produced_formation |
string array |
The formation that the well produces |
JAMES LIME |
region_natgas |
string array |
Region divisions based on natural gas production profiles |
west |
rig_class |
string array |
Oil/Gas classification based on EIA-defined gas/oil production ratios |
oil |
search_term |
string |
The search term to apply |
— |
service_company |
string array |
The name of the service company |
— |
source |
string array |
The source of the data |
— |
state_code |
string array |
An array of state abbreviations |
WY |
sub_region_natgas |
string array |
Subregion divisions based on natural gas production profiles |
Haynesville - TX |
target_function |
string |
The name of the target function |
— |
Response#
Parameter |
Type |
Description |
Example |
|---|---|---|---|
completion_class |
string |
— |
— |
county |
string |
A county |
CAMPBELL |
date_forecast_run |
string |
The date on which the forecast was run |
— |
frac_class |
string |
— |
— |
operator |
string |
A well operator |
BILL BARRETT CORPORATION |
produced_formation |
string |
— |
— |
region_natgas |
string |
Region divisions based on natural gas production profiles |
west |
rig_class |
string |
— |
— |
service_company |
string |
— |
— |
state_code |
string |
A state abbreviation |
WY |
sub_region_natgas |
string |
Subregion divisions based on natural gas production profiles |
Haynesville - TX |