Volume_flows#
Returns LNG volumes transferred to specified terminals or countries over a given time period. The volume_flows endpoint calculates the LNG volume transferred to a set of destination terminals/countries (and optionally from a set of origin terminals/countries) for a given time range. For historical time periods this is simply the observed number of transactions that occurred at the destinations. For future time periods, forecasted volumes are calculated. Forecasted volumes are calculated using the route_score_weighted_volume field from the transactions/forecast endpoint. The route_score_weighted_volume is the volume of a potential transaction multiplied by the likelihood of that transaction occurring. Forecast volumes are the sum of the route_score_weighted_volume for the destinations in the given time period. Note that this means partial transactions are included in the forecast volume. Uncertainties in the forecast volume are estimated using our uncertainty in the forecast transaction timestamp.
Historical data:
Shows actual observed transaction volumes.
Forecasted data:
Predicts future volumes based on:
Potential vessel arrivals and their cargo volumes
Probability of each arrival occurring
Arrival time uncertainties
Endpoint#
POST |
https://leviaton.api.synmax.com/v1/volume_flows |
Python Method Name#
from synmax.leviaton.v1 import LeviatonApiClient
leviaton_client = LeviatonApiClient(access_token=access_token)
# Method name:
leviaton_api_client.volume_flows
Parameters#
Parameter |
Type |
Description |
Example |
|---|---|---|---|
destination_countries |
string |
A list of destination ISO 3166 country names to filter by. |
[‘Spain’, ‘USA’] |
destination_country_codes |
string |
A list of destination ISO 3166-1 alpha-2 country codes to filter by. |
[‘ES’, ‘US’] |
destination_polygons |
array |
A closed list of closed EPSG:4326 lon, lat coordinate pairs to filter by. |
[[[-125.0, 24.5], [-125.0, 49.5], [-66.9, 49.5], [-66.9, 24.5], [-125.0, 24.5]], [[122.9, 24.0], [122.9, 45.5], [146.0, 45.5], [146.0, 24.0], [122.9, 24.0]]] |
destination_regions |
string |
A list of destination regions to filter by. |
[‘Asia’, ‘Europe’] |
destination_terminal_ids |
string |
— |
[‘terminal_7e1c3aad4’] |
destination_terminals |
string |
A list of destination terminal names to filter by. |
[‘Sabine Pass’, ‘Mugardos R’] |
forecast_run_at |
string |
The UTC timestamp of the forecast run to filter by. |
2025-07-27T22:43:41.371622+00:00 |
from_timestamp |
string |
The start UTC timestamp to filter by. |
2025-07-27T22:43:41.371622+00:00 |
origin_countries |
string |
A list of origin ISO 3166 country names to filter by. |
[‘Malaysia’, ‘Japan’] |
origin_country_codes |
string |
A list of origin ISO 3166-1 alpha-2 country codes to filter by. |
[‘MY’, ‘JP’] |
origin_polygons |
array |
A closed list of closed EPSG:4326 lon, lat coordinate pairs to filter by. |
[[[99.6, 1.0], [99.6, 7.5], [104.5, 7.5], [104.5, 1.0], [99.6, 1.0]], [[109.0, 1.0], [109.0, 7.5], [115.0, 7.5], [115.0, 1.0], [109.0, 1.0]]] |
origin_regions |
string |
A list of origin regions to filter by. |
[‘Asia’, ‘Europe’] |
origin_terminal_ids |
string |
A list of origin terminal ids to filter by. |
[‘terminal_75375a6e8’] |
origin_terminals |
string |
A list of origin terminal names to filter by. |
[‘Chita’, ‘Sodeshi’, ‘MLNG’] |
to_timestamp |
string |
The end UTC timestamp to filter by. |
2025-07-27T22:43:41.371622+00:00 |
transaction_type |
string |
The type of transaction to filter by. |
loading |
Response Details#
Parameter |
Type |
Description |
Example |
|---|---|---|---|
count |
number |
The mean count of the volume of the forecasted flow. |
13.0 |
count_std |
number |
The standard deviation of the count of the volume of the forecasted flow. |
0.0 |
timestamp |
string |
The UTC timestamp of the forecasted flow. |
2025-07-27T22:43:41.371622+00:00 |
volume |
number |
The mean volume of the forecasted flow. |
41.011715 |
volume_std |
number |
The standard deviation of the volume of the forecasted flow. |
0.0 |
volume_unit |
string |
The unit of measurement for the forecasted volume. |
bcf |
Normal Output#
timestamp |
volume |
count |
volume_unit |
volume_std |
count_std |
|---|---|---|---|---|---|
2025-06-23T00:00:00 |
49.64853 |
14.0 |
gas_Bcf |
0.0 |
0.0 |
2025-06-24T00:00:00 |
116.45326216225493 |
42.0 |
gas_Bcf |
0.0 |
0.0 |
2025-06-25T00:00:00 |
103.48742604534633 |
40.0 |
gas_Bcf |
0.0 |
0.0 |
2025-06-26T00:00:00 |
110.1680378 |
37.0 |
gas_Bcf |
0.0 |
0.0 |
2025-06-27T00:00:00 |
145.9189474439428 |
51.0 |
gas_Bcf |
0.0 |
0.0 |
2025-06-28T00:00:00 |
97.82390806359649 |
36.0 |
gas_Bcf |
0.0 |
0.0 |
2025-06-29T00:00:00 |
92.28701518818899 |
29.0 |
gas_Bcf |
0.0 |
0.0 |
2025-06-30T00:00:00 |
141.82400311666663 |
49.0 |
gas_Bcf |
0.0 |
0.0 |
2025-07-01T00:00:00 |
118.57184902867965 |
40.0 |
gas_Bcf |
0.0 |
0.0 |
2025-07-02T00:00:00 |
131.18712750485562 |
46.0 |
gas_Bcf |
0.0 |
0.0 |