operatorclassification#

This function returns the classification of a well operator, indicating whether the company is a public or private entity. It sends a get request to the Hyperion V4 operatorclassification endpoint.

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

Operatorclassification function selected in SynMax Formula Builder UI

Syntax#

=SMXH4.operatorclassification()

Output Parameters#

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

Example of operatorclassification output generated in Excel

The Excel output includes the following data columns:

Field

Type

Description

Example

operator

string

A well operator

“EXXON MOBIL”

public_or_private

string

Operator classification as a public or private company.

“PRIVATE”

ticker

string

If a company is public then the ticker is provided.

“XOM”


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.