Service Info
Description
Get the latest available position or voyage information for a particular vessel.
Endpoint URL
https://api.myshiptracking.com/vessel/v:1
Parameters
Parameter | Required | Type | Default value | Description |
---|---|---|---|---|
apikey | yes | text | Your 42-character personal API key | |
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 |
mmsi | yes (only use one option) | int | MMSI number | |
imo | int | IMO number |
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/vessel/v:1/apikey:YOUR-API-KEY/mmsi:241087000/resp:simple/format:xml
<VESSEL>
<POS MMSI="241087000" IMO="9565039" LAT="37.14613" LNG="25.31636" HEADING="138" COURSE="140.5" SPEED="24.5" ROT="0" TIMESTAMP="2018-11-29T10:39:20" SRC="TER" />
</VESSEL>
https://api.myshiptracking.com/vessel/v:1/apikey:YOUR-API-KEY/mmsi:241087000/resp:extended/format:xml
<VESSEL>
<POS MMSI="241087000" IMO="9565039" LAT="37.13583" LNG="25.32706" HEADING="138" COURSE="140" SPEED="24.8" ROT="0" TIMESTAMP="2018-11-29T10:41:18" SRC="TER" NAME="BLUE STAR DELOS" CALLSIGN="SVBF7" VTYPE="69" VTYPE_TEXT="Ro-Ro/Passenger Ship" SIZE_A="23" SIZE_B="122" SIZE_C="12" SIZE_D="12" DRAUGHT="5.9" FLAG="GR" FLAG_MID="241" GRT="18498" DWT="2775" YEAR_BUILT="2011" DESTINATION="THI-NAX-PAR-PIR" ETA="2018-11-27T21:25:00" CURRENT_PORT="" CURRENT_PORT_ID="" CURRENT_PORT_UNLOCO="" CURRENT_PORT_COUNTRY="" CURRENT_PORT_ARR="" CURRENT_PORT_ARR_LT="" LAST_PORT="PAROS" LAST_PORT_ID="21" LAST_PORT_UNLOCO="GRPAS" LAST_PORT_COUNTRY="Greece" LAST_PORT_DEP="2018-11-29T10:08:04" LAST_PORT_DEP_LT="2018-11-29T12:08:04" NEXT_PORT="NAXOS" NEXT_PORT_ID="22" NEXT_PORT_UNLOCO="GRJNX" NEXT_PORT_COUNTRY="Greece" NEXT_PORT_ETA="2018-11-29T10:48:53" NEXT_PORT_ETA_LT="2018-11-29T12:48:53" AVG_SOG="24.5" MAX_SOG="25.3" DISTANCE_COVERED="27.53" WIND_KNOTS="22" WIND_DIRECTION="NNE" HUMIDITY="72" PRESSURE="1020.2" TEMPERATURE="11.8" CLOUD_COVERAGE="13" PRECIPITATION="0" VISIBILITY="14200" />
</VESSEL>
https://api.myshiptracking.com/vessel/v:1/apikey:YOUR-API-KEY/mmsi:241087000/resp:extended/format:json
[ { "MMSI": 241087000, "IMO": 9565039, "LAT": "37.13020", "LNG": "25.33274", "HEADING": 139, "COURSE": 140.6, "SPEED": 24.8, "ROT": 0, "TIMESTAMP": "2018-11-29T10:42:20", "SRC": "TER", "NAME": "BLUE STAR DELOS", "CALLSIGN": "SVBF7", "VTYPE": 69, "VTYPE_TEXT": "Ro-Ro\/Passenger Ship", "SIZE_A": 23, "SIZE_B": 122, "SIZE_C": 12, "SIZE_D": 12, "DRAUGHT": 5.9, "FLAG": "GR", "FLAG_MID": 241, "GRT": 18498, "DWT": 2775, "YEAR_BUILT": 2011, "DESTINATION": "THI-NAX-PAR-PIR", "ETA": "2018-11-27T21:25: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": "PAROS", "LAST_PORT_ID": 21, "LAST_PORT_UNLOCO": "GRPAS", "LAST_PORT_COUNTRY": "Greece", "LAST_PORT_DEP": "2018-11-29T10:08:04", "LAST_PORT_DEP_LT": "2018-11-29T12:08:04", "NEXT_PORT": "NAXOS", "NEXT_PORT_ID": 22, "NEXT_PORT_UNLOCO": "GRJNX", "NEXT_PORT_COUNTRY": "Greece", "NEXT_PORT_ETA": "2018-11-29T10:48:53", "NEXT_PORT_ETA_LT": "2018-11-29T12:48:53", "AVG_SOG": 24.5, "MAX_SOG": 25.3, "DISTANCE_COVERED": 33.57, "WIND_KNOTS": 23, "WIND_DIRECTION": "NNE", "HUMIDITY": 72.8, "PRESSURE": 1019.8, "TEMPERATURE": 11.8, "CLOUD_COVERAGE": 15, "PRECIPITATION": 0, "VISIBILITY": 10100 } ]