API Reference

vessel

Returns information on a single vessel.

Arguments

NameTypeDescription
idObjectId!The unique Windward assigned ID of the vessel to be returned.

Returns

NameDescription
[VesselIntelligence!]!The vessel-related data.

VesselIntelligence Fields

NameType Description
activitiesByType [Activity]Returns information on activities by type, timeframe, and location.

Parameters:
type: ActivityTypes!
timeRange: DateTimeRange
polygonTypes: [String!]
buildYearPositiveIntThe vessel build year.
callsignStringThe vessel transmitted call sign.
classStringThe vessel class.
complianceRiskComplianceVesselRisk!The risk of the ship not complying with sanction programs.
dailyFuelConsumptionFuelConsumptionReport!This service takes as input a date range and the IMO of a vessel (currently works for tankers only) and returns the fuel consumption computed at midnight UTC for the day that just ended.

For example, date: ‘2022-01-02T00:00:00.000Z', 'totalFuelConsumption: 3.391’, that on January 1st, the vessel consumed 3.391 tons of fuel. A single run can go as far as 1 year back.
timeRangeClosedDateTimeRangeInputThe period for which the vessel information applies.
deadweightNonNegativeIntThe vessel deadweight.
draughtFloatLatest reported draft.
flagStringThe Vessel Flag.
grosstonnagePositiveIntThe molded volume of all the enclosed spaces in the ship converted to metric tons.
historicalNames[String]The vessel's historical names.
idObjectIdThe vessel's unique Windward assigned ID.
imoPositiveIntThe vessel International Maritime Organization number.
insurerStringThe firm insuring the vessel.
lastPortCallActivityMost recent Port Call prior to the transmission.
lengthNonNegativeIntThe vessel length.
mmsiNonNegativeIntThe Vessel Maritime Mobile Service Identity number.
nameStringThe Vessel name.
pscInspections[PSCInspection!]The Port State Control inspections performed on the vessel.
reportedPortReportedPortThe vessel transmitted destination.
riskAssessmentVesselRiskAssessment!The different risks the vessel is exposed to.
smugglingRiskSmugglingVesselRisk!The smuggling risks the vessel is exposed to.
statusStringThe vessel status; the available options are:

"DEAD": The vessel was reported DEAD by an external source.

"NOT_AVAILABLE": The vessel was reported dead by an external source, but it did transmit in the past 30 days.
subClassStringThe vessel sub-class.

Example Code

Sample Query

query Vessel($input: VesselTimelineInput!, $type: ActivityTypes!) {
  vesselTimeline(input: $input) {
    nodes {
      ... on Activity {
        vessel {
          id
          name
          imo
          mmsi
          class
          length
          flag
          status
          grosstonnage
          callsign
          subClass
          draught
          insurer
          historicalNames
          
        }
      }
    }
  }
}

Variables

{
  "input": {
    "vesselIdOrImo": "5905f9f464c8bf72c1180984",
    "types": [
      {
        "type": "MEETING"
      },
      {
        "type": "STANDING"
      },
      {
        "type": "LOW_SPEED_ANCHORED"
      },
      {
        "type": "LOW_SPEED_DRIFTING"
      },
      {
        "type": "LOW_SPEED_MOORED"
      },
      {
        "type": "LOW_SPEED_FISHING"
      },
      {
        "type": "LOW_SPEED_SERVICE"
      },
      {
        "type": "LOW_SPEED_RESEARCH"
      },
      {
        "type": "LOW_SPEED_OFFSHORE_FACILITY"
      },
      {
        "type": "LOW_SPEED_OTHER"
      },
      {
        "type": "MISSING"
      },
      {
        "type": "IN_POLYGON",
        "polygonTypes": [ "Straits", "OpenSea", "CustomPolygons", "EEZ"]
      },
      {
        "type": "STG"
      },
      {
        "type": "ID_MANIPULATION"
      },
      {
        "type": "PORT_CALL"
      },
      {
        "type": "DARK_ACTIVITY"
      },
      {
        "type": "MMSI_CHANGE"
      },
      {
        "type": "DEVIATION_FROM_PATTERN_FIRST_IN_POLYGON"
      },
      {
        "type": "COURSE_DEVIATION"
      },
      {
        "type": "ACCIDENT"
      },
      {
        "type": "DESTINATION_CHANGE"
      },
      {
        "type": "ETA_CHANGE"
      },
      {
        "type": "BAD_WEATHER"
      }
    ],
    "timeRange": {
      "from": "2021-01-01T00:00:00.011Z",
      "to": "2022-01-01T00:00:00.000Z"
    },
    "includePropertyChanges": true,
    "limit": 5,
    "offset": 178
  },
}

Response

{
  "data": {
    "vesselTimeline": {
      "nodes": [
        {
          "vessel": {
            "id": "5905f9f464c8bf72c1180984",
            "name": "GANESHA",
            "imo": 8519966,
            "mmsi": 567481000,
            "class": "Tanker",
            "length": 220,
            "flag": "Thailand",
            "status": null,
            "grosstonnage": 47249,
            "callsign": "HSB4794",
            "subClass": "LPG Tanker",
            "draught": 7.3,
            "insurer": "Assuranceforeningen Skuld Norway",
            "historicalNames": [
              "SCHUMI",
              "MING ZHU \"",
              "MING ZHU",
              "ARTEMIS"
            ]
          }
        },
           .
           .
           .
        {
          "vessel": {
            "id": "5905f9f464c8bf72c1180984",
            "name": "GANESHA",
            "imo": 8519966,
            "mmsi": 567481000,
            "class": "Tanker",
            "length": 220,
            "flag": "Thailand",
            "status": null,
            "grosstonnage": 47249,
            "callsign": "HSB4794",
            "subClass": "LPG Tanker",
            "draught": 7.3,
            "insurer": "Assuranceforeningen Skuld Norway",
            "historicalNames": [
              "SCHUMI",
              "MING ZHU \"",
              "MING ZHU",
              "ARTEMIS"
            ]
          }
        }
      ]
    }
  }
}