Ports

Returns detailed data for one port: UUID, name, country, type, coordinates, and area classification. Identify the port by uuid or unlocode.

When a port has terminals they are included in the terminals array of the port object. Not all ports have terminals.

Credit cost: 1 credit.

get/api/v0/port

Request

Query parameters

uuidstring uuid

Port UUID. Pass this or unlocode.

unlocodestring

Port UN/LOCODE. Pass this or uuid.

Response

The requested port, including its terminals when it has any.

Example response

{
  "data": {
    "uuid": "37a8ac5b-d126-d7ce-9aca-7b8249c2efd2",
    "port_name": "ROTTERDAM",
    "country_iso": "NL",
    "country_name": "Netherlands",
    "unlocode": "NLRTM",
    "port_type": "Port",
    "lat": 51.94331,
    "lon": 4.141812,
    "area_lvl1": "UK Coast & Atlantic",
    "area_lvl2": "Rotterdam Area",
    "terminals": [
      {
        "terminal_code": "MPT",
        "terminal_name": "MARIN PORT TERMINAL",
        "company_name": "PEREZ TORRES MARITIMA S.L.",
        "lat": 42.405278,
        "lon": -8.692778,
        "url": "https://www.ptmar.com/en/puertos/puerto-marin",
        "address": "Muelle comercial s/n, 36900 Marin, Pontevedra, Spain"
      }
    ]
  },
  "meta": {
    "duration": 0.012,
    "endpoint": "/api/v0/vessel",
    "success": true,
    "next": "00e32b7a-4067-d6b2-8d73-2bdda4fe72bb"
  }
}

Changes

    • breaking

      the response's property type changed from array to object for status

    • warning

      deleted the query request parameter lat

    • warning

      deleted the query request parameter lon

    • warning

      deleted the query request parameter radius

    • info

      api operation id findTerminals removed and replaced with getPort

    • info

      added the new optional query request parameter uuid

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      endpoint added