Fleets

Modify Fleet

Manage your MarineTraffic fleet.

To create a new item in a fleet, use the active parameter. If the item already exists, it will update item's status.

The active parameter can have values of 0, 1, 2 which corresponds to the three states of the fleet items (inactive, active, sat enabled)

The delete parameter must have a value of 1 and it removes the entry from the fleet.

If MMSI, IMO and SHIP ID are passed, the MMSI takes precedence and the IMO and SHIP ID will be ignored.

If more than one vessels are found with the same parameter (MMSI, IMO, SHIP ID) then an error message is return with all the available vessels.

Response is always an XML structure indicating success or failure with failure description message.

Notes

The frequency of allowed API calls is specific to your API key and is detailed in your contract as a number of successful calls per time period. For example “2 calls per minute”.
Regardless of this agreed limit, each API key is technically restricted to a maximum of 100 total (including successful and unsuccessful) requests per minute to ensure system stability.

path Parameters

api_key

required

string

API key: 40-character hexadecimal number

query Parameters

mmsi required	integer The Maritime Mobile Service Identity (MMSI) of the vessel you wish to handle, comma separated values supported You can instead use imo or shipid
imo	integer The International Maritime Organization (IMO) number of the vessel you wish to handle, comma separated values supported
shipid	integer A uniquely assigned ID by MarineTraffic for the subject vessel, comma separated values supported
fleet_id	integer If used, vessel will be added to the specific fleet, otherwise default fleet is used
active	integer Possible values are: 0 to set to inactive 1 to activate 2 to enable satellite coverage
delete	integer Set this parameter to 1 to delete a vessel from your fleet

Responses

Response samples

200
400
404
429

Content type

application/xml

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<RESPONSE>
    <STATUS>
        <SUCCESS CODE="7" DESCRIPTION="FLEET ITEM UPDATED" />
    </STATUS>
</RESPONSE>

Vessels in Fleet

Get a detailed listing of vessels included in one of your MarineTraffic fleets.

Notes

The frequency of allowed API calls is specific to your API key and is detailed in your contract as a number of successful calls per time period. For example “2 calls per minute”.
Regardless of this agreed limit, each API key is technically restricted to a maximum of 100 total (including successful and unsuccessful) requests per minute to ensure system stability.

path Parameters

api_key

required

string

API key: 40-character hexadecimal number

query Parameters

v required	integer Default: 1 Version of the service to be executed. Use version 2 to get the latest
fleet_id	integer If used, will return specific fleet otherwise default fleet is used
protocol	string Default: "xml" Response type. Use one of the following: xml csv json jsono

Responses

Response samples

200
400
403
429

Content type

[{"SHIP_ID": "319",
"MMSI": "228316700",
"IMO": "9387542",
"SHIPNAME": "KAOMBO NORTE",
"ACTIVE": "1"
},
{"SHIP_ID": "326",
"MMSI": "256609000",
"IMO": "9409156",
"SHIPNAME": "LAPEROUSE",
"ACTIVE": "1"
},
{"SHIP_ID": "487",
"MMSI": "228333700",
"IMO": "9320075",
"SHIPNAME": "GASELYS",
"ACTIVE": "1"
},
{"SHIP_ID": "510",
"MMSI": "228337700",
"IMO": "9306495",
"SHIPNAME": "PROVALYS",
"ACTIVE": "1"
},
{"SHIP_ID": "1595",
"MMSI": "229036000",
"IMO": "9529475",
"SHIPNAME": "PETALIDI",
"ACTIVE": "1"
}
]

List Fleets

Get an overview list of all your MarineTraffic fleets.

Notes

The frequency of allowed API calls is specific to your API key and is detailed in your contract as a number of successful calls per time period. For example “2 calls per minute”.
Regardless of this agreed limit, each API key is technically restricted to a maximum of 100 total (including successful and unsuccessful) requests per minute to ensure system stability.

path Parameters

api_key

required

string

API key: 40-character hexadecimal number

query Parameters

protocol

string

Default: "xml"

Response type. Use one of the following:

xml
csv
json
jsono

Responses

Response samples

200
429

Content type

[{"ID": "1696822",
"NAME": "Demo fleet",
"ACTIVE": "1",
"CREATED": "2020-09-22T06:51:00.000Z",
"DEFAULT": "1"
}
]

Clear Fleet

Clear your MarineTraffic fleet from all vessels.

Notes

The frequency of allowed API calls is specific to your API key and is detailed in your contract as a number of successful calls per time period. For example “2 calls per minute”.
Regardless of this agreed limit, each API key is technically restricted to a maximum of 100 total (including successful and unsuccessful) requests per minute to ensure system stability.

path Parameters

api_key

required

string

API key: 40-character hexadecimal number

query Parameters

fleet_id

required

integer

The fleet id you wish to clear

Responses

Response samples

200
404
429

Content type

[{"FLEET_ID": "1716163",
"DELETE": "1"
}
]