Menu
Home Track and Port Handling Examples Get ships within an area

Get ships within an area

To get a list of ships within a geographical area use the following API operation.

Request:

POST /ship/area

Payload:

{
  "polygon": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          1.219482421875,
          51.0033856925319
        ],
        [
          1.4144897460937498,
          50.8822431111397
        ],
        [
          1.5875244140625,
          50.951506094481545
        ],
        [
          1.373291015625,
          51.06729071974382
        ],
        [
          1.219482421875,
          51.0033856925319
        ]
      ]
    ]
  }
}

Response:

{
   "id": 123456789
}

To retrieve the result use following API operation:

GET /ship/area/123456789

Response:

{
   "records":[
      ...
      {
         "position":{
            "coordinates":[
               1.29757,
               51.0057,
               "2018-11-16T08:20:43Z",
               235.8,
               12
            ],
            "extensions":[
               "time",
               "cog",
               "sog"
            ],
            "type":"Point"
         },
         "ship":{
            "callsign":"ZCSP4",
            "cargo":"Category X",
            "country":"Cayman Islands",
            "destination":"HOUSTON",
            "draught":10.2,
            "eta":"2018-12-03T12:00:00 ",
            "heading":233,
            "imo":9102095,
            "length":176,
            "mmsi":319498000,
            "name":"STOLT CREATIVITY",
            "rot":-17,
            "tom":"A",
            "type":"Tanker",
            "width":31
         }
      },
      ...
   ]
}
Updated on 16 November, 2018