regions

This function returns region lookup data. It sends a get request to the Hyperion V4 regions endpoint.

In the Formula Builder, select Hyperion 4.0, then choose the regions function from the Enter Function dropdown. Next, click Insert to automatically add the formula to Excel.

Syntax

=SMXH4.regions()

---

Output Parameters

When executed, this function returns data to the Excel worksheet with all relevant fields and records.

The Excel output includes the following data columns:

Field	Type	Description	Example
county	string	County in the state where the well is located.	“BEAUREGARD”
region_natgas	string	Region divisions based on natural gas production profiles.	“gulf”
state_code	string	Abbreviation of the state.	“TX”
sub_region_natgas	string	Subregion divisions based on natural gas production profiles.	“West - TX”

---

Errors

Functions may return the following error messages:

Error	Description
#VALUE!	Input parameters are invalid or cannot be parsed.
#REF!	The function cannot retrieve data from the SynMaxax API due to a network or connectivity issue.
!!! EXCEPTION	Invalid input parameters. Make sure dates are enclosed in quotes. Check if the API key is valid. To know more about how to use an API key, please check the section on authentication.
#No Data	Input data is invalid or does not exist.

Note

You can also check the logs for more information on errors. You can access the logs by clicking on SynMax Commodities on the Excel ribbon and then clicking on Logs.