Getting Started

API call on a rolling 30 Day Basis

Your number of API calls at FleetMon is based on a sliding window of 30 days. There is no fixed day for resetting limits. Every counted request will be reset after exactly 30 days, so if you do not exceed the number from now back to 30 days you will not experience the outage issue. The sliding window is 30 (days) * 24 (h) * 60 (min) * 60 (sec) seconds (=2.592.000 sec) instead of 30 days.

Note: The actual usage and the remaining number of API calls can also be displayed.

Make an API Call

You can use your API Key to make your first call to the REST API. Here's a little sample code that you can run in your terminal to make a call and list the Vessel Data Basics for the MSC OSCAR.

Code Example (cURL)

# Copy the cURL request below into your Terminal.
# Replace <VESSEL-OBJECT-ID> with the Vessel ID. In case of the MSC OSCAR it is 9532636.
# Replace <API-KEY> with your API Key.
# Run the query to see a response with the Vessel Data Basics for the MSC OSCAR.

curl -X GET --header 'Accept: application/json' 'https://apiv2.fleetmon.com/basicvessel/<VESSEL-OBJECT-ID>?apikey=<API-KEY>'

Response Code

200

Response Headers

Date: Tue, 12 Feb 2019 14:04:04 GMT
Server: nginx/1.12.0
Connection: keep-alive
Transfer-encoding: chunked
Content-type: application/json; charset=utf-8

Response Body (JSON)

{
"ais_type_of_ship": 71,
"ais_type_of_ship_str": "cargo dang. goods cat. A",
"callsign": "3FBT7",
"cn_iso2": "PA",
"cn_name": "Panama",
"fleetmon_url": "https://www.fleetmon.com/vessels/msc-oscar_9703291_9532636/",
"image_url": "https://photos.fleetmon.com/vessels/msc-oscar_9703291_1976649_XLarge.jpg",
"imo_number": 9703291,
"length": 395,
"mmsi_number": 355906000,
"name": "MSC OSCAR",
"type": "Container ship",
"type_class": "cargo",
"type_code": "CON",
"vessel_id": 9532636,
"width": 59
}

API Rate Limits

Most of the FleetMon API endpoints have a Rate Limit, which is being negotiated in the contract we make with you. The Vessels in Port endpoint for example has a request limit. By default the request_limit_info Parameter is set to false. If you set it to true you will get the usage statistics for this endpoint.

Response Body (JSON)

{
...
"request_limit_info": {
"left_requests": 99999,
"max_requests": 100000,
"used_requests": 1
}
...
}

Response Status Codes

How you get help

In case you need help with the API, check out the API Reference. If you are still in need for some assistance, just contact us.

How to avoid Error 422 and other HTTP Status Codes.

Check out our MarineTraffic API portfolio