developer.fleetmon.com
Open in
urlscan Pro
2a01:4f8:c011:9c3::1
Public Scan
Submitted URL: https://my-zone-count.feat.customerapi.kube.fleetmon.com/
Effective URL: https://developer.fleetmon.com/reference/
Submission: On July 20 via automatic, source certstream-suspicious — Scanned from DE
Effective URL: https://developer.fleetmon.com/reference/
Submission: On July 20 via automatic, source certstream-suspicious — Scanned from DE
Form analysis 0 forms found in the DOM
Text Content
* Getting Started
* API Reference
* Authentication
* My
* Login Token
* getCreate Login Token
* Vessels
* Vessel Search
* getDelivers the list of vessels that matched the criteria.
* Vessel Positions Only
* getReturns the latest position of the provided vessel
* Vessel Identity
* getReturns the identifying attributes of the provided vessel.
* Vessel Route To Next Port
* getFetch route to next port for provided vessel.
* Vessels Nearby
* getget-vessels_nearby-detail
* Vessels Near Position
* getget-vessels_near_position-detail
* Vessel Dynamic AIS
* getLive Dynamic AIS data from requested vessel
* Predict Next Ports
* getReturns the predicted next ports
* Vessel Dynamic AIS Batchable
* getLive Dynamic AIS data from requested vessels
* Port Calls per Vessel Batchable
* getDelivers portcalls for a vessel list
* Next Port / ETA Calculation
* getNext Port
* Vessel Schedule
* getSchedules for vessel
* Vessel Photo
* getURL to main photo for a vessel in specified size
* Vessel Positions with Extended Vessel Data
* getDelivers extended information for a vessel
* Port Calls per Vessel
* getDelivers portcalls for a vessel
* Basic Vessel Data
* getDelivers basic static data for a vessel.
* Non AIS Vessel Particulars
* getDelivers non-AIS information for a vessel
* Vessel Change Events
* getDelivers change events for a vessels.
* Voyage Planning
* postDelivers ETA & distance estimations for a voyage
* Historical Track API
* getReturns historical AIS position reports with fixed period and rate.
Input: MMSI
* Historical AIS Static Messages
* getAIS static and voyage related data reports
* Transshipment
* getDelivers information for vessels nearby a requested position
* Ports
* Expected Port Arrivals
* getDelivers the list of vessels.
* Vessels in Port
* getDelivers the list of vessels
* Port Search
* getDelivers the list of ports that matched the criteria
* Port Calls per Port
* getDelivers portcalls for a port
* Port Calls per Vessel Batchable
* getDelivers portcalls for a vessel list
* Fleets
* Fleet Tracker
* delEmpties the fleet completely.
* getDelivers the fleet.
* postReplaces the fleet with new vessels.
* putAdds vessels to the fleet.
* delRemoves a single vessel from the fleet.
* getDelivers a single vessel from the fleet.
* putModifies custom attributes of a single vessel.
* My Fleet Positions
* getDelivers your MyFleet.
* getDelivers a single vessel of your MyFleet.
* Logistics
* Logistics
* getDelivers information about the vessels current state and the next port
it is heading for
* RoRo Ferry Terminal Demo
* getDelivers a list of terminal calls
* Vessel ETA & Destination Change Events
* getDelivers ETA & Destination Changes for vessels.
* getDelivers ETA & Destination Changes for a single vessel.
* Estimated Laytime - Specific Vessel
* getEstimated laytime for vessel
* Zone
* Regional AIS
* getDelivers the list of vessels inside the bounding box
* Zone Call
* getDelivers a list of call items
* getDelivers a list of call items
* Zone Information
* getDelivers a listing of your configured zones with some extra
information.
* Regional Tracking AIS
* getList of vessels inside the bounding box
* Routing
* Distance To Port
* getReturns a summary of the calculated route to the given port
* Vessel Route To Next Port
* getFetch route to next port for provided vessel.
* Vessel Route From Last Port
* getVessel Route From Last Port
* Weather & Water
* Weather
* getReturns weather info for lat/lon (and timestamp).
* getReturns weather info for Geohash level 5 (and timestamp).
* Water
* getReturns wave info for lat/lon (and timestamp).
* getReturns wave info for Geohash level 5 (and timestamp).
* Current
* getReturns current info for lat/lon (and timestamp).
* getReturns current info for grid coordinates xi and yi (and timeblock).
Documentation Powered by ReDoc
FLEETMON API REFERENCE (VERSION 2.13.0)
Download OpenAPI specification:Download
Welcome to our API reference!
You can view JSON response samples in the area to the right. If you need help
with the API, just contact us.
Follow us on Facebook and Twitter for the latest updates and news on the
platform.
With the use of the FleetMon API, you agree with the Terms of Service.
AUTHENTICATION
APIKEY
Auth via API-Key Query-Parameter
Security Scheme Type API Key Query parameter name: apikey
APIKEY_AUTHORIZATION_HEADER
Auth via API-Key in 'Authorization' header field in the form 'Authorization:
Token '
Security Scheme Type API Key Header parameter name: Authorization
APIKEY_HEADER
Auth via API-Key in 'Api-Key' header field
Security Scheme Type API Key Header parameter name: Api-Key
LOGIN TOKEN
Generate new Login Tokens with Token Keys
CREATE LOGIN TOKEN
get/my/user-login-token/
https://apiv2.fleetmon.com/my/user-login-token/
Generates a login token for one-time use. Valid for one hour after creation.
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
token-key
required
string
Token Key for associated User
RESPONSES
200
Get user Login token for token key
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
404
Requested item does not exist.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 404
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "login_token": "string",
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
}
}
VESSEL SEARCH
Allows searching over the FleetMon vessel database by name, IMO-number,
MMSI-number and/or callsign.
DELIVERS THE LIST OF VESSELS THAT MATCHED THE CRITERIA.
get/vesselsearch/
https://apiv2.fleetmon.com/vesselsearch/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
QUERY PARAMETERS
callsign
string
only exact matching
eni_number
integer <int64>
only exact matching
imo_number
integer <int64>
only exact matching
max_pos_age_days
integer <int64>
maximum timespan of last received position signal, in days
mmsi_number
integer <int64>
only exact matching
name
string
sub-string matching, minium length is 3 characters
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
with_position
boolean
Default: true
request only vessels with a valid position
RESPONSES
200
Vessel Search - vessels response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
},
* "vessels":
[
*
{
* "callsign": "string",
* "cn_iso2": "string",
* "cn_name": "string",
* "imo_number": 0,
* "length": 0,
* "mmsi_number": 0,
* "name": "string",
* "position_received": "2023-07-20T13:22:33Z",
* "static_received": "2023-07-20T13:22:33Z",
* "vessel_id": 0,
* "vt_verbose": "string"
}
]
}
VESSEL POSITIONS ONLY
Returns the latest received position.
RETURNS THE LATEST POSITION OF THE PROVIDED VESSEL
get/vessel/{vessel_id}/position/
https://apiv2.fleetmon.com/vessel/{vessel_id}/position/
This API returns the latest position of the provided vessel including MMSI,
longitude, latitude and received time in Zulu format.
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
PATH PARAMETERS
vessel_id
required
integer <int64>
FleetMon identifier for maritime objects like vessels
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
RESPONSES
200
Vessel Position Only
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
404
Requested item does not exist.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 404
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "latitude": 0,
* "longitude": 0,
* "mmsi": 0,
* "received": "2023-07-20T13:22:33Z",
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
}
}
VESSEL IDENTITY
Returns the identifying attributes of the provided vessel.
RETURNS THE IDENTIFYING ATTRIBUTES OF THE PROVIDED VESSEL.
get/vessel/{vessel_id}/identity/
https://apiv2.fleetmon.com/vessel/{vessel_id}/identity/
Returns the identifying attributes of the provided vessel including name, IMO,
MMSI, Callsign and ENI.
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
PATH PARAMETERS
vessel_id
required
integer <int64>
FleetMon identifier for maritime objects like vessels
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
RESPONSES
200
Vessel Identity
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
404
Requested item does not exist.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 404
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "callsign": "string",
* "eni": 0,
* "imo": 0,
* "mmsi": 0,
* "name": "string",
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
},
* "service_status": "string"
}
VESSEL ROUTE TO NEXT PORT
Returns the route to the next port of a vessel (using ObjectID).
FETCH ROUTE TO NEXT PORT FOR PROVIDED VESSEL.
get/vessel/{vessel_id}/route/port/next/
https://apiv2.fleetmon.com/vessel/{vessel_id}/route/port/next/
Returns the route to the next port of a provided FleetMon vessel identifier.
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
PATH PARAMETERS
vessel_id
required
integer <int64>
FleetMon identifier for maritime objects like vessels
QUERY PARAMETERS
draught
number <float>
Draught of vessel in meters (default: latest reported draught from vessel or 1
if draught is unavailable or 0)
min_draught
number <float>
Minimum draught of vessel in meters (default: minimum reported draught from
vessel or 1 if draught is unavailable or 0)
min_speed
number <float>
Minimum speed of vessel in knots (default: average vessel speed or 20 if speed
is unavailble or 0)
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
speed
number <float>
Speed of vessel in knots (default: latest resported speed from vessel or 20 if
speed is unavailble or 0)
RESPONSES
200
Vessel Route To Next Port Response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
404
Requested item does not exist.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 404
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
[
*
{
* "cost": 0,
* "distance": 0,
* "from_node_id": 0,
* "link_id": 0,
* "path": "string",
* "seq": 0
}
]
VESSELS NEARBY
Vessels nearby requested vessel
GET-VESSELS_NEARBY-DETAIL
get/vessel/{vessel_id}/nearby/
https://apiv2.fleetmon.com/vessel/{vessel_id}/nearby/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
PATH PARAMETERS
vessel_id
required
integer <int64>
FleetMon identifier for maritime objects like vessels
QUERY PARAMETERS
radius
integer <int64>
Radius around the requested vessel in meter. Default and maximum radius is 2500
meter.
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
RESPONSES
200
Vessels nearby
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
404
Requested item does not exist.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 404
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
},
* "vessel_of_interrest":
{
* "course_over_ground": 0,
* "latitude": 0,
* "length": 0,
* "longitude": 0,
* "mmsi": 0,
* "name": "string",
* "nav_status": "string",
* "received": "2023-07-20T13:22:33Z",
* "speed": 0,
* "true_heading": 0,
* "type_class": "string",
* "width": 0
},
* "vessels_nearby":
[
*
{
* "course_over_ground": 0,
* "distance_to_vessel": 0,
* "latitude": 0,
* "length": 0,
* "longitude": 0,
* "mmsi": 0,
* "name": "string",
* "nav_status": "string",
* "received": "2023-07-20T13:22:33Z",
* "speed": 0,
* "true_heading": 0,
* "type_class": "string",
* "vessel_id": 0,
* "width": 0
}
]
}
VESSELS NEAR POSITION
Vessels near requested position
GET-VESSELS_NEAR_POSITION-DETAIL
get/vessel/near/
https://apiv2.fleetmon.com/vessel/near/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
QUERY PARAMETERS
lat
required
number <float>
Latitude in decimal notation for requested position (e.g. 54.092)
lon
required
number <float>
Longitude in decimal notation for requested position (e.g. 12.138)
radius
integer <int64>
Radius around the requested vessel in meter. Default and maximum radius is 2500
meter.
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
RESPONSES
200
Vessels near position
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
404
Requested item does not exist.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 404
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
[
*
{
* "course_over_ground": 0,
* "distance_to_vessel": 0,
* "latitude": 0,
* "length": 0,
* "longitude": 0,
* "mmsi": 0,
* "name": "string",
* "nav_status": "string",
* "received": "2023-07-20T13:22:33Z",
* "speed": 0,
* "true_heading": 0,
* "type_class": "string",
* "width": 0
}
]
VESSEL DYNAMIC AIS
Live Dynamic AIS data from requested vessel
LIVE DYNAMIC AIS DATA FROM REQUESTED VESSEL
get/vessel/{vessel_id}/ais/dynamic/
https://apiv2.fleetmon.com/vessel/{vessel_id}/ais/dynamic/
Live Dynamic AIS data from requested vessel
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
PATH PARAMETERS
vessel_id
required
integer <int64>
FleetMon identifier for maritime objects like vessels
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
RESPONSES
200
Vessel Dynamic AIS
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
404
Requested item does not exist.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 404
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "course_over_ground": 0,
* "in_special_maneuver": true,
* "latitude": 0,
* "longitude": 0,
* "mmsi": 0,
* "name": "string",
* "nav_status": "string",
* "rate_of_turn": 0,
* "received": "2023-07-20T13:22:33Z",
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
},
* "speed": 0,
* "true_heading": 0
}
PREDICT NEXT PORTS
Predicts up to 5 next ports of a vessel via AI using its current AIS destination
string and its last ports called.
RETURNS THE PREDICTED NEXT PORTS
get/vessel/{vessel_id}/port/prediction/
https://apiv2.fleetmon.com/vessel/{vessel_id}/port/prediction/
Predicts up to 5 next ports of a vessel via AI using its current AIS destination
string and its last ports called.
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
PATH PARAMETERS
vessel_id
required
integer <int64>
FleetMon identifier for maritime objects like vessels
QUERY PARAMETERS
last_ports_count_for_prediction
integer <int64>
Default: 5
This optional integer field defines the amount of last ports to take into
account as the vessels history. Default 5, maximum 5.
predicted_port_count
integer <int64>
Default: 5
This optional integer field defines amount of next ports to predict. Default 5,
maximum 5.
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
RESPONSES
200
Returns the predicted next ports.
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
404
Requested item does not exist.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 404
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "non_locational_destinations":
[
* "string"
],
* "predicted_destinations":
[
*
{
* "locode": "string",
* "port_id": 0,
* "port_name": "string",
* "probability": 0
}
],
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
},
* "vessel_id": 0
}
VESSEL DYNAMIC AIS BATCHABLE
Live Dynamic AIS data from requested vessels
LIVE DYNAMIC AIS DATA FROM REQUESTED VESSELS
get/vessel/ais/dynamic/
https://apiv2.fleetmon.com/vessel/ais/dynamic/
Live Dynamic AIS data from requested vessels
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
vessel_ids
required
string <ascii>
FleetMon identifiers for maritime objects like vessels, separated by comma
without spaces
RESPONSES
200
Vessel Dynamic AIS Batchable
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
[
*
{
* "course_over_ground": 0,
* "in_special_maneuver": true,
* "latitude": 0,
* "longitude": 0,
* "mmsi": 0,
* "name": "string",
* "nav_status": "string",
* "rate_of_turn": 0,
* "received": "2023-07-20T13:22:33Z",
* "speed": 0,
* "true_heading": 0,
* "vessel_id": 0
}
]
PORT CALLS PER VESSEL BATCHABLE
Delivers portcalls for provided vessel list.
DELIVERS PORTCALLS FOR A VESSEL LIST
get/vessel/portcalls/batch/
https://apiv2.fleetmon.com/vessel/portcalls/batch/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
QUERY PARAMETERS
from
string <date-time>
Start Date Format: YYYY-MM-TT"T"HH:MM:SS"Z" e.g. 2022-07-03T06:35:42Z
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
until
string <date-time>
End Date Format: YYYY-MM-TT"T"HH:MM:SS"Z" e.g. 2022-08-03T06:35:42Z
vessel_ids
required
string <ascii>
FleetMon identifiers for maritime objects like vessels, separated by comma
without spaces
RESPONSES
200
Vessel Portcall Batchable
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
[
*
{
* "portcalls":
[
*
{
* "ata": "2023-07-20T13:22:33Z",
* "atd": "2023-07-20T13:22:33Z",
* "cn_iso2": "string",
* "latitude": 0,
* "locode": "string",
* "longitude": 0,
* "name": "string"
}
],
* "vessel_id": 0
}
]
NEXT PORT / ETA CALCULATION
Delivers information about the next port, provided by the vessel itself via AIS
destination.
NEXT PORT
get/vessel/{vessel_id}/ports/next/
https://apiv2.fleetmon.com/vessel/{vessel_id}/ports/next/
Delivers information about the next port given by a vessels AIS data.
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
PATH PARAMETERS
vessel_id
required
integer <int64>
FleetMon Vessel ID
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
RESPONSES
200
Next Port
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
404
Requested item does not exist.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 404
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "next-port":
{
* "distance_to_port": 0,
* "eta_calc": "2023-07-20T13:22:33Z",
* "locode": "string",
* "name": "string",
* "port_id": 0,
* "position_received": "2023-07-20T13:22:33Z"
},
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
},
* "static":
{
* "destination": "string",
* "eta": "2023-07-20T13:22:33Z",
* "received_first_time": "2023-07-20T13:22:33Z",
* "received_last_time": "2023-07-20T13:22:33Z"
}
}
VESSEL SCHEDULE
This endpoint provides schedules for vessels, e.g. container schedules.
SCHEDULES FOR VESSEL
get/vessel/{vessel_id}/schedule/
https://apiv2.fleetmon.com/vessel/{vessel_id}/schedule/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
PATH PARAMETERS
vessel_id
required
integer <int64>
FleetMon Vessel ID
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
RESPONSES
200
Vessel Schedule
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
[
*
{
* "eta": "2023-07-20",
* "etd": "2023-07-20",
* "locode": "string",
* "port_name": "string",
* "source": "string",
* "updated": "2023-07-20T13:22:33Z"
}
]
VESSEL PHOTO
Delivers the URL to the main photo for a vessel. Look-up can be done by Vessel
ID or IMO-number.
URL TO MAIN PHOTO FOR A VESSEL IN SPECIFIED SIZE
get/vessel/photo/{size}/
https://apiv2.fleetmon.com/vessel/photo/{size}/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
PATH PARAMETERS
size
required
string
Enum: "thumbnail" "standard" "large"
sizing for photo
QUERY PARAMETERS
imo_number
integer <int64>
only exact matching
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
version
string
Default: "master"
Enum: "most_recent" "most_voted" "master"
photo version
vessel_id
integer <int64>
only exact matching
RESPONSES
200
Vessel Photo - vessels response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
},
* "vessels":
[
*
{
* "image_url": "string"
}
]
}
VESSEL POSITIONS WITH EXTENDED VESSEL DATA
Delivers position and extended detailed information for a single vessel.
DELIVERS EXTENDED INFORMATION FOR A VESSEL
get/vessel/{vessel_id}
https://apiv2.fleetmon.com/vessel/{vessel_id}
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
PATH PARAMETERS
vessel_id
required
integer <int64>
FleetMon identifier for maritime objects like vessels
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
RESPONSES
200
Vessel Positions with Extended Vessel Data - vessel response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
404
Requested item does not exist.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 404
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "ais_type_of_ship": 0,
* "ais_type_of_ship_str": "string",
* "attributes":
[
* "string"
],
* "callsign": "string",
* "cn_iso2": "string",
* "cn_name": "string",
* "datasheet":
{
* "builder": "string",
* "classification_society": "string",
* "dead_weight": 0,
* "design_max_speed": 0,
* "gross_tonnage": 0,
* "height": 0,
* "insurer": "string",
* "length": 0,
* "manager": "string",
* "owner": "string",
* "person_capacity": 0,
* "service_status": "string",
* "teu_14mt": 0,
* "teu_max": 0,
* "teu_reefer": 0,
* "width": 0,
* "year_built": 0,
* "year_scraped": 0
},
* "image_url": "string",
* "imo_number": 0,
* "last_port":
{
* "country": "string",
* "latitude": 0,
* "locode": "string",
* "longitude": 0,
* "name": "string",
* "seen_last": "2023-07-20T13:22:33Z"
},
* "mmsi_number": 0,
* "name": "string",
* "next_port":
{
* "country": "string",
* "eta": "2023-07-20T13:22:33Z",
* "latitude": 0,
* "locode": "string",
* "longitude": 0,
* "name": "string"
},
* "position":
{
* "course_over_ground": 0,
* "in_special_maneuver": true,
* "is_moving": true,
* "latitude": 0,
* "location_str": "string",
* "longitude": 0,
* "nav_status": "string",
* "received": "2023-07-20T13:22:33Z",
* "source": "string",
* "speed": 0,
* "true_heading": 0
},
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
},
* "statistics":
{
* "avg_draught": 0,
* "avg_speed": 0,
* "max_draught": 0,
* "max_speed": 0,
* "min_draught": 0
},
* "type": "string",
* "type_class": "string",
* "type_code": "string",
* "vessel_id": 0,
* "voyage":
{
* "destination": "string",
* "draught": 0,
* "eta": "2023-07-20T13:22:33Z",
* "received": "2023-07-20T13:22:33Z",
* "special_cargo": "string"
}
}
PORT CALLS PER VESSEL
Delivers portcalls for a vessel.
DELIVERS PORTCALLS FOR A VESSEL
get/vessel/portcalls/
https://apiv2.fleetmon.com/vessel/portcalls/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
QUERY PARAMETERS
from
string <date-time>
Start Date Format: YYYY-MM-TT"T"HH:MM:SS"Z" e.g. 2022-07-03T06:35:42Z
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
until
string <date-time>
End Date Format: YYYY-MM-TT"T"HH:MM:SS"Z" e.g. 2022-08-03T06:35:42Z
vessel_id
required
integer <int64>
FleetMon Vessel ID
RESPONSES
200
Port Calls per Vessel - get portcalls response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "portcalls":
[
*
{
* "ata": "2023-07-20T13:22:33Z",
* "atd": "2023-07-20T13:22:33Z",
* "cn_iso2": "string",
* "cn_name": "string",
* "latitude": 0,
* "locode": "string",
* "longitude": 0,
* "name": "string"
}
],
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
}
}
BASIC VESSEL DATA
Delivers basic static data for a vessel.
DELIVERS BASIC STATIC DATA FOR A VESSEL.
get/basicvessel/{vessel_id}
https://apiv2.fleetmon.com/basicvessel/{vessel_id}
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
PATH PARAMETERS
vessel_id
required
integer <int64>
FleetMon identifier for maritime objects like vessels
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
RESPONSES
200
Basic Vessel Data - vessel response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
404
Requested item does not exist.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 404
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "ais_type_of_ship": 0,
* "ais_type_of_ship_str": "string",
* "callsign": "string",
* "cn_iso2": "string",
* "cn_name": "string",
* "fleetmon_url": "string",
* "image_url": "string",
* "imo_number": 0,
* "length": 0,
* "mmsi_number": 0,
* "name": "string",
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
},
* "type": "string",
* "type_class": "string",
* "type_code": "string",
* "vessel_id": 0,
* "width": 0
}
NON AIS VESSEL PARTICULARS
Delivers owner, manager, DWT, GT and a photo-URL for a vessel, if it's
available.
DELIVERS NON-AIS INFORMATION FOR A VESSEL
get/vessel_nonais/{vessel_id}
https://apiv2.fleetmon.com/vessel_nonais/{vessel_id}
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
PATH PARAMETERS
vessel_id
required
integer <int64>
FleetMon identifier for maritime objects like vessels
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
RESPONSES
200
Non AIS Vessel Particulars - vessel response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
404
Requested item does not exist.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 404
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "dead_weight": 0,
* "fleetmon_url": "string",
* "gross_tonnage": 0,
* "image_url": "string",
* "manager": "string",
* "name": "string",
* "owner": "string",
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
},
* "vessel_id": 0
}
VESSEL CHANGE EVENTS
Delivers change events for vessels.
DELIVERS CHANGE EVENTS FOR A VESSELS.
get/vessel/events/{vessel_id}
https://apiv2.fleetmon.com/vessel/events/{vessel_id}
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
PATH PARAMETERS
vessel_id
required
integer <int64>
ID of vessel to get events for
QUERY PARAMETERS
event_type
string
Enum: "CallsignChanged" "DestinationChanged" "DraughtChanged" "EtaChanged"
"IMOChanged" "LengthChanged" "MMSIChanged" "NameChanged" "NavStatusChanged"
"ReceiverPositionAChanged" "ReceiverPositionBChanged" "ReceiverPositionCChanged"
"ReceiverPositionDChanged" "SpecialCargoChanged" "VesselTypeChanged"
"WidthChanged"
Type of event that should be delivered
from
string <date-time>
End of requested time interval (default: until - 1d)
limit
integer <int64>
Default: -5
Limit number of results, <0 means descending order, >0 means ascending order
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
until
string <date-time>
Start of requested time interval (default: now)
RESPONSES
200
Vessel Change Events - get event response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
404
Requested item does not exist.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 404
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "events":
[
*
{
* "event_type": "string",
* "new_value": "string",
* "old_value": "string",
* "timestamp": "2023-07-20T13:22:33Z",
* "vessel":
{
* "mmsi_number": 0,
* "name": "string",
* "vessel_id": 0
}
}
],
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
}
}
VOYAGE PLANNING
Delivers ETA & distance estimations for a route with multiple ports specified by
LOCODE.
DELIVERS ETA & DISTANCE ESTIMATIONS FOR A VOYAGE
post/voyage-planning/
https://apiv2.fleetmon.com/voyage-planning/
It is possible to specify multiple stops by LOCODE together with roadstead time
and laytime.
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
REQUEST BODY SCHEMA: APPLICATION/JSON
List of port stops for the voyage.
start
string <date-time>
Start time of voyage (ETD of first stop; if not included the current vessel
position and distance to first stop is considered)
stops
required
Array of objects (voyage_planning-request-stop) non-empty
vessel_id
required
integer <int64>
Vessel ID
RESPONSES
200
Voayage Planning Response
400
The request body could not be parsed.
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "start": "2023-07-20T13:22:33Z",
* "stops":
[
*
{
* "laytime": 0,
* "locode": "strin",
* "roadstead": 0
}
],
* "vessel_id": 0
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "callsign": "string",
* "imo_number": 0,
* "latitude": 0,
* "longitude": 0,
* "mmsi_number": 0,
* "name": "string",
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
},
* "stops":
[
*
{
* "distance": 0,
* "eta": "2023-07-20T13:22:33Z",
* "etd": "2023-07-20T13:22:33Z",
* "message": "string",
* "port_locode": "string",
* "port_name": "string"
}
],
* "vessel_id": 0
}
HISTORICAL TRACK API
Returns historical AIS position reports with fixed period and rate, by MMSI.
RETURNS HISTORICAL AIS POSITION REPORTS WITH FIXED PERIOD AND RATE. INPUT: MMSI
get/ais/position/
https://apiv2.fleetmon.com/ais/position/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
QUERY PARAMETERS
from
string <date-time>
start time for track
limit
integer <int64>
maximum number of messages to return
mmsi
required
integer <int64>
MMSI number
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
sort
string <ascii>
Default: "asc"
Enum: "asc" "desc"
sorting of items
time_res
integer <int64>
resolution of track in seconds
until
string <date-time>
end time for track
RESPONSES
200
Historical Track API - get ais position items response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "ais_position_items":
[
*
{
* "callsign": "string",
* "course": 0,
* "destination": "string",
* "draught": 0,
* "eta": "2023-07-20T13:22:33Z",
* "heading": 0,
* "imo": 0,
* "latitude": 0,
* "length": 0,
* "longitude": 0,
* "maneuver": true,
* "mmsi": 0,
* "name": "string",
* "nav_status": 0,
* "nmea":
[
* "string"
],
* "nmea_svd":
[
* "string"
],
* "shiptype": 0,
* "source": "string",
* "speed": 0,
* "timestamp": "2023-07-20T13:22:33Z",
* "timestamp_svd": "2023-07-20T13:22:33Z",
* "transponder_class": "string",
* "turn": 0,
* "width": 0
}
],
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
}
}
HISTORICAL AIS STATIC MESSAGES
Delivers AIS messages of type 5, 19 & 24 for a specified MMSI number.
AIS STATIC AND VOYAGE RELATED DATA REPORTS
get/ais/static/
https://apiv2.fleetmon.com/ais/static/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
QUERY PARAMETERS
from
string <date-time>
start time for messages
limit
integer <int64>
maximum number of messages to return
mmsi
required
integer <int64>
MMSI number
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
sort
string <ascii>
Default: "asc"
Enum: "asc" "desc"
sorting of items
until
string <date-time>
end time for messages
RESPONSES
200
Historical AIS Static Messages - get ais static items response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "ais_static_items":
[
*
{
* "callsign": "string",
* "destination": "string",
* "draught": 0,
* "eta": "2023-07-20T13:22:33Z",
* "imo": 0,
* "length": 0,
* "mmsi": 0,
* "name": "string",
* "nmea":
[
* "string"
],
* "shiptype": 0,
* "source": "string",
* "timestamp": "2023-07-20T13:22:33Z",
* "transponder_class": "string",
* "width": 0
}
],
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
}
}
TRANSSHIPMENT
Vessels nearby requested vessel
DELIVERS INFORMATION FOR VESSELS NEARBY A REQUESTED POSITION
get/vessel/transshipment/
https://apiv2.fleetmon.com/vessel/transshipment/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
QUERY PARAMETERS
lat
number <float>
Latitude in decimal notation for requested position (e.g. 54.092)
lon
number <float>
Longitude in decimal notation for requested position (e.g. 12.138)
radius
integer <int64>
Radius around the requested vessel or position in meter. Default and maximum
radius is 2500 meter.
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
type_class
string
Default: null
Enum: "unknown" "high_speed_craft" "cargo_ship" "tug" "yacht" "passenger_ship"
"tanker" "fishing_vessel" "aton"
Type class filter for vessels nearby.
(unknown,high_speed_craft,cargo_ship,tug,yacht,passenger_ship,tanker,fishing_vessel,aton)
vessel_id
integer <int64>
FleetMon identifier for maritime objects like vessels
RESPONSES
200
Transshipment
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
404
Requested item does not exist.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 404
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
},
* "vessel_of_interest":
{
* "course_over_ground": 0,
* "imo": 0,
* "latitude": 0,
* "length": 0,
* "longitude": 0,
* "mmsi": 0,
* "name": "string",
* "nav_status": "string",
* "received": "2023-07-20T13:22:33Z",
* "speed": 0,
* "true_heading": 0,
* "type_class": "string",
* "vessel_type": "string",
* "width": 0
},
* "vessels_nearby":
[
*
{
* "course_over_ground": 0,
* "distance_to_requested_location": 0,
* "draught": 0,
* "imo": 0,
* "latitude": 0,
* "length": 0,
* "longitude": 0,
* "mmsi": 0,
* "name": "string",
* "nav_status": "string",
* "received": "2023-07-20T13:22:33Z",
* "speed": 0,
* "true_heading": 0,
* "type_class": "string",
* "vessel_id": 0,
* "vessel_type": "string",
* "width": 0
}
]
}
EXPECTED PORT ARRIVALS
Lists vessels heading for a specific port, matched by AIS destination.
DELIVERS THE LIST OF VESSELS.
get/port/arrivals/
https://apiv2.fleetmon.com/port/arrivals/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
QUERY PARAMETERS
locode
required
string <ascii>
UN/LOCODE for the port to lookup
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
type_coarse
string
optional vessel coarse type for filtering the result set
type_code
string
optional vessel type code for filtering the result set
RESPONSES
200
Expected Port Arrivals - vessels response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
},
* "vessels":
[
*
{
* "callsign": "string",
* "cn_iso2": "string",
* "country": "string",
* "imo_number": 0,
* "mmsi_number": 0,
* "name": "string",
* "position":
{
* "course_over_ground": 0,
* "latitude": 0,
* "longitude": 0,
* "received": "2023-07-20T13:22:33Z",
* "source": "string",
* "speed": 0,
* "true_heading": 0
},
* "type": "string",
* "type_coarse": "string",
* "type_code": "string",
* "vessel_id": 0,
* "voyage":
{
* "destination": "string",
* "draught": 0,
* "eta": "2023-07-20T13:22:33Z"
}
}
]
}
VESSELS IN PORT
Lists vessels detected in port for the specified LOCODE.
DELIVERS THE LIST OF VESSELS
get/port/inport/
https://apiv2.fleetmon.com/port/inport/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
QUERY PARAMETERS
locode
required
string <ascii>
UN/LOCODE for the port to lookup
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
type_coarse
string
optional vessel coarse type for filtering the result set
type_code
string
optional vessel type code for filtering the result set
RESPONSES
200
Vessels in Port - vessels response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
},
* "vessels":
[
*
{
* "callsign": "string",
* "cn_iso2": "string",
* "country": "string",
* "imo_number": 0,
* "mmsi_number": 0,
* "name": "string",
* "position":
{
* "course_over_ground": 0,
* "latitude": 0,
* "longitude": 0,
* "received": "2023-07-20T13:22:33Z",
* "source": "string",
* "speed": 0,
* "true_heading": 0
},
* "type": "string",
* "type_coarse": "string",
* "type_code": "string",
* "vessel_id": 0,
* "voyage":
{
* "destination": "string",
* "draught": 0,
* "eta": "2023-07-20T13:22:33Z"
}
}
]
}
PORT SEARCH
Allows lookup of ports by UN/LOCODE, name and/or country.
DELIVERS THE LIST OF PORTS THAT MATCHED THE CRITERIA
get/portsearch/
https://apiv2.fleetmon.com/portsearch/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
QUERY PARAMETERS
cn_iso2
string
countries ISO-alpha-2 code, only exact matching, 2 letters
locode
string
UN/LOCODE, only exact matching, 5 letters
name
string
sub-string matching, minium length is 3 characters
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
RESPONSES
200
Port Search - ports response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "ports":
[
*
{
* "cn_iso2": "string",
* "cn_name": "string",
* "id": 0,
* "latitude": 0,
* "locode": "string",
* "locode_alternatives":
[
* "string"
],
* "longitude": 0,
* "name": "string",
* "name_alternatives":
[
* "string"
]
}
],
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
}
}
PORT CALLS PER PORT
Delivers portcalls for a port.
DELIVERS PORTCALLS FOR A PORT
get/port/portcalls/
https://apiv2.fleetmon.com/port/portcalls/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
QUERY PARAMETERS
from
string <date-time>
Start Date Format: YYYY-MM-TT"T"HH:MM:SS"Z" e.g. 2022-07-03T06:35:42Z
locode
required
string <ascii>
UN/LOCODE for the port to lookup
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
type_coarse
string
optional vessel coarse type for filtering the result set
type_code
string
optional vessel type code for filtering the result set
until
string <date-time>
End Date Format: YYYY-MM-TT"T"HH:MM:SS"Z" e.g. 2022-08-03T06:35:42Z
RESPONSES
200
Port Calls per Port - portcalls response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "portcalls":
[
*
{
* "ata": "2023-07-20T13:22:33Z",
* "atd": "2023-07-20T13:22:33Z",
* "callsign": "string",
* "cn_iso2": "string",
* "country": "string",
* "imo_number": 0,
* "mmsi_number": 0,
* "name": "string",
* "type": "string",
* "type_coarse": "string",
* "type_code": "string",
* "vessel_id": 0
}
],
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
}
}
PORT CALLS PER VESSEL BATCHABLE
Delivers portcalls for provided vessel list.
DELIVERS PORTCALLS FOR A VESSEL LIST
get/vessel/portcalls/batch/
https://apiv2.fleetmon.com/vessel/portcalls/batch/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
QUERY PARAMETERS
from
string <date-time>
Start Date Format: YYYY-MM-TT"T"HH:MM:SS"Z" e.g. 2022-07-03T06:35:42Z
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
until
string <date-time>
End Date Format: YYYY-MM-TT"T"HH:MM:SS"Z" e.g. 2022-08-03T06:35:42Z
vessel_ids
required
string <ascii>
FleetMon identifiers for maritime objects like vessels, separated by comma
without spaces
RESPONSES
200
Vessel Portcall Batchable
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
[
*
{
* "portcalls":
[
*
{
* "ata": "2023-07-20T13:22:33Z",
* "atd": "2023-07-20T13:22:33Z",
* "cn_iso2": "string",
* "latitude": 0,
* "locode": "string",
* "longitude": 0,
* "name": "string"
}
],
* "vessel_id": 0
}
]
FLEET TRACKER
Tracking of current positions for a modifiable list of vessels.
EMPTIES THE FLEET COMPLETELY.
delete/fleet/
https://apiv2.fleetmon.com/fleet/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
size_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
RESPONSES
200
Fleet Tracker - clear vessels response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 405
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "items_removed": 0,
* "message": "string",
* "request_limit_info":
{
* "left_requests": 0,
* "left_requests_overall": 0,
* "max_requests": 0,
* "max_requests_overall": 0,
* "used_requests": 0,
* "used_requests_overall": 0
},
* "size_limit_info":
{
* "current_changes": 0,
* "current_list_size": 0,
* "max_changes": 0,
* "max_list_size": 0
},
* "status": "success"
}
DELIVERS THE FLEET.
get/fleet/
https://apiv2.fleetmon.com/fleet/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
size_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
tag
string
optional filter by tag name
RESPONSES
200
Fleet Tracker - vessels response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "request_limit_info":
{
* "left_requests": 0,
* "left_requests_overall": 0,
* "max_requests": 0,
* "max_requests_overall": 0,
* "used_requests": 0,
* "used_requests_overall": 0
},
* "size_limit_info":
{
* "current_changes": 0,
* "current_list_size": 0,
* "max_changes": 0,
* "max_list_size": 0
},
* "vessels":
[
*
{
* "callsign": "string",
* "cn_iso2": "string",
* "cn_name": "string",
* "detail_url": "string",
* "extra": { },
* "fleetmon_url": "string",
* "image_url": "string",
* "imo_number": 0,
* "mmsi_number": 0,
* "modified": "2023-07-20T13:22:33Z",
* "name": "string",
* "note": "",
* "position":
{
* "course_over_ground": 0,
* "in_special_maneuver": true,
* "is_moving": true,
* "latitude": 0,
* "location_str": "string",
* "longitude": 0,
* "received": "2023-07-20T13:22:33Z",
* "source": "string",
* "speed": 0,
* "true_heading": 0
},
* "tags":
[
* "string"
],
* "type_class": "string",
* "type_code": "string",
* "vessel_id": -1,
* "voyage":
{
* "destination": "string",
* "draught": 0,
* "eta": "2023-07-20T13:22:33Z"
},
* "vt_verbose": "string"
}
]
}
REPLACES THE FLEET WITH NEW VESSELS.
post/fleet/
https://apiv2.fleetmon.com/fleet/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
size_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
REQUEST BODY SCHEMA: APPLICATION/JSON
Fleet Tracker - replace vessels request
vessels
required
Array of objects (fleet-listing-add-vessel)
RESPONSES
200
Fleet Tracker - replace vessels response
400
The request body could not be parsed.
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "vessels":
[
*
{
* "extra": { },
* "imo_number": 0,
* "mmsi_number": 0,
* "note": "",
* "tags":
[
* "string"
],
* "vessel_id": -1
}
]
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "items_added":
[
*
{
* "extra": { },
* "imo_number": 0,
* "mmsi_number": 0,
* "note": "",
* "tags":
[
* "string"
],
* "vessel_id": -1,
* "detail_url": "string"
}
],
* "items_failed":
[
*
{
* "extra": { },
* "imo_number": 0,
* "mmsi_number": 0,
* "note": "",
* "tags":
[
* "string"
],
* "vessel_id": -1,
* "message": "string"
}
],
* "request_limit_info":
{
* "left_requests": 0,
* "left_requests_overall": 0,
* "max_requests": 0,
* "max_requests_overall": 0,
* "used_requests": 0,
* "used_requests_overall": 0
},
* "size_limit_info":
{
* "current_changes": 0,
* "current_list_size": 0,
* "max_changes": 0,
* "max_list_size": 0
},
* "success": true
}
ADDS VESSELS TO THE FLEET.
put/fleet/
https://apiv2.fleetmon.com/fleet/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
size_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
REQUEST BODY SCHEMA: APPLICATION/JSON
Fleet Tracker - add vessels request
vessels
required
Array of objects (fleet-listing-add-vessel)
RESPONSES
200
Fleet Tracker - add vessels response
400
The request body could not be parsed.
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "vessels":
[
*
{
* "extra": { },
* "imo_number": 0,
* "mmsi_number": 0,
* "note": "",
* "tags":
[
* "string"
],
* "vessel_id": -1
}
]
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "items_added":
[
*
{
* "extra": { },
* "imo_number": 0,
* "mmsi_number": 0,
* "note": "",
* "tags":
[
* "string"
],
* "vessel_id": -1,
* "detail_url": "string"
}
],
* "items_existing":
[
*
{
* "extra": { },
* "imo_number": 0,
* "mmsi_number": 0,
* "note": "",
* "tags":
[
* "string"
],
* "vessel_id": -1,
* "detail_url": "string"
}
],
* "items_failed":
[
*
{
* "extra": { },
* "imo_number": 0,
* "mmsi_number": 0,
* "note": "",
* "tags":
[
* "string"
],
* "vessel_id": -1,
* "message": "string"
}
],
* "request_limit_info":
{
* "left_requests": 0,
* "left_requests_overall": 0,
* "max_requests": 0,
* "max_requests_overall": 0,
* "used_requests": 0,
* "used_requests_overall": 0
},
* "size_limit_info":
{
* "current_changes": 0,
* "current_list_size": 0,
* "max_changes": 0,
* "max_list_size": 0
},
* "success": true
}
REMOVES A SINGLE VESSEL FROM THE FLEET.
delete/fleet/{vessel_id}
https://apiv2.fleetmon.com/fleet/{vessel_id}
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
PATH PARAMETERS
vessel_id
required
integer <int64>
vessel ID
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
size_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
RESPONSES
200
Fleet Tracker - remove vessel response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
404
Requested item does not exist.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 404
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "items_removed": 0,
* "message": "string",
* "request_limit_info":
{
* "left_requests": 0,
* "left_requests_overall": 0,
* "max_requests": 0,
* "max_requests_overall": 0,
* "used_requests": 0,
* "used_requests_overall": 0
},
* "size_limit_info":
{
* "current_changes": 0,
* "current_list_size": 0,
* "max_changes": 0,
* "max_list_size": 0
},
* "status": "success"
}
DELIVERS A SINGLE VESSEL FROM THE FLEET.
get/fleet/{vessel_id}
https://apiv2.fleetmon.com/fleet/{vessel_id}
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
PATH PARAMETERS
vessel_id
required
integer <int64>
vessel ID
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
size_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
RESPONSES
200
Fleet Tracker - vessel response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
404
Requested item does not exist.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 404
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "callsign": "string",
* "cn_iso2": "string",
* "cn_name": "string",
* "extra": { },
* "fleetmon_url": "string",
* "image_url": "string",
* "imo_number": 0,
* "mmsi_number": 0,
* "modified": "2023-07-20T13:22:33Z",
* "name": "string",
* "note": "",
* "position":
{
* "course_over_ground": 0,
* "in_special_maneuver": true,
* "is_moving": true,
* "latitude": 0,
* "location_str": "string",
* "longitude": 0,
* "received": "2023-07-20T13:22:33Z",
* "source": "string",
* "speed": 0,
* "true_heading": 0
},
* "request_limit_info":
{
* "left_requests": 0,
* "left_requests_overall": 0,
* "max_requests": 0,
* "max_requests_overall": 0,
* "used_requests": 0,
* "used_requests_overall": 0
},
* "size_limit_info":
{
* "current_changes": 0,
* "current_list_size": 0,
* "max_changes": 0,
* "max_list_size": 0
},
* "tags":
[
* "string"
],
* "type_class": "string",
* "type_code": "string",
* "vessel_id": -1,
* "voyage":
{
* "destination": "string",
* "draught": 0,
* "eta": "2023-07-20T13:22:33Z"
},
* "vt_verbose": "string"
}
MODIFIES CUSTOM ATTRIBUTES OF A SINGLE VESSEL.
put/fleet/{vessel_id}
https://apiv2.fleetmon.com/fleet/{vessel_id}
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
PATH PARAMETERS
vessel_id
required
integer <int64>
vessel ID
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
size_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
REQUEST BODY SCHEMA: APPLICATION/JSON
Fleet Tracker - edit vessel request
extra
object (fleet-request-edit-vessel-extra) Nullable
client-specific extra informations for this vessel
note
string
Default: ""
tags
Array of strings <ascii> Nullable
RESPONSES
200
Fleet Tracker - edit vessel response
400
The request body could not be parsed.
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
404
Requested item does not exist.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "extra": { },
* "note": "",
* "tags":
[
* "string"
]
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "changed":
[
* "string"
],
* "message": "string",
* "request_limit_info":
{
* "left_requests": 0,
* "left_requests_overall": 0,
* "max_requests": 0,
* "max_requests_overall": 0,
* "used_requests": 0,
* "used_requests_overall": 0
},
* "size_limit_info":
{
* "current_changes": 0,
* "current_list_size": 0,
* "max_changes": 0,
* "max_list_size": 0
},
* "status": "success"
}
MY FLEET POSITIONS
Delivers your MyFleet or a single vessel of it.
DELIVERS YOUR MYFLEET.
get/myfleet/
https://apiv2.fleetmon.com/myfleet/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
RESPONSES
200
My Fleet Positions - vessels response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 405
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "request_limit_info":
{
* "left_requests": 0,
* "left_requests_overall": 0,
* "max_requests": 0,
* "max_requests_overall": 0,
* "used_requests": 0,
* "used_requests_overall": 0
},
* "vessels":
[
*
{
* "callsign": "string",
* "cn_iso2": "string",
* "cn_name": "string",
* "datasheet":
{
* "builder": "string",
* "classification_society": "string",
* "dead_weight": 0,
* "design_max_speed": 0,
* "gross_tonnage": 0,
* "height": 0,
* "insurer": "string",
* "length": 0,
* "manager": "string",
* "owner": "string",
* "person_capacity": 0,
* "service_status": "string",
* "teu_14mt": 0,
* "teu_max": 0,
* "teu_reefer": 0,
* "width": 0,
* "year_built": 0,
* "year_scraped": 0
},
* "image_url": "string",
* "imo_number": 0,
* "last_port":
{
* "country": "string",
* "latitude": 0,
* "locode": "string",
* "longitude": 0,
* "name": "string",
* "seen_last": "2023-07-20T13:22:33Z"
},
* "mmsi_number": 0,
* "name": "string",
* "next_port":
{
* "country": "string",
* "eta": "2023-07-20T13:22:33Z",
* "latitude": 0,
* "locode": "string",
* "longitude": 0,
* "name": "string"
},
* "position":
{
* "course_over_ground": 0,
* "in_special_maneuver": true,
* "is_moving": true,
* "latitude": 0,
* "location_str": "string",
* "longitude": 0,
* "nav_status": "string",
* "received": "2023-07-20T13:22:33Z",
* "source": "string",
* "speed": 0,
* "true_heading": 0
},
* "staticmap_url": "string",
* "statistics":
{
* "avg_draught": 0,
* "avg_speed": 0,
* "max_draught": 0,
* "max_speed": 0,
* "min_draught": 0
},
* "type": "string",
* "type_class": "string",
* "type_code": "string",
* "vessel_id": 0,
* "voyage":
{
* "destination": "string",
* "draught": 0,
* "eta": "2023-07-20T13:22:33Z",
* "received": "2023-07-20T13:22:33Z",
* "special_cargo": "string"
}
}
]
}
DELIVERS A SINGLE VESSEL OF YOUR MYFLEET.
get/myfleet/{vessel_id}
https://apiv2.fleetmon.com/myfleet/{vessel_id}
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
PATH PARAMETERS
vessel_id
required
integer <int64>
FleetMon identifier for maritime objects like vessels
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
RESPONSES
200
My Fleet Positions - vessel response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
404
Requested item does not exist.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 404
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "callsign": "string",
* "cn_iso2": "string",
* "cn_name": "string",
* "datasheet":
{
* "builder": "string",
* "classification_society": "string",
* "dead_weight": 0,
* "design_max_speed": 0,
* "gross_tonnage": 0,
* "height": 0,
* "insurer": "string",
* "length": 0,
* "manager": "string",
* "owner": "string",
* "person_capacity": 0,
* "service_status": "string",
* "teu_14mt": 0,
* "teu_max": 0,
* "teu_reefer": 0,
* "width": 0,
* "year_built": 0,
* "year_scraped": 0
},
* "image_url": "string",
* "imo_number": 0,
* "last_port":
{
* "country": "string",
* "latitude": 0,
* "locode": "string",
* "longitude": 0,
* "name": "string",
* "seen_last": "2023-07-20T13:22:33Z"
},
* "mmsi_number": 0,
* "name": "string",
* "next_port":
{
* "country": "string",
* "eta": "2023-07-20T13:22:33Z",
* "latitude": 0,
* "locode": "string",
* "longitude": 0,
* "name": "string"
},
* "position":
{
* "course_over_ground": 0,
* "in_special_maneuver": true,
* "is_moving": true,
* "latitude": 0,
* "location_str": "string",
* "longitude": 0,
* "nav_status": "string",
* "received": "2023-07-20T13:22:33Z",
* "source": "string",
* "speed": 0,
* "true_heading": 0
},
* "request_limit_info":
{
* "left_requests": 0,
* "left_requests_overall": 0,
* "max_requests": 0,
* "max_requests_overall": 0,
* "used_requests": 0,
* "used_requests_overall": 0
},
* "staticmap_url": "string",
* "statistics":
{
* "avg_draught": 0,
* "avg_speed": 0,
* "max_draught": 0,
* "max_speed": 0,
* "min_draught": 0
},
* "type": "string",
* "type_class": "string",
* "type_code": "string",
* "vessel_id": 0,
* "voyage":
{
* "destination": "string",
* "draught": 0,
* "eta": "2023-07-20T13:22:33Z",
* "received": "2023-07-20T13:22:33Z",
* "special_cargo": "string"
}
}
LOGISTICS
Delivers information about the vessels current state and the next port it is
heading for.
DELIVERS INFORMATION ABOUT THE VESSELS CURRENT STATE AND THE NEXT PORT IT IS
HEADING FOR
get/logistics/vessel/{vessel_id}
https://apiv2.fleetmon.com/logistics/vessel/{vessel_id}
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
PATH PARAMETERS
vessel_id
required
integer <int64>
FleetMon identifier for maritime objects like vessels
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
RESPONSES
200
Logistics - vessel response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
404
Requested item does not exist.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 404
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "imo_number": 0,
* "last_port":
{
* "ata": "2023-07-20T13:22:33Z",
* "atd": "2023-07-20T13:22:33Z",
* "locode": "string",
* "name": "string"
},
* "mmsi_number": 0,
* "name": "string",
* "next_port":
{
* "eta_calc": "2023-07-20T13:22:33Z",
* "locode": "string",
* "name": "string",
* "travel_distance_nm": 0,
* "travel_time_h": 0
},
* "position":
{
* "course_over_ground": 0,
* "latitude": 0,
* "location_str": "string",
* "longitude": 0,
* "nav_status": "string",
* "received": "2023-07-20T13:22:33Z",
* "speed": 0,
* "true_heading": 0
},
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
},
* "vessel_id": 0,
* "voyage":
{
* "destination": "string",
* "draught": 0,
* "eta": "2023-07-20T13:22:33Z",
* "received": "2023-07-20T13:22:33Z"
}
}
RORO FERRY TERMINAL DEMO
This API deliver the enter and left event of the RoRo-Ferry-Terminal Rostock. It
is no API key necessary. The look back is 48h. It will be provides information
about the Terminal Call itself, information's about the vessel in moment of
arrival and depute as well as additional vessel information like length or call
sigh.
DELIVERS A LIST OF TERMINAL CALLS
get/terminal/call/demo/
https://apiv2.fleetmon.com/terminal/call/demo/
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
RESPONSES
200
RoRo Ferry Terminal Demo - get calls response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 405
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "calls":
[
*
{
* "duration": 0,
* "entered_event":
{
* "destination": "string",
* "draught": 0,
* "eta": "2023-07-20T13:22:33Z",
* "latitude": 0,
* "longitude": 0,
* "timestamp": "2023-07-20T13:22:33Z"
},
* "id": "string",
* "left_event":
{
* "destination": "string",
* "draught": 0,
* "eta": "2023-07-20T13:22:33Z",
* "latitude": 0,
* "longitude": 0,
* "timestamp": "2023-07-20T13:22:33Z"
},
* "vessel":
{
* "callsign": "string",
* "imo": 0,
* "length": 0,
* "mmsi": 0,
* "name": "string",
* "vessel_id": 0,
* "width": 0
},
* "zone":
{
* "latitude": 0,
* "location_description": "string",
* "longitude": 0,
* "name": "string",
* "port_name": "string",
* "zone_id": 0
}
}
],
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
}
}
VESSEL ETA & DESTINATION CHANGE EVENTS
Delivers ETA & Destination Change for vessels.
DELIVERS ETA & DESTINATION CHANGES FOR VESSELS.
get/lng_vessel/events/
https://apiv2.fleetmon.com/lng_vessel/events/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
QUERY PARAMETERS
event_type
required
string <ascii>
Default: "EtaChanged"
Enum: "DestinationChanged" "EtaChanged"
Type of event that should be delivered
from
string <date-time>
Start of requested time interval (default: until - 1d)
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
until
string <date-time>
End of requested time interval (default: now)
RESPONSES
200
Vessel ETA & Destination Change Events - get events response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "events":
[
*
{
* "event_type": "string",
* "new_value": "string",
* "old_value": "string",
* "timestamp": "2023-07-20T13:22:33Z",
* "vessel":
{
* "mmsi_number": 0,
* "name": "string",
* "vessel_id": 0
}
}
],
* "request_limit_info":
{
* "left_requests": 0,
* "left_requests_overall": 0,
* "max_requests": 0,
* "max_requests_overall": 0,
* "used_requests": 0,
* "used_requests_overall": 0
}
}
DELIVERS ETA & DESTINATION CHANGES FOR A SINGLE VESSEL.
get/lng_vessel/events/{vessel_id}
https://apiv2.fleetmon.com/lng_vessel/events/{vessel_id}
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
PATH PARAMETERS
vessel_id
required
integer <int64>
ID of vessel to get events for
QUERY PARAMETERS
event_type
required
string <ascii>
Default: "EtaChanged"
Enum: "DestinationChanged" "EtaChanged"
Type of event that should be delivered
from
string <date-time>
Start of requested time interval (default: until - 1d)
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
until
string <date-time>
End of requested time interval (default: now)
RESPONSES
200
Vessel ETA & Destination Change Events - get event response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
404
Requested item does not exist.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 404
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "events":
[
*
{
* "event_type": "string",
* "new_value": "string",
* "old_value": "string",
* "timestamp": "2023-07-20T13:22:33Z",
* "vessel":
{
* "mmsi_number": 0,
* "name": "string",
* "vessel_id": 0
}
}
],
* "request_limit_info":
{
* "left_requests": 0,
* "left_requests_overall": 0,
* "max_requests": 0,
* "max_requests_overall": 0,
* "used_requests": 0,
* "used_requests_overall": 0
}
}
ESTIMATED LAYTIME - SPECIFIC VESSEL
This API returns an estimated laytime for a vessel in all terminals of a port.
ESTIMATED LAYTIME FOR VESSEL
get/vessel/{vessel_id}/port/{port_id}/laytime/
https://apiv2.fleetmon.com/vessel/{vessel_id}/port/{port_id}/laytime/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
PATH PARAMETERS
port_id
required
integer <int64>
FleetMon Port ID
vessel_id
required
integer <int64>
FleetMon Vessel ID
QUERY PARAMETERS
lookback
integer <int64>
Default: "365"
Enum: "90" "365" "1095"
Lookback time to calculate laytimes in days
minimum_laytime
integer <int64>
Default: "60"
Enum: "5" "60" "3600"
Minimum duration of vessel staying in the terminal.
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
RESPONSES
200
Vessel Laytime
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
[
*
{
* "estimated_laytime": 0,
* "terminal_call_count": 0,
* "terminal_name": "string",
* "zone_id": 0
}
]
REGIONAL AIS
delivers AIS informations for a predefined bounding box
DELIVERS THE LIST OF VESSELS INSIDE THE BOUNDING BOX
get/regional_ais/
https://apiv2.fleetmon.com/regional_ais/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
RESPONSES
200
Regional AIS - vessels response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 405
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
},
* "vessels":
[
*
{
* "ais_type_of_ship": 0,
* "ais_type_of_ship_str": "string",
* "callsign": "string",
* "cn_iso2": "string",
* "country": "string",
* "dwt": 0,
* "imo_number": 0,
* "length": 0,
* "mmsi_number": 0,
* "name": "string",
* "position":
{
* "course_over_ground": 0,
* "in_special_maneuver": true,
* "latitude": 0,
* "longitude": 0,
* "nav_status": "string",
* "received": "2023-07-20T13:22:33Z",
* "source": "string",
* "speed": 0,
* "true_heading": 0
},
* "type": "string",
* "type_class": "string",
* "type_code": "string",
* "vessel_id": 0,
* "voyage":
{
* "destination": "string",
* "draught": 0,
* "eta": "2023-07-20T13:22:33Z",
* "received": "2023-07-20T13:22:33Z",
* "special_cargo": "string"
},
* "width": 0
}
]
}
ZONE CALL
Zone Call API
DELIVERS A LIST OF CALL ITEMS
get/zone/calls/
https://apiv2.fleetmon.com/zone/calls/
Delivers a list of call items for your zones. Each call contains zone
information, vessel information, entered event and left event. The events
contain latitude, longitude, draft, destination and ETA at the time of
entry/leaving. It is possible to specify the time frame and whether to include
closed and/or open calls.
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
QUERY PARAMETERS
closed
boolean
Default: true
Include closed zone calls
collect_time
integer <int64>
Default: 3600
Collect subsequent calls into one, when departure - arrival < collect_time
duration_min
integer <int64>
Default: 0
Minimun duration of call, Shorter calls will be discarded
from
string <date-time>
Start of requested time interval (default: until - 1d)
open
boolean
Default: false
Include open zone calls
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
until
string <date-time>
End of requested time interval (default: now)
zone_id
integer <int64>
ID of zone to get calls for
RESPONSES
200
Zone Call - get zone call response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "calls":
[
*
{
* "duration": 0,
* "entered_event":
{
* "destination": "string",
* "draught": 0,
* "eta": "2023-07-20T13:22:33Z",
* "latitude": 0,
* "longitude": 0,
* "timestamp": "2023-07-20T13:22:33Z"
},
* "id": "string",
* "left_event":
{
* "destination": "string",
* "draught": 0,
* "eta": "2023-07-20T13:22:33Z",
* "latitude": 0,
* "longitude": 0,
* "timestamp": "2023-07-20T13:22:33Z"
},
* "vessel":
{
* "callsign": "string",
* "imo": 0,
* "length": 0,
* "mmsi": 0,
* "name": "string",
* "vessel_id": 0,
* "width": 0
},
* "zone":
{
* "latitude": 0,
* "location_description": "string",
* "longitude": 0,
* "name": "string",
* "port_name": "string",
* "zone_id": 0
}
}
],
* "request_limit_info":
{
* "left_requests": 0,
* "left_requests_overall": 0,
* "max_requests": 0,
* "max_requests_overall": 0,
* "used_requests": 0,
* "used_requests_overall": 0
}
}
DELIVERS A LIST OF CALL ITEMS
get/zone/calls/{zone_id}
https://apiv2.fleetmon.com/zone/calls/{zone_id}
Delivers a list of call items for one of your zones. Each call contains zone
information, basic vessel information, entered event and left event. The events
contain latitude, longitude, draft, destination and ETA at the time of
entry/leaving. It is possible to specify the time frame and whether to include
closed and/or open calls.
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
PATH PARAMETERS
zone_id
required
integer <int64>
ID of zone to get calls for
QUERY PARAMETERS
closed
boolean
Default: true
Include closed zone calls
collect_time
integer <int64>
Default: 3600
Collect subsequent calls into one, when departure - arrival < collect_time
duration_min
integer <int64>
Default: 0
Minimun duration of call, Shorter calls will be discarded
from
string <date-time>
Start of requested time interval (default: until - 1d)
open
boolean
Default: false
Include open zone calls
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
until
string <date-time>
End of requested time interval (default: now)
zone_id
integer <int64>
ID of zone to get calls for
RESPONSES
200
Zone Call - get zone calls response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
404
Requested item does not exist.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 404
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "calls":
[
*
{
* "duration": 0,
* "entered_event":
{
* "destination": "string",
* "draught": 0,
* "eta": "2023-07-20T13:22:33Z",
* "latitude": 0,
* "longitude": 0,
* "timestamp": "2023-07-20T13:22:33Z"
},
* "id": "string",
* "left_event":
{
* "destination": "string",
* "draught": 0,
* "eta": "2023-07-20T13:22:33Z",
* "latitude": 0,
* "longitude": 0,
* "timestamp": "2023-07-20T13:22:33Z"
},
* "vessel":
{
* "callsign": "string",
* "imo": 0,
* "length": 0,
* "mmsi": 0,
* "name": "string",
* "vessel_id": 0,
* "width": 0
},
* "zone":
{
* "latitude": 0,
* "location_description": "string",
* "longitude": 0,
* "name": "string",
* "port_name": "string",
* "zone_id": 0
}
}
],
* "request_limit_info":
{
* "left_requests": 0,
* "left_requests_overall": 0,
* "max_requests": 0,
* "max_requests_overall": 0,
* "used_requests": 0,
* "used_requests_overall": 0
}
}
ZONE INFORMATION
Delivers an overview of your geo-zones.
DELIVERS A LISTING OF YOUR CONFIGURED ZONES WITH SOME EXTRA INFORMATION.
get/zone/
https://apiv2.fleetmon.com/zone/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
RESPONSES
200
Zone Information - zones response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 405
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
},
* "zones":
[
*
{
* "lat": 0,
* "locodes":
[
* "string"
],
* "lon": 0,
* "name": "string",
* "related_ports":
[
*
{
* "cn_iso2": "string",
* "locode": "string",
* "name": "string",
* "port_id": 0
}
],
* "status": "string",
* "type":
{
* "code": "string",
* "color": "string",
* "main_group": "string",
* "sub_group": "string",
* "verbose": "string"
},
* "zone_id": 0
}
]
}
REGIONAL TRACKING AIS
delivers AIS informations for a particular zone defined by the client
LIST OF VESSELS INSIDE THE BOUNDING BOX
get/regional_ais/tracking/
https://apiv2.fleetmon.com/regional_ais/tracking/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
QUERY PARAMETERS
from
string <date-time>
Start of requested time interval (default: until - 5min)
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
until
string <date-time>
End of requested time interval (default: now)
RESPONSES
200
Regional Tracking AIS - get regional tracking ais items response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
},
* "vessels":
[
*
{
* "callsign": "string",
* "cn_iso2": "string",
* "dimensions":
{
* "a": 0,
* "b": 0,
* "c": 0,
* "d": 0
},
* "imo_number": 0,
* "length": 0,
* "mmsi_number": 0,
* "name": "string",
* "position":
{
* "course_over_ground": 0,
* "in_special_maneuver": true,
* "latitude": 0,
* "longitude": 0,
* "nav_status": "string",
* "received": "2023-07-20T13:22:33Z",
* "source": "string",
* "speed": 0,
* "true_heading": 0
},
* "type": "string",
* "type_class": "string",
* "type_code": "string",
* "vessel_id": 0,
* "voyage":
{
* "destination": "string",
* "draught": 0,
* "eta": "2023-07-20T13:22:33Z",
* "received": "2023-07-20T13:22:33Z",
* "special_cargo": "string"
},
* "width": 0
}
]
}
DISTANCE TO PORT
Returns the high level summary of a route to port, only including distance,
costs, and the count of edges from the routing graph.
RETURNS A SUMMARY OF THE CALCULATED ROUTE TO THE GIVEN PORT
get/distance/to/port/{to_port}
https://apiv2.fleetmon.com/distance/to/port/{to_port}
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
PATH PARAMETERS
to_port
required
integer <int64>
Destination Port (expected FleetMon PortID )
QUERY PARAMETERS
draught
number <float>
Draught of vessel in meters (default: 1.0)
from_latlon
string
Start coordinates, two floats seperated with comma (54.875,12.305)
from_port
integer <int64>
Start Port (expected FleetMon PortID )
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
speed
number <float>
Speed of vessel in knots (default: 20.0)
RESPONSES
200
Distance To Port Response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
404
Requested item does not exist.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 404
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "edge_count": 0,
* "request_limit_info":
{
* "left_requests": 0,
* "max_requests": 0,
* "used_requests": 0
},
* "total_cost": 0,
* "total_distance": 0
}
VESSEL ROUTE TO NEXT PORT
Returns the route to the next port of a vessel (using ObjectID).
FETCH ROUTE TO NEXT PORT FOR PROVIDED VESSEL.
get/vessel/{vessel_id}/route/port/next/
https://apiv2.fleetmon.com/vessel/{vessel_id}/route/port/next/
Returns the route to the next port of a provided FleetMon vessel identifier.
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
PATH PARAMETERS
vessel_id
required
integer <int64>
FleetMon identifier for maritime objects like vessels
QUERY PARAMETERS
draught
number <float>
Draught of vessel in meters (default: latest reported draught from vessel or 1
if draught is unavailable or 0)
min_draught
number <float>
Minimum draught of vessel in meters (default: minimum reported draught from
vessel or 1 if draught is unavailable or 0)
min_speed
number <float>
Minimum speed of vessel in knots (default: average vessel speed or 20 if speed
is unavailble or 0)
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
speed
number <float>
Speed of vessel in knots (default: latest resported speed from vessel or 20 if
speed is unavailble or 0)
RESPONSES
200
Vessel Route To Next Port Response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
404
Requested item does not exist.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 404
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
[
*
{
* "cost": 0,
* "distance": 0,
* "from_node_id": 0,
* "link_id": 0,
* "path": "string",
* "seq": 0
}
]
VESSEL ROUTE FROM LAST PORT
Returns the actual route from last port to latest position.
VESSEL ROUTE FROM LAST PORT
get/vessel/{vessel_id}/route/port/last/
https://apiv2.fleetmon.com/vessel/{vessel_id}/route/port/last/
Returns the actual route from last port to latest position.
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
PATH PARAMETERS
vessel_id
required
integer <int64>
FleetMon identifier for maritime objects like vessels
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
RESPONSES
200
Vessel Route From Last Port Response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
404
Requested item does not exist.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 404
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
[
*
{
* "cost": 0,
* "distance": 0,
* "path": "string",
* "seq": 0
}
]
WEATHER
Returns weather info for lat/lon (and timestamp).
RETURNS WEATHER INFO FOR LAT/LON (AND TIMESTAMP).
get/meteo/weather/
https://apiv2.fleetmon.com/meteo/weather/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
QUERY PARAMETERS
lat
number <float>
Default: 0
Latitude for forecast
lon
number <float>
Default: 0
Longitude for forecast
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
when
string <date-time>
Time for forecast, defaults to now
RESPONSES
200
Weather - get weather-reports response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "request_limit_info":
{
* "left_requests": 0,
* "left_requests_overall": 0,
* "max_requests": 0,
* "max_requests_overall": 0,
* "used_requests": 0,
* "used_requests_overall": 0
},
* "weather-reports":
[
*
{
* "cloud_cover": 0,
* "forecast_time": "2023-07-20T13:22:34Z",
* "humidity": 0,
* "ice_cover": 0,
* "land": true,
* "lat": 0,
* "lon": 0,
* "model_runtime": "2023-07-20T13:22:34Z",
* "pressure": 0,
* "temperature": 0,
* "wind_dir": 0,
* "wind_gust": 0,
* "wind_speed": 0,
* "wind_u_cmp": 0,
* "wind_v_cmp": 0
}
]
}
RETURNS WEATHER INFO FOR GEOHASH LEVEL 5 (AND TIMESTAMP).
get/meteo/weather/{geohash}
https://apiv2.fleetmon.com/meteo/weather/{geohash}
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
PATH PARAMETERS
geohash
required
string
Location as geohash (level 5)
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
when
string <date-time>
Time for forecast, defaults to now
RESPONSES
200
Weather - get weather-report response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
404
Requested item does not exist.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 404
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "cloud_cover": 0,
* "forecast_time": "2023-07-20T13:22:34Z",
* "humidity": 0,
* "ice_cover": 0,
* "land": true,
* "lat": 0,
* "lon": 0,
* "model_runtime": "2023-07-20T13:22:34Z",
* "pressure": 0,
* "request_limit_info":
{
* "left_requests": 0,
* "left_requests_overall": 0,
* "max_requests": 0,
* "max_requests_overall": 0,
* "used_requests": 0,
* "used_requests_overall": 0
},
* "temperature": 0,
* "wind_dir": 0,
* "wind_gust": 0,
* "wind_speed": 0,
* "wind_u_cmp": 0,
* "wind_v_cmp": 0
}
WATER
Returns wave info for lat/lon (and timestamp).
RETURNS WAVE INFO FOR LAT/LON (AND TIMESTAMP).
get/meteo/wave/
https://apiv2.fleetmon.com/meteo/wave/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
QUERY PARAMETERS
lat
number <float>
Default: 0
Latitude for forecast
lon
number <float>
Default: 0
Longitude for forecast
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
when
string <date-time>
Time for forecast, defaults to now
RESPONSES
200
Water - get wave-reports response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "request_limit_info":
{
* "left_requests": 0,
* "left_requests_overall": 0,
* "max_requests": 0,
* "max_requests_overall": 0,
* "used_requests": 0,
* "used_requests_overall": 0
},
* "wave-reports":
[
*
{
* "forecast_time": "2023-07-20T13:22:34Z",
* "lat": 0,
* "lon": 0,
* "model_runtime": "2023-07-20T13:22:34Z",
* "pri_wave_dir": 0,
* "pri_wave_period": 0,
* "sec_wave_dir": 0,
* "sec_wave_period": 0,
* "wave_sigh": 0,
* "wind_dir": 0,
* "wind_speed": 0,
* "wind_u_cmp": 0,
* "wind_v_cmp": 0,
* "wind_wave_dir": 0,
* "wind_wave_period": 0
}
]
}
RETURNS WAVE INFO FOR GEOHASH LEVEL 5 (AND TIMESTAMP).
get/meteo/wave/{geohash}
https://apiv2.fleetmon.com/meteo/wave/{geohash}
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
PATH PARAMETERS
geohash
required
string
Location as geohash (level 5)
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
when
string <date-time>
Time for forecast, defaults to now
RESPONSES
200
Water - get wave-report response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
404
Requested item does not exist.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 404
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "forecast_time": "2023-07-20T13:22:34Z",
* "lat": 0,
* "lon": 0,
* "model_runtime": "2023-07-20T13:22:34Z",
* "pri_wave_dir": 0,
* "pri_wave_period": 0,
* "request_limit_info":
{
* "left_requests": 0,
* "left_requests_overall": 0,
* "max_requests": 0,
* "max_requests_overall": 0,
* "used_requests": 0,
* "used_requests_overall": 0
},
* "sec_wave_dir": 0,
* "sec_wave_period": 0,
* "wave_sigh": 0,
* "wind_dir": 0,
* "wind_speed": 0,
* "wind_u_cmp": 0,
* "wind_v_cmp": 0,
* "wind_wave_dir": 0,
* "wind_wave_period": 0
}
CURRENT
Returns current info for lat/lon (and timestamp).
RETURNS CURRENT INFO FOR LAT/LON (AND TIMESTAMP).
get/meteo/current/
https://apiv2.fleetmon.com/meteo/current/
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
QUERY PARAMETERS
lat
number <float>
Default: 0
Latitude for forecast
lon
number <float>
Default: 0
Longitude for forecast
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
when
string <date-time>
Time for forecast, defaults to now
RESPONSES
200
Current - get current-reports response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "current-reports":
[
*
{
* "current_dir": 0,
* "current_speed": 0,
* "current_u_cmp": 0,
* "current_v_cmp": 0,
* "forecast_time": "2023-07-20T13:22:34Z",
* "lat": 0,
* "lon": 0,
* "request_limit_info":
{
* "left_requests": 0,
* "left_requests_overall": 0,
* "max_requests": 0,
* "max_requests_overall": 0,
* "used_requests": 0,
* "used_requests_overall": 0
},
* "salinity": 0,
* "surface_elevation": 0,
* "water_temperature": 0
}
],
* "request_limit_info":
{
* "left_requests": 0,
* "left_requests_overall": 0,
* "max_requests": 0,
* "max_requests_overall": 0,
* "used_requests": 0,
* "used_requests_overall": 0
}
}
RETURNS CURRENT INFO FOR GRID COORDINATES XI AND YI (AND TIMEBLOCK).
get/meteo/current/{gxi}/{tb}/{gyi}
https://apiv2.fleetmon.com/meteo/current/{gxi}/{tb}/{gyi}
AUTHORIZATIONS:
apikeyapikey_authorization_headerapikey_header
PATH PARAMETERS
gxi
required
integer <int64>
grid-coordinate x
gyi
required
integer <int64>
grid-coordinate y
tb
required
integer <int64>
3h-timeblock
QUERY PARAMETERS
request_limit_info
boolean
Default: false
If true some extra attributes will be added to the response informing about
usage and limits of this endpoint.
RESPONSES
200
Current - get current-report response
401
The server could not verify that you are authorized to access the URL.
403
The provided credentials were correct but the API is not yet fully configured.
404
Requested item does not exist.
405
The used HTTP method is not allowed for this URL.
422
A required parameter is missing or has a wrong structure.
429
The client requested the resource too many times. (rate limit)
RESPONSE SAMPLES
* 200
* 401
* 403
* 404
* 405
* 422
* 429
Content type
application/json
Copy
Expand all Collapse all
{
* "current_dir": 0,
* "current_speed": 0,
* "current_u_cmp": 0,
* "current_v_cmp": 0,
* "forecast_time": "2023-07-20T13:22:34Z",
* "lat": 0,
* "lon": 0,
* "request_limit_info":
{
* "left_requests": 0,
* "left_requests_overall": 0,
* "max_requests": 0,
* "max_requests_overall": 0,
* "used_requests": 0,
* "used_requests_overall": 0
},
* "salinity": 0,
* "surface_elevation": 0,
* "water_temperature": 0
}
* Getting Started
* API Reference
Preparing the API Reference...