/beta/dark_oil/transactions#
Fetch enriched transaction data with vessel information from dark oil terminals
Endpoint#
POST |
https://hyperion.api.synmax.com/v4/beta/dark_oil/transactions |
Request Examples#
curl -X POST "https://hyperion.api.synmax.com/v4/beta/dark_oil/transactions" \
-H "Content-Type: application/json" \
-H "Access-Key: $API_TOKEN" \
-d '{}'
from synmax.hyperion.v4 import HyperionApiClient
SYNMAX_ACCESS_TOKEN = "<YOUR_API_TOKEN>"
hyperion_api_client = HyperionApiClient(access_token=SYNMAX_ACCESS_TOKEN)
dark_oil_transactions_resp = hyperion_api_client.dark_oil_transactions({})
dark_oil_transactions_df = dark_oil_transactions_resp.df()
dark_oil_transactions_df.head()
Parameters#
Query#
Parameter |
Type |
Description |
Example |
|---|---|---|---|
country |
string array |
— |
— |
date_max |
string |
A date in YYYY-MM-DD format |
2021-11-24 |
date_min |
string |
A date in YYYY-MM-DD format |
2021-11-24 |
terminal |
string array |
— |
— |
terminal_id |
string array |
— |
— |
Response#
Parameter |
Type |
Description |
Example |
|---|---|---|---|
country |
string |
Country where the terminal is located |
United States |
date |
string |
A date in YYYY-MM-DD format |
2021-11-24 |
terminal |
string |
Terminal name |
Port of Houston |
terminal_id |
string |
Unique identifier for the terminal |
TERMINAL_001 |
vessel_id |
string |
Unique identifier for the vessel |
1234567 |
vessel_length |
number |
Length of the vessel in meters |
250.5 |
vessel_type |
string |
Type/category of the vessel |
Oil Tanker |
volume |
number |
Volume capacity of the vessel |
125000 |
volume_unit |
string |
The unit of volume measurement |
barrels |