Countries#
Returns a list of ISO 3166 country names, ISO 3166 Alpha-2 country codes, and the countries polygons including their EEZ (except United States of America -> USA). Any of these values can be used to narrow down API requests on other endpoints.
Endpoint#
POST |
https://leviaton.api.synmax.com/v1/countries |
Python Method Name#
from synmax.leviaton.v1 import LeviatonApiClient
leviaton_client = LeviatonApiClient(access_token=access_token)
# Method name:
leviaton_api_client.countries
Parameters#
Parameter |
Type |
Description |
Example |
|---|---|---|---|
ids |
string |
Filter by country id. |
[‘TWFIWRVIT’] |
names |
string |
Filter by country name. |
[‘Malaysia’, ‘Japan’] |
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]]] |
unrefcodes |
string |
Filter by port codes. |
[‘AUGLT’, ‘AUSAB’] |
Response Details#
Parameter |
Type |
Description |
Example |
|---|---|---|---|
code |
string |
The country code. |
TW |
country_id |
string |
The unique identifier for the country. |
TWFIWRVIT |
modified_at |
string |
The UTC timestamp of the last modification to the country information in the database. |
2025-07-27T22:43:41.371622+00:00 |
name |
string |
The name of the country. |
Taiwan |
polygon |
object |
The polygon coordinates of the country. |
[[[[121.0, 22.0], [121.0, 25.0], [123.0, 25.0], [123.0, 22.0], [121.0, 22.0]]]] |
Normal Output#
country_id |
code |
name |
polygon |
modified_at |
|---|---|---|---|---|
TWFIWRVIT |
TW |
Taiwan |
{‘type’: ‘MultiPolygon’, ‘coordinates’: [[[[122.610685858, 26.931359896], Ellipsis]]]} |
2025-05-22 09:20:46.394079+00 |
ADNTX1TAV |
AD |
Andorra |
{‘type’: ‘MultiPolygon’, ‘coordinates’: [[[[122.610685858, 26.931359896], Ellipsis]]]} |
2025-05-22 09:20:46.394079+00 |
CUY6YPCGP |
CU |
Cuba |
{‘type’: ‘MultiPolygon’, ‘coordinates’: [[[[122.610685858, 26.931359896], Ellipsis]]]} |
2025-05-22 09:20:46.394079+00 |
TTTFXAF6L |
TT |
Trinidad and Tobago |
{‘type’: ‘MultiPolygon’, ‘coordinates’: [[[[122.610685858, 26.931359896], Ellipsis]]]} |
2025-05-22 09:20:46.394079+00 |
TVMTXCUNB |
TV |
Tuvalu |
{‘type’: ‘MultiPolygon’, ‘coordinates’: [[[[122.610685858, 26.931359896], Ellipsis]]]} |
2025-05-22 09:20:46.394079+00 |
TZGLZQW05 |
TZ |
Tanzania, United Republic of |
{‘type’: ‘MultiPolygon’, ‘coordinates’: [[[[122.610685858, 26.931359896], Ellipsis]]]} |
2025-05-22 09:20:46.394079+00 |
UANX4GZFV |
UA |
Ukraine |
{‘type’: ‘MultiPolygon’, ‘coordinates’: [[[[122.610685858, 26.931359896], Ellipsis]]]} |
2025-05-22 09:20:46.394079+00 |
VNXFHGUPB |
VN |
Vietnam |
{‘type’: ‘MultiPolygon’, ‘coordinates’: [[[[122.610685858, 26.931359896], Ellipsis]]]} |
2025-05-22 09:20:46.394079+00 |
AE8BFOT6M |
AE |
United Arab Emirates |
{‘type’: ‘MultiPolygon’, ‘coordinates’: [[[[122.610685858, 26.931359896], Ellipsis]]]} |
2025-05-22 09:20:46.394079+00 |
AFZQPH8EA |
AF |
Afghanistan |
{‘type’: ‘MultiPolygon’, ‘coordinates’: [[[[122.610685858, 26.931359896], Ellipsis]]]} |
2025-05-22 09:20:46.394079+00 |