/operatorclassification

This endpoint returns operators classified as either public or private companies.

Warning

A throttling mechanism with a rate limit of 300 requests per minute has been implemented for this endpoint. This is temporary and may be adjusted in the future.

Endpoint

GET	https://hyperion.api.synmax.com/v3/operatorclassification

Usage

Python

fetch_operator_classification()

Returns operators classified as either public or private companies.

This function takes no parameters.

Object returned is a pandas DataFrame.

⮞ Setup the client.

from synmax.hyperion import HyperionApiClient, ApiPayload
access_token = 'your access token goes here'
client = HyperionApiClient(access_token=access_token)

For a more detailed guide on setting up the Hyperion client, please see the Quickstart page.

⮞ Call the function.

result_df = client.fetch_operator_classification()

⮞ Print the results or save them for later.

# Print the entire response as a string.
print(result_df.to_string())

# Create a CSV file from the output.
result_df.to_csv('output.csv')

# Print the number of items per column.
print(result_df.count())

For more information on outputting to different formats, please see the pandas DataFrame documentation.

Response

Parameter	Type	Description	Example
operator_name	string	Operator of the well.	“PIE OPERATING, LLC”
public_or_private	string	Operator classification as a public or private company. Date formatting - [“YYYY-MM-DD”]	“PRIVATE”
ticker	string	If a company is public then the ticker is provided.	“XOM”

---

Responses

Normal Output

operator_name	public_or_private	ticker
1859 OPERATING LLC	PRIVATE
3-T EXPLORATION INC	PRIVATE
3:16 DISPOSAL SYSTEMS SERIES LLC	PRIVATE
3FEARNS LLC	PRIVATE
4020 SWD, LLC	PRIVATE
A WILLIAMS OIL	PRIVATE
A2R RESOURCES LLC	PRIVATE
ABACO OPERATING, LLC	PRIVATE
ABB OIL COMPANY INC	PRIVATE
ABLEREADY, INC.	PRIVATE

Note

Output data will return as “null” when input data is invalid or does not exist.