dailyproduction#

This function returns the daily gas production model for the lower 48, using pipeline scrapes, state data, and short-term production forecast. It sends a post request to the Hyperion V4 dailyproduction endpoint.

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

Dailyproduction function selected in SynMax Formula Builder UI

Syntax#

=SMXH4.dailyproduction(aggregate_by,region_natgas,sub_region_natgas,date_prod_min,date_prod_max)

Arguments#

Parameter

Description

Example

aggregate_by

Specifies a parameter by which to aggregate data.

"date"

region_natgas

Region divisions based on natural gas production profiles.

"gulf"

sub_region_natgas

Subregion divisions based on natural gas production profiles.

"S LA"

date_prod_min

A date in MM/DD/YYYY format

"1/6/2023"

date_prod_max

A date in MM/DD/YYYY format

"12/31/2023"

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.

Output data will return as "null" when input data is invalid or does not exist

Examples#

  1. To retrieve daily production in a specific region_natgas:

=SMXH4.dailyproduction("","west","", "","" )

Input:

Example input for dailyproduction function region_natgas filter

Output:

Example output of dailyproduction function for region_natgas filter
  1. To retrieve daily production in a specific sub_region_natgas:

=SMXH4.dailyproduction("","","S LA", "","" )

Input:

Example input for dailyproduction function sub_region_natgas filter

Output:

Example output of dailyproduction function for sub_region_natgas filter
  1. To retrieve daily production with a specific date range and sub_region_natgas:

=SMXH4.dailyproduction("","","S LA", "6/1/2021","7/1/2022" )

Input:

Example input for dailyproduction function sub_region_natgas and date filter

Output:

Example output of dailyproduction function for sub_region_natgas and date filter

Output Parameters#

Field

Type

Description

Example

date_prod

string

A date in MM/DD/YYYY format

“11/24/2022”

prod_dry_gas_bcf_day

number

Dry gas production per day in bfc

0.43068065

region_natgas

string

Region divisions based on natural gas production profiles.

“gulf”

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.