SynMax API Python Client

The official Python SDK for SynMax APIs—providing unified access to Hyperion, Vulcan, and Leviaton data products.

Introduction

The energy and infrastructure industries rely on timely, accurate data for critical decision-making. The SynMax API Python Client solves the challenge of fragmented data access by providing a single SDK to interact with three powerful data platforms:

Hyperion: Near real-time U.S. oil & gas drilling, completion, production data as well as forecasts
Vulcan: Power and infrastructure monitoring with satellite-derived construction status intelligence for power plants, data centers, and LNG facilities
Leviaton: Global LNG vessel tracking, cargo flows, and transaction data with forecasting capabilities

Installation

Install the SDK via pip:

pip install --upgrade synmax-api-python-client

Requirements:

Python 3.10 or higher
pip (Python package installer)

Authentication

All SynMax APIs authenticate requests using an API access token tied to your subscription.

To obtain an access token, contact: support@synmax.com

Pass your token directly when initializing any client:

access_token = "your_access_token_here"

Quick Start

Hyperion (Oil & Gas Data)

import datetime
from synmax.hyperion.v4 import HyperionApiClient

client = HyperionApiClient(access_token="your_access_token_here")

# Fetch short-term production forecast
data = client.short_term_forecast(
    aggregate_by=["date_prod", "sub_region_natgas"],
    date_prod_min=datetime.date(2025, 5, 1),
    date_prod_max=datetime.date(2025, 6, 30),
)

df = data.df()  # Returns pandas DataFrame
print(df.head())

Vulcan (Power & Infrastructure)

from synmax.vulcan.v2 import VulcanApiClient

client = VulcanApiClient(access_token="your_access_token_here")

# Fetch datacenter project data
datacenters = client.datacenters()

df = datacenters.df()  # Returns pandas DataFrame
print(df.head())

Leviaton (LNG Vessel Tracking)

from synmax.leviaton.v1 import LeviatonApiClient

client = LeviatonApiClient(access_token="your_access_token_here")

# Fetch LNG transactions from US to Europe
transactions = client.transactions(
    origin_country_codes=["US"],
    destination_country_codes=["DE", "FR", "UK", "NL", "BE"],
    from_timestamp="2025-06-01T00:00:00Z",
    to_timestamp="2025-06-23T23:59:59Z",
)

df = transactions.df()  # Returns pandas DataFrame
print(df.head())

Usage Patterns

Fetch Data as DataFrame

Best for datasets that fit in memory:

df = client.some_endpoint(**params).df()

Stream Large Datasets to File

For large datasets, iterate through chunks:

import json

data_generator = client.some_endpoint(**params)

with open("output.json", "w") as f:
    f.write("[\n")
    first = True
    for record in data_generator:
        if not first:
            f.write(",\n")
        json.dump(record, f, indent=2, default=str)
        first = False
    f.write("\n]")

Features

Unified SDK: Single package for Hyperion, Vulcan, and Leviaton APIs
Pandas Integration: Native .df() method returns data as DataFrames
Generator Support: Memory-efficient streaming for large datasets
Type Hints: Full autocomplete support in modern IDEs

Documentation & Support

Product	Documentation
Hyperion	apidocs.synmax.com
Vulcan	docs.vulcan.synmax.com
Leviaton	leviaton.apidocs.synmax.com

Support: support@synmax.com

License

This SDK is proprietary software. See synmax.com for licensing details.

Metadata

Release files for synmax-api-python-client 4.18.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for synmax-api-python-client 4.18.2
File	Interpreter	ABI	Platform	Reset
synmax_api_python_client-4.18.2-py3-none-any.whl 103.4 kB Aug 10, 2026	Python 3	none	any	Details

Release files / synmax_api_python_client-4.18.2-py3-none-any.whl

Download URL	synmax_api_python_client-4.18.2-py3-none-any.whl
Size	103.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`b2d42e0df5651d9a85599cf1874ec3c8d5e9ad3245d78799453ac537f47036d5`
BLAKE2b-256 checksum How to use checksums	`2415d6f8e2c57c4feaf63ee0e3137a1f850d15ed72201d9811a59007575119ac`
Upload date	Aug 10, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.11.6`