Query Schema

type Query {
   SearchVesselsByIdentifier($identifier: String!, $limit: PositiveInt)
}

Arguments

Name	Type	Description
identifier	String!	Input search term
limit	Int	The number of results that will be returned. The default number is 20, the max number is 50

Returns

Name	Description
SimplifiedVessel

SimplifiedVessel Fields

Name	Type	Description
callSign	String	The vessel transmitted call sign
vesselClass	String	The vessel class.
flag	String	The vessel flag.
historicalNames	[String]	The vessel's historical names.
historicalMmsis	[[NonNegativeInt]]	The vessel's historical MMSIs
id	ObjectId	The vessel's unique Windward assigned ID.
imo	PositiveInt	The vessel International Maritime Organization number.
mmsi	NonNegativeInt	The Vessel Maritime Mobile Service Identity number.
++name	String	The Vessel name.
status	String	The vessel status: "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.
subClass	String	The vessel sub-class.
lastTransmitted	DateTimeRange	The last transmission received

Example Code

Sample Query

query SearchVesselsByIdentifier($identifier: String!, $limit: PositiveInt) {
    searchVesselsByIdentifier(identifier: $identifier, limit: $limit) {
        id
        name
    		imo
        mmsi
        flag
        lastTransmitted
        vesselClass
        vesselSubclass
        historicalNames
        historicalMmsis
        callsign
        status
    }
}

Variables

{
    "identifier": "atalantic",
    "limit": 2
}

Response


  "data": {
    "searchVesselsByIdentifier": [
      {
        "callsign": "LFKX",
        "flag": "Norway",
        "historicalMmsis": null,
        "historicalNames": [
          "ATLANTIC1"
        ],
        "id": "5dc4bfea83ff7c3741d728b8",
        "lastTransmitted": "2023-10-31T06:16:00.000Z",
        "name": "ATLANTIC",
        "mmsi": 257503000,
        "imo": 9849801,
        "status": null,
        "vesselClass": "Fishing",
        "vesselSubclass": null
      },
      {
        "callsign": "2CZE3",
        "flag": "UnitedKingdom",
        "historicalMmsis": null,
        "historicalNames": [
          "SY ATLANTIC"
        ],
        "id": "59067b8ca3ae7a110cef62e2",
        "lastTransmitted": "2023-10-31T06:38:33.000Z",
        "name": "ATLANTIC",
        "mmsi": 9563512,
        "imo": 9849801,
        "status": null,
        "vesselClass": "Pleasure",
        "vesselSubclass": null
      }
    ]
  }
}