API

API v1.2

Get Ship Info

Description:

Returns current information about vessel specified by MMSI. You will get detailed API respond if the vessel is in a list of your registered vessels on 'My Fleet' page. You get limited information for vessels that are not in a list of your account.

API call:

http://api.ais.owm.io/1.2/vessels/{MMSI}.json?api_key={API key}

Parameters of API call:

mmsi The vessel’s Maritime Mobile Service Identity (MMSI) – a unique, nine-digit identification number

appid your API key

Examples of API calls:

Vessel that is in your 'My Fleet' list http://api.ais.owm.io/1.2/vessels/355050000.json?api_key=f7a0da8eacb49740eb45b5e74d130459

Vessel that is not in your 'My Fleet' list http://api.ais.owm.io/1.2/vessels/263146000.json?api_key=f7a0da8eacb49740eb45b5e74d130459

API respond:

    
    //Vessel is from 'My Fleet'
    {"mmsi":564435000,"name":"NORDIC ANNE","callsign":"9V2538","imo":9488413,"type":80,
     "dim":{"bow":199,"stern":30,"port":177,"starboard":10,"draught":120},
     "current":
     {
        "destination":{"text":"VIZAG"},
        "dt":1435845575,
        "coord":[-68.719781666667,27.250755],
        "sog":14.4,"cog":259.9,"pos_acc":0,"nav_stat":0,"hdg":260}
     }
    //Vessel is not from 'My Fleet'
    {"mmsi":373393000,"imo":9615119,"type":70,
    "current":
    {
        "dt":1436666488,
        "coord":[-70.364296666667,37.881821666667]}
    }

Parameters of API respond:

  • mmsi The vessel’s Maritime Mobile Service Identity (MMSI) – a unique, nine-digit identification number
  • name 20 characters to represent the name of the vessel
  • callsign International radio call sign, up to seven characters, assigned to the vessel by its country of registry
  • imo International Maritime Organization’s (IMO) ship identification number – a seven digit number that remains unchanged upon transfer of the ship’s registration to another country
  • type See Type of ship and cargo type
  • dim Reference point for reported position. Also indicates the dimension of ship (m). See Overall dimension / reference for position.
    • bow Distance from reference point/GPS antenna to bow (A)
    • stern Distance from reference point/GPS antenna to stern (B)
    • port Distance from reference point/GPS antenna to port side (C)
    • starboard Distance from reference point/GPS antenna to starboard side (D)
    • draught Draught of ship, from 0.1 meter to 25.5 meters, in 1/10 m, 255 = draught 25.5 m or greater, 0 = not available = default; in accordance with IMO Resolution A.851
  • current Group of current parameters
    • destination Port of destination
      • text Name of the port
    • dt Time of data recieving, unix, UTC
    • coord Coordinates, latitude and longitude
    • sog Speed over ground, 0 to 102 knots with 0.1 knot resolution
    • cog Course over ground, relative to true north to 0.1 degree
    • pos_acc The position accuracy (PA) flag should be determined in accordance with the table below: 1 = high (<= 10 m), 0 = low (> 10 m), 0 = default
    • nav_stat See Navigation status
    • hdg True heading, 0 to 359 degrees from gyro compass

My Fleet

Description:

Returns current information about vessels from the list of your registered vessels on 'My Fleet' page.

API call:

http://api.ais.owm.io/1.2/fleet.json?api_key={API key}

Parameters of API call:

appid your API key

Examples of API calls:

http://api.ais.owm.io/1.2/fleet.json?api_key=f7a0da8eacb49740eb45b5e74d130459

API respond:

[
    {"mmsi":564435000,
    "current":
        {"destination":{"text":"VIZAG"},
        "dt":1435845575,
        "coord":[-68.719781666667,27.250755],
        "sog":14.4,"cog":259.9,"pos_acc":0,"nav_stat":0,"hdg":260}},

    {"mmsi":355050000,
    "current":
        {"destination":{"text":"CHARLESTON"},
        "dt":1436358930,
        "coord":[-12.145683333333,49.593166666667],
        "sog":14,"cog":90,"pos_acc":0,"nav_stat":0,"hdg":96}}

...
]

Parameters of API respond:

  • mmsi The vessel’s Maritime Mobile Service Identity (MMSI) – a unique, nine-digit identification number
  • current Group of current parameters
    • destination Port of destination
      • text Name of the port
    • dt Time of data recieving, unix, UTC
    • coord Coordinates, latitude and longitude
    • sog Speed over ground, 0 to 102 knots with 0.1 knot resolution
    • cog Course over ground, relative to true north to 0.1 degree
    • pos_acc The position accuracy (PA) flag should be determined in accordance with the table below: 1 = high (<= 10 m), 0 = low (> 10 m), 0 = default
    • nav_stat See Navigation status
    • hdg True heading, 0 to 359 degrees from gyro compass

Ship Track

Description:

API call:

http://api.ais.owm.io/1.2/track/{MMSI}?api_key={API key}

Parameters of API call:

mmsi The vessel’s Maritime Mobile Service Identity (MMSI) – a unique, nine-digit identification number

appid your API key

filtered 'filtered'='1' is default parameter when points are chosen with 15 min interval, filter is turned off when 'filtered'='0'

Examples of API calls:

http://api.ais.owm.io/1.2/track/355050000.json?api_key=f7a0da8eacb49740eb45b5e74d130459

API respond:

    {"mmsi":367170000,
    "cnt":731,
    "list":
    [
    {"dt":1436701290,"coord":[171.35401333333,7.1094933333333],"sog":0,"cog":360,"pos_acc":1,"type":1},
    {"dt":1436701209,"coord":[171.35397333333,7.1094383333333],"sog":0.2,"cog":35,"pos_acc":1,"type":1},
    {"dt":1436695820,"coord":[171.35404,7.1094666666667],"sog":0.1,"cog":360,"pos_acc":1,"type":1}
    ...
    
    ]}

Parameters of API respond:

  • mmsi The vessel’s Maritime Mobile Service Identity (MMSI) – a unique, nine-digit identification number
  • cnt Number of points in API respond (lines)
  • list Group of parameters
    • dt Time of data recieving, unix, UTC
    • coord Coordinates, latitude and longitude
    • sog Speed over ground, 0 to 102 knots with 0.1 knot resolution
    • cog Course over ground, relative to true north to 0.1 degree
    • pos_acc The position accuracy (PA) flag should be determined in accordance with the table below: 1 = high (<= 10 m), 0 = low (> 10 m), 0 = default
    • hdg True heading, 0 to 359 degrees from gyro compass

Polygon

Description:

Returns current information about vessels for any polygon that may have very complicated shape accurately replicating the outline of any port or harbour and extracting unnecessary zones inside.

API call:

for rectangle zone http://api.ais.owm.io/1.2/vessels.json?bbox={47,44,51,46}&api_key={API key}

Parameters of API call:

bbox bbox bounding box [lon-left,lat-bottom,lon-right,lat-top]

appid your API key

API respond:

{"count":22,"list":
[
    {"name":"IBEEV01","mmsi":436000101,"type":90,"last_position":
    {"time":1453909283,"coord":[44.557621,50.25364],"type":1,"status":0,"cog":313.2,"hdg":127,"sog":0}}
    
    {"name":"SVETLYY","mmsi":273312050,"type":90,"last_position":
    {"time":1453909300,"coord":[45.014383,48.4729],"type":1,"status":0,"cog":87.4,"hdg":288,"sog":0}}
    
...
]}

Parameters of API respond:

  • countnumber of lines/MMSI returned
  • list
    • name Name of the vessel
    • mmsi The vessel’s Maritime Mobile Service Identity (MMSI) – a unique, nine-digit identification number
    • type See Type of ship and cargo type
    • last_position Group of very recient parameters
      • time Time of data recieving, unix, UTC
      • coord Coordinates, latitude and longitude
      • status See Navigation status
      • cog Course over ground, relative to true north to 0.1 degree
      • hdg True heading, 0 to 359 degrees from gyro compass
      • sog Speed over ground, 0 to 102 knots with 0.1 knot resolution

Add vessel to fleet

Description:

API call:

http://api.ais.owm.io/1.2/fleet/add.json?api_key={API key}&mmsi={MMSI}

Parameters of API call:

mmsi The vessel’s Maritime Mobile Service Identity (MMSI) – a unique, nine-digit identification number

appid your API key


Remove vessel from fleet

Description:

API call:

http://api.ais.owm.io/1.2/fleet/remove.json?api_key={API key}&mmsi={MMSI}

Parameters of API call:

mmsi The vessel’s Maritime Mobile Service Identity (MMSI) – a unique, nine-digit identification number

appid your API key