API Reference

Vessel Endpoints

Get Vessel Information

GET /vessels/{imo}

Retrieve detailed information about a specific vessel by IMO number.

Parameters

Name	Type	Description
imo	string	The IMO number of the vessel

Response

{
  "imo": "9876543",
  "name": "OCEAN VOYAGER",
  "type": "Container Ship",
  "length": 366,
  "beam": 48.2,
  "status": "underway",
  "flag": "Panama",
  "yearBuilt": 2015,
  "grossTonnage": 150000
}

Get Vessel Position

GET /vessels/{imo}/position

Get the current position of a vessel.

Response

{
  "imo": "9876543",
  "latitude": 51.8739,
  "longitude": 4.2866,
  "speed": 14.5,
  "course": 180,
  "timestamp": "2024-01-20T15:30:00Z",
  "destination": "Rotterdam",
  "eta": "2024-01-21T08:00:00Z"
}

Get Vessel Route

GET /vessels/{imo}/route

Get the planned route of a vessel.

Response

{
  "imo": "9876543",
  "route": [
    {
      "port": "Singapore",
      "arrival": "2024-01-15T10:00:00Z",
      "departure": "2024-01-16T18:00:00Z"
    },
    {
      "port": "Rotterdam",
      "arrival": "2024-01-21T08:00:00Z",
      "departure": "2024-01-22T16:00:00Z"
    }
  ]
}

WebSocket Connection

WSS /vessels/live

Connect to receive real-time vessel updates.

Message Format

{
  "type": "position_update",
  "data": {
    "imo": "9876543",
    "latitude": 51.8739,
    "longitude": 4.2866,
    "speed": 14.5,
    "timestamp": "2024-01-20T15:30:00Z"
  }
}