drygasfactors

This function returns monthly dry gas factors by natgas subregion. It sends a post request to Hyperion V4 drygasfactors endpoint.

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

Syntax

=SMXH4.drygasfactors(sub_region_natgas,date_factor_min,date_factor_max)

---

Arguments

Parameter	Description	Example
sub_region_natgas	Subregion divisions based on natural gas production profiles.	"S LA"
date_factor_min	A date in MM/DD/YYYY format	"11/24/2021"
date_factor_max	A date in MM/DD/YYYY format	"11/24/2021"

Note

Performance considerations: This function may take some time to retrieve and organize large amounts of data. For best performance, it is recommended to limit the number of input parameters and retrieve only the data needed for analysis.

Note

No Data: Output data will return “No Data” when input data is invalid or does not exist.

Examples

1. To retrieve monthly dry gas factors for a specific subregion:

=SMXH4.drygasfactors("Haynesville - TX","","")

---

Input:

Output:

2. To retrieve monthly dry gas factors within a specific date range:

=SMXH4.drygasfactors("","1/1/2022","12/31/2022")

---

Input:

Output:

3. To retrieve monthly dry gas factors for a particular subregion within a defined date range:

=SMXH4.drygasfactors("Haynesville - TX","1/1/2022","12/31/2022")

---

Input:

Output:

---

Output Parameters

Field	Type	Description	Example
sub_region_natgas	string	Subregion divisions based on natural gas production profiles.	“West - TX”
date_factor	string	The month during which this dry gas factor applies. Format MM/DD/YYYY	“11/1/2024”
dry_gas_factor	number	The dry gas factor	0.866768527

---

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.