Regions#
Returns a list of polygons commonly used regions in an LNG context. These polygons can be used to narrow down results on other endpoints. Example polygons are “JKTC” “North West Europe”, “Europe w/o Norway”, “Europe w. Turkey”, “North America”, “South America”, “Middle East”, “West Africa”, “South East Asia”, “South Asia”, “Asia w/o Middle East”
Endpoint#
POST |
https://leviaton.api.synmax.com/v1/regions |
Python Method Name#
from synmax.leviaton.v1 import LeviatonApiClient
leviaton_client = LeviatonApiClient(access_token=access_token)
# Method name:
leviaton_api_client.regions
Parameters#
Parameter |
Type |
Description |
Example |
|---|---|---|---|
ids |
string |
Filter by region id. |
[‘region_b7aa7495e’] |
include_polygons |
boolean |
Whether to include polygons in the response. Set to false to exclude them. |
True |
names |
string |
Filter by region name. |
[‘JKTC’] |
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]]] |
Response Details#
Parameter |
Type |
Description |
Example |
|---|---|---|---|
created_at |
string |
The UTC timestamp of when the region was created. |
2025-07-27T22:43:41.371622+00:00 |
modified_at |
string |
The UTC timestamp of the last modification to the region information in the database. |
2025-07-27T22:43:41.371622+00:00 |
name |
string |
The name of the region. |
JKTC |
region_id |
string |
The unique identifier for the region. |
region_b7aa7495e |
Normal Output#
region_id |
name |
polygon |
modified_at |
created_at |
|---|---|---|---|---|
region_b7aa7495e |
JKTC |
{‘type’: ‘MultiPolygon’, ‘coordinates’: [[[[122.610685858, 26.931359896], Ellipsis]]]} |
2025-06-12 10:32:14.55356 |
2025-06-12 10:32:14.55356 |
region_2fb3bea5a |
North West Europe |
{‘type’: ‘MultiPolygon’, ‘coordinates’: [[[[122.610685858, 26.931359896], Ellipsis]]]} |
2025-06-30 04:39:26.102387 |
2025-06-30 04:39:26.102387 |
region_fe3eeb38a |
West Africa |
{‘type’: ‘MultiPolygon’, ‘coordinates’: [[[[122.610685858, 26.931359896], Ellipsis]]]} |
2025-06-30 04:40:13.790508 |
2025-06-30 04:40:13.790508 |
region_03bed7b16 |
North America |
{‘type’: ‘MultiPolygon’, ‘coordinates’: [[[[122.610685858, 26.931359896], Ellipsis]]]} |
2025-06-30 04:40:46.710276 |
2025-06-30 04:40:46.710276 |
region_458f18aa3 |
Middle East |
{‘type’: ‘MultiPolygon’, ‘coordinates’: [[[[122.610685858, 26.931359896], Ellipsis]]]} |
2025-06-30 04:41:34.152407 |
2025-06-30 04:41:34.152407 |
region_ef81f38d1 |
South East Asia |
{‘type’: ‘MultiPolygon’, ‘coordinates’: [[[[122.610685858, 26.931359896], Ellipsis]]]} |
2025-06-30 04:43:06.068018 |
2025-06-30 04:43:06.068018 |
region_73f0a08c8 |
South Asia |
{‘type’: ‘MultiPolygon’, ‘coordinates’: [[[[122.610685858, 26.931359896], Ellipsis]]]} |
2025-06-30 04:43:31.251057 |
2025-06-30 04:43:31.251057 |
region_20d9d571b |
Europe w/o Norway |
{‘type’: ‘MultiPolygon’, ‘coordinates’: [[[[122.610685858, 26.931359896], Ellipsis]]]} |
2025-06-30 04:45:03.049506 |
2025-06-30 04:45:03.049506 |
region_9f81a0f78 |
Asia w/o Middle East |
{‘type’: ‘MultiPolygon’, ‘coordinates’: [[[[122.610685858, 26.931359896], Ellipsis]]]} |
2025-06-30 04:47:13.095186 |
2025-06-30 04:47:13.095186 |
region_8a663d138 |
South America |
{‘type’: ‘MultiPolygon’, ‘coordinates’: [[[[122.610685858, 26.931359896], Ellipsis]]]} |
2025-06-30 04:50:08.971534 |
2025-06-30 04:50:08.971534 |