Service Info
Description
Get the latest available position or voyage information for all the vessels in your fleet.
Endpoint URL
https://api.myshiptracking.com/fleetposition/v:1
Parameters
Parameter | Required | Type | Default value | Description |
---|---|---|---|---|
apikey | yes | text | Your 42-character personal API key | |
fleetid | yes | int | The assigned ID by MyShipTracking for the subject Fleet | |
resp | no | text | simple | simple: Response includes Basic information. extended: Response includes extra fields as discribe in the next section. |
src | no | text | ter | ter: Response is the latest available received by terrestrial ais. sat: Response is the latest available received in combination of terrestrial-ais and satellite-ais. (If the latest position was received by terrestrial receivers you will be charged as Terrestrial-AIS) |
timespan | no | int | 0 | The maximum age in minutes of the returned position. Default value "0" means the latest available position |
format | no | text | xml | Response type. Use one of the following: xml, json |
Response Fields - simple
Field | Type | Description |
---|---|---|
MMSI | int | Maritime Mobile Service Identity |
IMO | int | International Maritime Organisation number |
LAT | real | Latitude |
LNG | real | Longitude |
HEADING | real | The heading (in degrees) |
COURSE | real | The course (in degrees) |
SPEED | real | The speed (in knots) |
ROT | int | Rate of Turn |
TIMESTAMP | datetime | The date and time (in UTC) that the data was received |
SRC | text | Source of AIS data - TER: Terrestrial-AIS or SAT: Satellite-AIS |
Response Fields - extended
Including all simple response fields +
Field | Type | Description |
---|---|---|
NAME | text | Name of the vessel |
CALLSIGN | text | Callsign of the vessel |
VTYPE | int | Type of the vessel according to AIS |
VTYPE_TEXT | text | Type of the vessel in readable format |
SIZE_A | int | Length (meters) from GPS antenna to the Bow of the vessel |
SIZE_B | int | Length (meters) from GPS antenna to the Stern of the vessel (SIZE_A + SIZE_B = Vessel Total Length) |
SIZE_C | int | Length (meters) from GPS antenna to the Port of the vessel |
SIZE_D | int | Length (meters) from GPS antenna to the Starboard of the vessel (SIZE_C + SIZE_D = Vessel Total Width) |
DRAUGHT | real | Current draught (meters) of the vessel |
FLAG | text | Two digit Country Code |
FLAG_MID | int | Maritime Identification Digit |
GRT | int | Gross Tonnage - If available |
DWT | int | Deadweight - If available |
YEAR_BUILT | int | The year that the vessel was built - If available |
DESTINATION | text | The reported destination according to AIS |
ETA | datetime | The reported estimated time of arrival according to AIS (in UTC) |
CURRENT_PORT | text | The name of the port the vessel is currently in (If detected by MyShipTracking) |
CURRENT_PORT_ID | int | The assigned ID by MyShipTracking for the Current Port |
CURRENT_PORT_UNLOCO | text | The UNLOCO for the Current Port |
CURRENT_PORT_COUNTRY | text | The Country name of the Current Port |
CURRENT_PORT_ARR | datetime | The Date and Time (in UTC) that the vessel arrived at the Current Port |
CURRENT_PORT_ARR_LT | datetime | The Date and Time (in Local Time) that the vessel arrived at the Current Port |
LAST_PORT | text | The name of the last detected port the vessel has visited |
LAST_PORT_ID | int | The assigned ID by MyShipTracking of the last detected port the vessel has visited |
LAST_PORT_UNLOCO | text | The UNLOCO of the Last Port |
LAST_PORT_COUNTRY | text | The Country name of the Last Port |
LAST_PORT_DEP | datetime | The Date and Time (in UTC) that the vessel departed from the Last Port (if it was in coverage that time) |
LAST_PORT_DEP_LT | datetime | The Date and Time (in Local Time) that the vessel departed from the Last Port (if it was in coverage that time) |
NEXT_PORT | text | The name of the Next Port as detected by MyShipTracking based on the vessel's reported Destination |
NEXT_PORT_ID | id | The assigned ID by MyShipTracking of the Next Port |
NEXT_PORT_UNLOCO | text | The UNLOCO of the Next Port |
NEXT_PORT_COUNTRY | text | The Country name of the Next Port |
NEXT_PORT_ETA | datetime | The Estimated Time of Arrival (in UTC) to Next Port according to MyShipTracking calculations - If available |
NEXT_PORT_ETA_LT | datetime | The Estimated Time of Arrival (in Local Time) to Next Port according to MyShipTracking calculations - If available |
AVG_SOG | real | Average speed in knots for the current trip |
MAX_SOG | real | Maximum recorded speed in knots for the current trip |
DISTANCE_COVERED | real | Distance covered (in Nautical Miles) from the last port till now |
WIND_KNOTS | real | Wind speed in knots |
WIND_DIRECTION | text | Wind direction |
HUMIDITY | real | Humidity (%) |
PRESSURE | real | Atmospheric pressure (kPa) |
TEMPERATURE | real | Temperature in Celsius |
CLOUD_COVERAGE | real | Cloud coverage (%) |
PRECIPITATION | real | Precipitation (mm) |
VISIBILITY | int | Visibility in meters |
Usage Example
https://api.myshiptracking.com/fleetposition/v:1/apikey:YOUR-API-KEY/fleetid:0/resp:simple/format:xml/src:sat
<VESSEL>
<POS MMSI="311054300" IMO="9441594" LAT="-37.61630" LNG="172.45159" HEADING="351" COURSE="350.8" SPEED="15.1" ROT="0" TIMESTAMP="2019-02-17T09:32:15" SRC="SAT" />
<POS MMSI="311003200" IMO="9391581" LAT="4.45153" LNG="93.16732" HEADING="43" COURSE="46.9" SPEED="15" ROT="0" TIMESTAMP="2019-02-17T06:50:39" SRC="SAT" />
<POS MMSI="311408000" IMO="9237307" LAT="33.72460" LNG="131.88217" HEADING="102" COURSE="103.2" SPEED="19.8" ROT="0" TIMESTAMP="2019-02-17T03:21:41" SRC="TER" />
</VESSEL>
https://api.myshiptracking.com/fleetposition/v:1/apikey:YOUR-API-KEY/fleetid:0/resp:extended/format:xml/src:sat
<VESSEL>
<POS MMSI="311054300" IMO="9441594" LAT="-37.61215" LNG="172.45081" HEADING="350" COURSE="352" SPEED="15.2" ROT="0" TIMESTAMP="2019-02-17T09:33:15" SRC="SAT" NAME="GLOVIS CARAVEL" CALLSIGN="C6ZE7" VTYPE="70" VTYPE_TEXT="Vehicles Carrier" SIZE_A="30" SIZE_B="170" SIZE_C="2" SIZE_D="30" DRAUGHT="7.9" FLAG="BS" FLAG_MID="311" GRT="58767" DWT="20434" YEAR_BUILT="2012" DESTINATION="JAPAN" ETA="2019-03-03T08:00:00" CURRENT_PORT="" CURRENT_PORT_ID="" CURRENT_PORT_UNLOCO="" CURRENT_PORT_COUNTRY="" CURRENT_PORT_ARR="" CURRENT_PORT_ARR_LT="" LAST_PORT="NELSON" LAST_PORT_ID="4029" LAST_PORT_UNLOCO="NZNSN" LAST_PORT_COUNTRY="New Zealand" LAST_PORT_DEP="2019-02-16T18:28:43" LAST_PORT_DEP_LT="2019-02-17T07:28:43" NEXT_PORT="TOKYO" NEXT_PORT_ID="422" NEXT_PORT_UNLOCO="JPTYO" NEXT_PORT_COUNTRY="Japan" NEXT_PORT_ETA="" NEXT_PORT_ETA_LT="" WIND_KNOTS="9" WIND_DIRECTION="S" HUMIDITY="71.2" PRESSURE="1016.1" TEMPERATURE="19.7" CLOUD_COVERAGE="0" PRECIPITATION="0" VISIBILITY="24100" />
<POS MMSI="311003200" IMO="9391581" LAT="4.45153" LNG="93.16732" HEADING="43" COURSE="46.9" SPEED="15" ROT="0" TIMESTAMP="2019-02-17T06:50:39" SRC="SAT" NAME="CSCC ASIA" CALLSIGN="C6WY8" VTYPE="70" VTYPE_TEXT="Vehicles Carrier" SIZE_A="40" SIZE_B="160" SIZE_C="22" SIZE_D="10" DRAUGHT="8.2" FLAG="BS" FLAG_MID="311" GRT="57692" DWT="21037" YEAR_BUILT="2009" DESTINATION="CN ZOS" ETA="2019-02-23T00:01:00" CURRENT_PORT="" CURRENT_PORT_ID="" CURRENT_PORT_UNLOCO="" CURRENT_PORT_COUNTRY="" CURRENT_PORT_ARR="" CURRENT_PORT_ARR_LT="" LAST_PORT="NEW YORK" LAST_PORT_ID="313" LAST_PORT_UNLOCO="USNYC" LAST_PORT_COUNTRY="USA" LAST_PORT_DEP="2019-01-12T20:57:39" LAST_PORT_DEP_LT="2019-01-12T15:57:39" NEXT_PORT="ZHOUSHAN" NEXT_PORT_ID="4107" NEXT_PORT_UNLOCO="CNZOS" NEXT_PORT_COUNTRY="China" NEXT_PORT_ETA="" NEXT_PORT_ETA_LT="" WIND_KNOTS="3" WIND_DIRECTION="SW" HUMIDITY="69.2" PRESSURE="1010.4" TEMPERATURE="29.3" CLOUD_COVERAGE="100" PRECIPITATION="0" VISIBILITY="24100" />
<POS MMSI="311408000" IMO="9237307" LAT="33.72460" LNG="131.88217" HEADING="102" COURSE="103.2" SPEED="19.8" ROT="0" TIMESTAMP="2019-02-17T03:21:41" SRC="TER" NAME="GALAXY LEADER" CALLSIGN="C6S02" VTYPE="70" VTYPE_TEXT="Vehicles Carrier" SIZE_A="34" SIZE_B="155" SIZE_C="19" SIZE_D="13" DRAUGHT="7.4" FLAG="BS" FLAG_MID="311" GRT="48710" DWT="17127" YEAR_BUILT="2002" DESTINATION="JP HIJ" ETA="2019-02-17T08:30:00" CURRENT_PORT="" CURRENT_PORT_ID="" CURRENT_PORT_UNLOCO="" CURRENT_PORT_COUNTRY="" CURRENT_PORT_ARR="" CURRENT_PORT_ARR_LT="" LAST_PORT="NAGOYA" LAST_PORT_ID="4715" LAST_PORT_UNLOCO="JPNGO" LAST_PORT_COUNTRY="Japan" LAST_PORT_DEP="2019-02-08T09:19:12" LAST_PORT_DEP_LT="2019-02-08T18:19:12" NEXT_PORT="HIROSHIMA" NEXT_PORT_ID="4950" NEXT_PORT_UNLOCO="JPHIJ" NEXT_PORT_COUNTRY="Japan" NEXT_PORT_ETA="" NEXT_PORT_ETA_LT="" WIND_KNOTS="17" WIND_DIRECTION="NW" HUMIDITY="52.4" PRESSURE="1022.3" TEMPERATURE="9.5" CLOUD_COVERAGE="0" PRECIPITATION="0" VISIBILITY="24100" />
</VESSEL>
https://api.myshiptracking.com/fleetposition/v:1/apikey:YOUR-API-KEY/fleetid:0/resp:extended/format:json/src:sat
[ { "MMSI": 311054300, "IMO": 9441594, "LAT": "-37.61215", "LNG": "172.45081", "HEADING": 350, "COURSE": 352, "SPEED": 15.2, "ROT": 0, "TIMESTAMP": "2019-02-17T09:33:15", "SRC": "SAT", "NAME": "GLOVIS CARAVEL", "CALLSIGN": "C6ZE7", "VTYPE": 70, "VTYPE_TEXT": "Vehicles Carrier", "SIZE_A": 30, "SIZE_B": 170, "SIZE_C": 2, "SIZE_D": 30, "DRAUGHT": 7.9, "FLAG": "BS", "FLAG_MID": 311, "GRT": 58767, "DWT": 20434, "YEAR_BUILT": 2012, "DESTINATION": "JAPAN", "ETA": "2019-03-03T08:00:00", "CURRENT_PORT": null, "CURRENT_PORT_ID": null, "CURRENT_PORT_UNLOCO": null, "CURRENT_PORT_COUNTRY": null, "CURRENT_PORT_ARR": null, "CURRENT_PORT_ARR_LT": null, "LAST_PORT": "NELSON", "LAST_PORT_ID": 4029, "LAST_PORT_UNLOCO": "NZNSN", "LAST_PORT_COUNTRY": "New Zealand", "LAST_PORT_DEP": "2019-02-16T18:28:43", "LAST_PORT_DEP_LT": "2019-02-17T07:28:43", "NEXT_PORT": "TOKYO", "NEXT_PORT_ID": 422, "NEXT_PORT_UNLOCO": "JPTYO", "NEXT_PORT_COUNTRY": "Japan", "NEXT_PORT_ETA": null, "NEXT_PORT_ETA_LT": null, "WIND_KNOTS": 9, "WIND_DIRECTION": "S", "HUMIDITY": 71.2, "PRESSURE": 1016.1, "TEMPERATURE": 19.7, "CLOUD_COVERAGE": 0, "PRECIPITATION": 0, "VISIBILITY": 24100 }, { "MMSI": 311003200, "IMO": 9391581, "LAT": "4.45153", "LNG": "93.16732", "HEADING": 43, "COURSE": 46.9, "SPEED": 15, "ROT": 0, "TIMESTAMP": "2019-02-17T06:50:39", "SRC": "SAT", "NAME": "CSCC ASIA", "CALLSIGN": "C6WY8", "VTYPE": 70, "VTYPE_TEXT": "Vehicles Carrier", "SIZE_A": 40, "SIZE_B": 160, "SIZE_C": 22, "SIZE_D": 10, "DRAUGHT": 8.2, "FLAG": "BS", "FLAG_MID": 311, "GRT": 57692, "DWT": 21037, "YEAR_BUILT": 2009, "DESTINATION": "CN ZOS", "ETA": "2019-02-23T00:01:00", "CURRENT_PORT": null, "CURRENT_PORT_ID": null, "CURRENT_PORT_UNLOCO": null, "CURRENT_PORT_COUNTRY": null, "CURRENT_PORT_ARR": null, "CURRENT_PORT_ARR_LT": null, "LAST_PORT": "NEW YORK", "LAST_PORT_ID": 313, "LAST_PORT_UNLOCO": "USNYC", "LAST_PORT_COUNTRY": "USA", "LAST_PORT_DEP": "2019-01-12T20:57:39", "LAST_PORT_DEP_LT": "2019-01-12T15:57:39", "NEXT_PORT": "ZHOUSHAN", "NEXT_PORT_ID": 4107, "NEXT_PORT_UNLOCO": "CNZOS", "NEXT_PORT_COUNTRY": "China", "NEXT_PORT_ETA": null, "NEXT_PORT_ETA_LT": null, "WIND_KNOTS": 3, "WIND_DIRECTION": "SW", "HUMIDITY": 69.2, "PRESSURE": 1010.4, "TEMPERATURE": 29.3, "CLOUD_COVERAGE": 100, "PRECIPITATION": 0, "VISIBILITY": 24100 }, { "MMSI": 311408000, "IMO": 9237307, "LAT": "33.72460", "LNG": "131.88217", "HEADING": 102, "COURSE": 103.2, "SPEED": 19.8, "ROT": 0, "TIMESTAMP": "2019-02-17T03:21:41", "SRC": "TER", "NAME": "GALAXY LEADER", "CALLSIGN": "C6S02", "VTYPE": 70, "VTYPE_TEXT": "Vehicles Carrier", "SIZE_A": 34, "SIZE_B": 155, "SIZE_C": 19, "SIZE_D": 13, "DRAUGHT": 7.4, "FLAG": "BS", "FLAG_MID": 311, "GRT": 48710, "DWT": 17127, "YEAR_BUILT": 2002, "DESTINATION": "JP HIJ", "ETA": "2019-02-17T08:30:00", "CURRENT_PORT": null, "CURRENT_PORT_ID": null, "CURRENT_PORT_UNLOCO": null, "CURRENT_PORT_COUNTRY": null, "CURRENT_PORT_ARR": null, "CURRENT_PORT_ARR_LT": null, "LAST_PORT": "NAGOYA", "LAST_PORT_ID": 4715, "LAST_PORT_UNLOCO": "JPNGO", "LAST_PORT_COUNTRY": "Japan", "LAST_PORT_DEP": "2019-02-08T09:19:12", "LAST_PORT_DEP_LT": "2019-02-08T18:19:12", "NEXT_PORT": "HIROSHIMA", "NEXT_PORT_ID": 4950, "NEXT_PORT_UNLOCO": "JPHIJ", "NEXT_PORT_COUNTRY": "Japan", "NEXT_PORT_ETA": null, "NEXT_PORT_ETA_LT": null, "WIND_KNOTS": 17, "WIND_DIRECTION": "NW", "HUMIDITY": 52.4, "PRESSURE": 1022.3, "TEMPERATURE": 9.5, "CLOUD_COVERAGE": 0, "PRECIPITATION": 0, "VISIBILITY": 24100 } ]