Synmax API client
Project description
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file synmax_api_python_client-4.16.1-py3-none-any.whl.
File metadata
- Download URL: synmax_api_python_client-4.16.1-py3-none-any.whl
- Upload date:
- Size: 88.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f6cdbe07218630c01c5b419da876a0c8c6c899b88f38663acd86965837c108f8
|
|
| MD5 |
74f200453b0a135a96e4911d32bbd45b
|
|
| BLAKE2b-256 |
6011b84459d62ea9ec79b62364d2de6511704c9ecd0703d37ee73dff4ba5dde1
|
