API Reference

portExpectedArrivals

Returns a list of vessels expected to arrive to a specified port on a specified period.

Query Schema

type Query {
   portExpectedArrivals(input: PortExpectedArrivalsInput!): PortExpectedArrivalsConnection!
}

Arguments

NameTypeDescription
inputPortExpectedArrivalsInput!Sets the location information of the port whose arrivals are queried.

Schema

input PortExpectedArrivalsInput {
  polygonId: ObjectId!
  limit: PositiveInt! = 100
  offset: NonNegativeInt! = 0
}

PortExpectedArrivalsInput Fields

NameTypeDescription
limitPositiveInt!The maximal number of records to return.
offsetNonNegativeInt!The number of returned records to skip from the beginning of the record list.
polygonIdObjectId!The unique Windward assigned ID of the port polygon.

Returns

NameDescription
PortExpectedArrivalsConnection!The vessels returned by the portExpectedArrivals query.

PortExpectedArrivalsConnection Fields

NameTypeDescription
nodes[VesselIntelligence!]!The vessel nodes returned by the portExpectedArrivals query.
totalCountNonNegativeInt!The number of vessel nodes returned.

Example Code

Sample Query

query portExpectedArrivals($input: PortExpectedArrivalsInput!) {
  portExpectedArrivals(input: $input) {
    totalCount
    nodes {
      imo
      name
      flag
      length
      class
      subClass
      reportedPort {
        ts
      }
      smugglingRisk {
       riskySince
       score
       level
      }
      complianceRisk {
       isSanctioned
       level
       riskySince
       buildingBlocks {
         count
         level
         name
         program
         recentActivityStartDate
       }
      }
    }
  }
}

Variables

{
  "input": {
    "polygonId": "5358fc78b68ca120a07db9d3",
    "limit": 100,
    "offset": 0
  }
}

Response

"data": {
    "portExpectedArrivals": {
      "totalCount": 42,
      "nodes": [
        {
          "imo": 9360972,
          "name": "ADMIRAL STAR",
          "flag": "Liberia",
          "length": 125,
          "class": "Cargo",
          "subClass": "Container Vessel",
          "reportedPort": {
            "ts": "2022-12-27T12:00:00.000Z"
          },
          "smugglingRisk": {
            "riskySince": null,
            "score": 0,
            "level": "Low"
          },
          "complianceRisk": {
            "isSanctioned": false,
            "level": "Low",
            "riskySince": null,
            "buildingBlocks": [
              {
                "count": null,
                "level": "Low",
                "name": "DARK_ACTIVITY",
                "program": null,
                "recentActivityStartDate": null
              }
                .
                .
                .
              {
                "count": null,
                "level": "Low",
                "name": "FLAG",
                "program": null,
                "recentActivityStartDate": null
              },
            ]
          }
        },
        {
          "imo": 9322322,
          "name": "ZIM SHEKOU",
          "flag": "Liberia",
          "length": 260,
          "class": "Cargo",
          "subClass": "Container Vessel",
          "reportedPort": {
            "ts": "2022-12-26T04:00:00.000Z"
          },
          "smugglingRisk": {
            "riskySince": null,
            "score": 0,
            "level": "Low"
          },
          "complianceRisk": {
            "isSanctioned": false,
            "level": "Low",
            "riskySince": null,
            "buildingBlocks": [
              {
                "count": null,
                "level": "Low",
                "name": "DARK_ACTIVITY",
                "program": null,
                "recentActivityStartDate": null
              },
                .
                .
                .
              {
                "count": null,
                "level": "Low",
                "name": "FLAG",
                "program": null,
                "recentActivityStartDate": null
              },
            ]
          }
        }
      ]
    }
  }
}