v1

latestOpenAPI 3.0.32026-07-226744340.8 KB
Maritime

Ports reference

The open-data ports reference (NGA World Port Index) — ~3,800 ports with coordinates, UN/LOCODE, harbor size/type/use, max vessel draft, channel depth, and container / oil / LNG terminal facilities. Filter by country, harbor size, terminal type, name, or proximity to a point / GEM energy asset. This is reference data (no date window). Requires a plan with Maritime intelligence access (can_use_maritime) — the Corporate & Supply Chain plan and above.

When a proximity center is set (near, near_gem_id), each row carries distance_km and results sort nearest-first. Standard envelope: { success, data, pagination, applied_filters }.

get/api/v2/maritime/ports

Query parameters

searchstring

Case-insensitive match on port name, alternate name, or UN/LOCODE.

countrystring

Country filter on ports. Accepts a country name, ISO-2, or ISO-3 (e.g. Netherlands, NL, NLD) via the shared resolveCountryInput layer; an unresolvable value returns 400 INVALID_COUNTRY.

min_harbor_size'very_small' | 'small' | 'medium' | 'large'

Minimum harbor size (inclusive of larger sizes).

lng_terminalboolean

true → only ports with an LNG terminal.

oil_terminalboolean

true → only ports with an oil terminal.

nearstring

Point 'lat,lon' for a radius search; combine with radius_km (default 100). Results carry distance_km, sorted nearest-first.

near_gem_idstring

GEM energy-asset gem_id — returns ports within radius_km of that LNG terminal / platform / port (cross-source join).

radius_kmnumber

Radius in km for near / near_gem_id. Default 100; clamped 1–2000.

bboxstring

Bounding box filter: minLon,minLat,maxLon,maxLat (lon-first, e.g. -6,35,5,44).

limitinteger

Rows per page (1–500).

cursorstring

Pagination cursor (offset) from a prior response's next_cursor.

Response

A page of ports. Each row: port_id, name, alt_name, unlocode, country (ISO-3), country_name, region, water_body, lat, lon, harbor_size, harbor_type, harbor_use, max_vessel_draft_m, channel_depth_m, lng_terminal / oil_terminal / container booleans, and distance_km (only when a proximity center is set).

successboolean