openapi: 3.2.0 info: title: ShipFinder Global Maritime Data 4 Prediction Dataset API description: Verbatim assembly of the per-endpoint OpenAPI 3.0.1 fragments ShipFinder publishes on docs.shipfinder.com (one fragment per endpoint page, indexed by the provider llms.txt). Path items are reproduced exactly as published; only the enclosing document (info/servers/tags) is API Evangelist assembly. No operation content was altered. version: 1.0.0 servers: [] tags: - name: 4 Prediction Dataset paths: /v1/Prediction/ETA: get: summary: 4.3 ETA Query deprecated: false description: '## Description Query the berthing information of the vessel at the departure port, the actual departure time, as well as the total voyage, the distance already traveled, and the Estimated Time of Arrival to the next destination port. ## Use Case **Logistics Tracking** Query the berthing time and departure time of the vessel at the departure port, as well as the Estimated Time of Arrival at the destination port. By coordinating with vessel berthing records or vessel arrival and departure event notifications, it is possible to track the arrival and departure times, berthing terminal information, and sailing status of each voyage of the vessel. ## Request Limits An API key must be created before using this service. API calls are subject to quota restrictions according to your permission type. To view your current service access permissions, please contact our support team: support@elaneglobal.com. ## Endpoint | Endpoint | HTTP Method | |----------|-------------| | `https://api.elaneglobal.com/v1/Prediction/ETA` | GET | ## Example API Call https://api.elaneglobal.com/v1/Prediction/ETA?key=1F6D701272402D1E7D8D316CCE519123&mmsi=477172700&port_code=CNSHG&speed=20 **Note:** The key 1F6D701272402D1E7D8D316CCE519123 is the official key of elaneglobal.com, bound to the domain api.elaneglobal.com. Users are not authorized to use this key for data access—utilizing it will return a status code 14, indicating an error in the source domain. To trial the service, please contact our support team: support@elaneglobal.com.' tags: - 4 Prediction Dataset parameters: - name: key in: query description: Your personal Shipfinderer API key to verify service permissions required: true example: 1F6D701272402D1E7D8D316CCE519123 schema: type: string - name: mmsi in: query description: 9-digit numeric code of MMSI required: true example: 477172700 schema: type: integer - name: port_code in: query description: 'Standard 5-digit port code. When this parameter is not specified, the endpoint defaults to the next destination port declared in the vessel’s AIS message.' required: false example: CNSHG schema: type: string - name: speed in: query description: 'Sustained speed for the subsequent voyage, unit: knots (kn). When this parameter is not specified, , ETA is calculated using the vessel’s average sailing speed over the latest month (the average excludes speed data recorded while the vessel was at anchor in port areas).' required: false example: 20 schema: type: number responses: '0': description: '' content: application/json: schema: type: object properties: status: type: integer msg: type: string data: type: object properties: ship: type: object properties: mmsi: type: integer description: 9-digit numeric code of MMSI imo: type: integer description: 7-digit numeric code of IMO ship_name: type: string description: Vessel name call_sign: type: string description: 'Call Sign ' ship_type: type: integer description: 'Type of vessels: see Appendix for details. ' required: - mmsi - imo - ship_name - call_sign - ship_type x-apifox-orders: - mmsi - imo - ship_name - call_sign - ship_type location: type: object properties: lng: type: number description: Longitude of the STS event position, under the WGS84 coordinate system lat: type: number description: Latitude of the STS event position, under the WGS84 coordinate system sea_area: type: string description: Name of the sea area sea_area_code: type: integer description: Code of the sea area sog: type: integer description: Real-time vessel speed over ground in knots; -1=invalid data required: - lng - lat - sog - sea_area - sea_area_code x-apifox-orders: - lng - lat - sog - sea_area - sea_area_code preport: type: object properties: port_code: type: string description: Standard 5-digit port code port_cnname: type: string description: Chinese name of the port port_name: type: string description: Name of the port time_zone: type: string description: Time zone of the port’s location port_country_code: type: string description: Standard code of the country/region where the port is located port_country_name: type: string description: Name of the country/region where the port is located port_country_cnname: type: string description: Chinese name of the country/region where the port is located ata: type: integer description: Actual time of arrival at the port. Time zone varies based on the time_zone parameter. atb: type: integer description: Actual time of berthing at the terminal. Time zone varies based on the time_zone parameter. atd: type: integer description: Actual time of departure from the port. Time zone varies based on the time_zone parameter. required: - port_code - port_cnname - port_name - time_zone - port_country_code - port_country_name - port_country_cnname - ata - atb - atd x-apifox-orders: - port_code - port_cnname - port_name - time_zone - port_country_code - port_country_name - port_country_cnname - ata - atb - atd nextport: type: object properties: port_code: type: string description: Standard 5-digit port code port_cnname: type: string description: Chinese name of the port port_name: type: string description: Name of the port time_zone: type: integer description: Time zone of the port’s location port_country_code: type: string description: Standard code of the country/region where the port is located port_country_name: type: string description: Name of the country/region where the port is located port_country_cnname: type: string description: Chinese name of the country/region where the port is located sailed_distance: type: number description: 'Distance already covered on the voyage. Unit: nautical miles (NM)' sailed_time: type: number description: 'Elapsed sailing time for the voyage. Unit: hours' ais_speed: type: number description: 'Average speed derived from AIS data. Unit: knots (kn)' speed: type: number description: 'Average speed used for ETA computation. If a value is provided for the speed request parameter, ETA is calculated using the input value; otherwise, the historical average speed from AIS is applied. Unit: knots (kn)' remaining_distance: type: number description: 'Estimated remaining voyage distance. Unit: nautical miles (NM).' eta: type: integer description: Estimated Time of Arrival in Unix timestamp required: - port_code - port_cnname - port_name - time_zone - port_country_code - port_country_name - port_country_cnname - sailed_distance - sailed_time - ais_speed - speed - eta - remaining_distance x-apifox-orders: - port_code - port_cnname - port_name - time_zone - port_country_code - port_country_name - port_country_cnname - sailed_distance - sailed_time - ais_speed - speed - eta - remaining_distance required: - ship - location - preport - nextport x-apifox-orders: - ship - location - preport - nextport required: - status - msg - data x-apifox-orders: - status - msg - data example: status: 0 msg: '' data: ship: mmsi: 477172700 imo: 9783538 ship_name: COSCO SHIPPING LIBRA call_sign: VRRV4 ship_type: 71 location: lng: 54.659382 lat: 24.813853 sog: 0 sea_area: Persian Gulf sea_area_code: 4266 preport: port_code: AEKHL port_cnname: 哈里发港 port_name: Khalifa Port time_zone: 4 port_country_code: AE port_country_name: United Arab Emirates port_country_cnname: 阿联酋 ata: 1746707992 atb: 1746716722 atd: 0 nextport: port_code: CNSHG port_cnname: 上海 port_name: Shanghai time_zone: 8 port_country_code: CN port_country_name: China port_country_cnname: 中国 sailed_distance: 0 sailed_time: 0 ais_speed: 7.67 speed: 20 eta: 1747770560 remaining_distance: 5608.53 headers: {} x-apifox-name: success security: [] x-apifox-folder: 4 Prediction Dataset x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-431244206-run operationId: getV1PredictionETA x-operation-id-source: derived /v1/Prediction/RoutePlanPointToPoint: get: summary: 4.1 Point-to-Point Route Planning deprecated: false description: '# 4.1 Point-to-Point Route Planning ## Description The Point-to-Point Route Planning queries the route plan between two coordinate waypoints, or from a departure waypoint to a destination port. Returns the total nautical distance of the route and the latitude/longitude coordinates of all waypoints along the route. ## Use Cases 1. **Logistics Tracking** Save the planned fixed route and match it against the vessel’s real-time position to monitor whether the vessel sails in compliance with the predefined route. Route deviation alerts can be triggered by calculating the distance between the vessel’s real-time position and the planned path. You may also overlay historical vessel tracks with the planned route to visualize and compare discrepancies between the actual voyage track and the planned path. 2. **Navigation Guidance** During vessel transit, retrieve the recommended sailing route in real time based on the vessel’s current position and destination port. The route can be combined with meteorological data for adverse weather avoidance, or used to plot simulated future sailing routes on electronic charts. ## Request Limits An API key must be created before using this service. API calls are subject to quota restrictions according to your permission type. To view your current service access permissions, please contact our support team: support@elaneglobal.com. ## Endpoint | Endpoint | HTTP Method | | --- | --- | | `https://api.elaneglobal.com/v1/Prediction/RoutePlanPointToPoint` | GET | ## Example API Call https://api.elaneglobal.com/v1/Prediction/RoutePlanPointToPoint?key=1F6D701272402D1E7D8D316CCE519123&start_point=113.571144,22.844316&end_point=121.58414,31.37979 https://api.elaneglobal.com/v1/Prediction/RoutePlanPointToPoint?key=1F6D701272402D1E7D8D316CCE519123&start_point=113.571144,22.844316&end_port_code=CNQDG **Note:** The key 1F6D701272402D1E7D8D316CCE519123 is the official key of elaneglobal.com, bound to the domain api.elaneglobal.com. Users are not authorized to use this key for data access—utilizing it will return a status code 14, indicating an error in the source domain. To trial the service, please contact our support team: support@elaneglobal.com.' tags: - 4 Prediction Dataset parameters: - name: key in: query description: Your personal Shipfinderer API key to verify service permissions required: true example: 1F6D701272402D1E7D8D316CCE519123 schema: type: string - name: start_point in: query description: Departure position, formatted as lng,lat (longitude first, latitude second), separated by an English comma. required: true example: 113.571144,22.844316 schema: type: string - name: end_point in: query description: 'Destination position, formatted as lng,lat (longitude first, latitude second), separated by an English comma. Note: Mutually exclusive with end_port_code; one field is mandatory. If both fields are populated, route planning will be calculated based on end_port_code.' required: true example: 121.58414,31.37979 schema: type: string - name: end_port_code in: query description: Standard 5-digit port code of the destination port. required: false schema: type: string - name: avoid in: query description: 'Waypoint IDs to be avoided; see Appendix for details Use commas to separate multiple IDs; leave blank for no avoidance. Maximum 10 avoidance waypoints per request.' required: false schema: type: string - name: through in: query description: 'Required waypoints along the route, formatted as lng,lat-lng,lat; use hyphens (-) to separate multiple waypoints. Leave blank if no mandatory waypoints are needed. Maximum 30 mandatory waypoints per request.' required: false schema: type: integer responses: '0': description: '' content: application/json: schema: type: object properties: status: type: integer msg: type: string data: type: object properties: distance: type: number description: Total distance of the planned route in nautical miles (NM). route: type: array items: type: object properties: lng: type: number description: Waypoint longitude, WGS84 coordinate system lat: type: number description: Waypoint latitude, WGS84 coordinate system required: - lng - lat x-apifox-orders: - lng - lat description: Route Details required: - distance - route x-apifox-orders: - distance - route required: - status - msg - data x-apifox-orders: - status - msg - data example: status: 0 msg: '' data: distance: 915.22 route: - lng: 113.571144 lat: 22.844316 - lng: 113.56867 lat: 22.82417 - lng: 113.59017 lat: 22.81067 - lng: 113.6135 lat: 22.78583 - lng: 113.66833 lat: 22.69617 - lng: 113.68733 lat: 22.64817 - lng: 113.80333 lat: 22.52833 - lng: 114 lat: 22 - lng: 116 lat: 22 - lng: 117 lat: 22.5 - lng: 122.5 lat: 28 - lng: 123 lat: 29 - lng: 123 lat: 30 - lng: 122.5 lat: 30.5 - lng: 122.064 lat: 31.1225 - lng: 121.87067 lat: 31.17867 - lng: 121.73775 lat: 31.28425 - lng: 121.58414 lat: 31.37979 headers: {} x-apifox-name: success security: [] x-apifox-folder: 4 Prediction Dataset x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-431124483-run operationId: getV1PredictionRoutePlanPointToPoint x-operation-id-source: derived /v1/Prediction/RoutePlanPortToPort: get: summary: 4.2 Port-to-Port Route Planning deprecated: false description: '## Description The Port-to-Port Route Planning queries the route plan between two ports, and obtain the total mileage of the route as well as the latitude and longitude coordinates of the points the route passes through. ## Use Case **Logistics Tracking** Save the planned fixed route and match it against the vessel’s real-time position to monitor whether the vessel sails in compliance with the predefined route. Route deviation alerts can be triggered by calculating the distance between the vessel’s real-time position and the planned path. You may also overlay historical vessel tracks with the planned route for visualization, and compare discrepancies between the actual voyage track and the planned path. ## Request Limits An API key must be created before using this service. API calls are subject to quota restrictions according to your permission type. To view your current service access permissions, please contact our support team: support@elaneglobal.com. ## Endpoint | Endpoint | HTTP Method | |----------|-------------| | `https://api.elaneglobal.com/v1/Prediction/RoutePlanPortToPort` | Get | ## Example API Call https://api.elaneglobal.com/v1/Prediction/RoutePlanPortToPort?key=1F6D701272402D1E7D8D316CCE519123&start_port_code=CNGZG&end_port_code=CNSHG&avoid=11 **Note:** The key 1F6D701272402D1E7D8D316CCE519123 is the official key of elaneglobal.com, bound to the domain api.elaneglobal.com. Users are not authorized to use this key for data access—utilizing it will return a status code 14, indicating an error in the source domain. To trial the service, please contact our support team: support@elaneglobal.com.' tags: - 4 Prediction Dataset parameters: - name: key in: query description: Your personal Shipfinderer API key to verify service permissions required: true example: 1F6D701272402D1E7D8D316CCE519123 schema: type: string - name: start_port_code in: query description: Standard 5-digit port code of the departure port. required: true example: CNGZG schema: type: string - name: end_port_code in: query description: Standard 5-digit port code of the arrival port. required: true example: CNSHG schema: type: string - name: avoid in: query description: 'Waypoint IDs to be avoided; see Appendix for details Use commas to separate multiple IDs; leave blank for no avoidance. Maximum 10 avoidance waypoints per request.' required: false example: '11' schema: type: string - name: through in: query description: 'Required waypoints along the route, formatted as lng,lat-lng,lat; use hyphens (-) to separate multiple waypoints. Leave blank if no mandatory waypoints are needed. Maximum 30 mandatory waypoints per request.' required: false example: 0 schema: type: integer responses: '0': description: '' content: application/json: schema: type: object properties: status: type: integer msg: type: string data: type: object properties: distance: type: number description: Total distance of the planned route in nautical miles (NM). route: type: array items: type: object properties: lng: type: number description: Waypoint longitude, WGS84 coordinate system lat: type: number description: Waypoint latitude, WGS84 coordinate system required: - lng - lat x-apifox-orders: - lng - lat description: Route Details required: - distance - route x-apifox-orders: - distance - route required: - status - msg - data x-apifox-orders: - status - msg - data example: status: 0 msg: '' data: distance: 915.22 route: - lng: 113.571144 lat: 22.844316 - lng: 113.56867 lat: 22.82417 - lng: 113.59017 lat: 22.81067 - lng: 113.6135 lat: 22.78583 - lng: 113.66833 lat: 22.69617 - lng: 113.68733 lat: 22.64817 - lng: 113.80333 lat: 22.52833 - lng: 114 lat: 22 - lng: 116 lat: 22 - lng: 117 lat: 22.5 - lng: 122.5 lat: 28 - lng: 123 lat: 29 - lng: 123 lat: 30 - lng: 122.5 lat: 30.5 - lng: 122.064 lat: 31.1225 - lng: 121.87067 lat: 31.17867 - lng: 121.73775 lat: 31.28425 - lng: 121.58414 lat: 31.37979 headers: {} x-apifox-name: success security: [] x-apifox-folder: 4 Prediction Dataset x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-431244012-run operationId: getV1PredictionRoutePlanPortToPort x-operation-id-source: derived x-evidence: harvested: '2026-08-09' index: https://docs.shipfinder.com/llms.txt index_http_status: 200 fragments: 40 note: Each path item was extracted verbatim from the "## OpenAPI Specification" yaml block on the corresponding docs page. The provider publishes no consolidated OpenAPI document. sources: - path: /v1/AIS/FleetPosition method: GET title: 1.1.3 Fleet Position source: https://docs.shipfinder.com/430293359e0.md - path: /v1/AIS/VesselFlagInfo method: GET title: 1.5 Vessel Flag Information source: https://docs.shipfinder.com/429919472e0.md - path: /v1/AIS/VesselPositionMulti method: GET title: 1.1.2 Multi-vessel Position source: https://docs.shipfinder.com/430292321e0.md - path: /v1/AIS/VesselPositionSingle method: GET title: 1.1.1 Single Vessel Position source: https://docs.shipfinder.com/428990613e0.md - path: /v1/AIS/VesselSearch method: GET title: 1.2 Vessel Search source: https://docs.shipfinder.com/428749512e0.md - path: /v1/AIS/VesselsInZone method: GET title: 1.4 Vessels in Zone source: https://docs.shipfinder.com/429583708e0.md - path: /v1/AIS/VesselsNearby method: GET title: 1.3 Vessels Nearby source: https://docs.shipfinder.com/429003024e0.md - path: /v1/Event/AddFleet method: POST title: 7.1.1 Create Fleet source: https://docs.shipfinder.com/432035260e0.md - path: /v1/Event/AddGeofence method: POST title: 7.2.1 Geofence Creation source: https://docs.shipfinder.com/433382008e0.md - path: /v1/Event/AddVesselSpeedAlert method: POST title: 7.3.1 Add Vessel Speed Alert Subscription source: https://docs.shipfinder.com/433460139e0.md - path: /v1/Event/AddVesselToFleet method: POST title: 7.1.5 Add Vessels to Fleet source: https://docs.shipfinder.com/432100231e0.md - path: /v1/Event/DeleteFleet method: POST title: 7.1.4 Delete Fleet source: https://docs.shipfinder.com/432076110e0.md - path: /v1/Event/DeleteFleetVessel method: POST title: 7.1.7 Remove Vessels from Fleet source: https://docs.shipfinder.com/432106004e0.md - path: /v1/Event/DeleteGeofence method: DELETE title: 7.2.4 Geofence Deletion source: https://docs.shipfinder.com/433422419e0.md - path: /v1/Event/DeleteVesselSpeedAlert method: POST title: 7.3.2 Delete Vessel Speed Alert Subscription source: https://docs.shipfinder.com/433471968e0.md - path: /v1/Event/GetFleet method: GET title: 7.1.3 Query Fleet source: https://docs.shipfinder.com/432057101e0.md - path: /v1/Event/GetGeofence method: GET title: 7.2.3 Geofence Query source: https://docs.shipfinder.com/433414777e0.md - path: /v1/Event/UpdateFleetInfo method: POST title: 7.1.2 Update Fleet Information source: https://docs.shipfinder.com/432048484e0.md - path: /v1/Event/UpdateFleetVessel method: POST title: 7.1.6 Batch Update Vessels in Fleet source: https://docs.shipfinder.com/432080706e0.md - path: /v1/Event/UpdateGeofence method: POST title: 7.2.2 Geofence Update source: https://docs.shipfinder.com/433396710e0.md - path: /v1/Event/VesselSpeedAlertList method: GET title: 7.3.3 Query Vessel Speed Alert Subscription List source: https://docs.shipfinder.com/433473614e0.md - path: /v1/History/PortCallRecordsByPort method: GET title: 3.6 Port Calls Records for Port source: https://docs.shipfinder.com/430531632e0.md - path: /v1/History/PortCallRecordsByVessel method: GET title: 3.3 Vessel Port Call History source: https://docs.shipfinder.com/430426234e0.md - path: /v1/History/PortCallRecordsByVesselAtPort method: GET title: 3.4 Vessel Port Call Records at Specific Port source: https://docs.shipfinder.com/430484162e0.md - path: /v1/History/VesselCurrentPortCall method: GET title: 3.5 Vessel Current Port Call source: https://docs.shipfinder.com/430498718e0.md - path: /v1/History/VesselHistoryTrack method: GET title: 3.1 Vessel History Track source: https://docs.shipfinder.com/430346103e0.md - path: /v1/History/VesselStsEvents method: GET title: 3.2 Ship-to-Ship (STS) Events source: https://docs.shipfinder.com/430352093e0.md - path: /v1/Meteorology/CycloneInfo method: GET title: 5.1.2 Tropical Cyclone Details by Point source: https://docs.shipfinder.com/431698143e0.md - path: /v1/Meteorology/CyclonesList method: GET title: 5.1.1 Global Tropical Cyclones List source: https://docs.shipfinder.com/431698053e0.md - path: /v1/Meteorology/MarineWeather method: GET title: 5.3 Global Marine Weather source: https://docs.shipfinder.com/431272522e0.md - path: /v1/Meteorology/TideStationInfo method: GET title: 5.2.2 Query Single Tide Gauge Station Details source: https://docs.shipfinder.com/431865286e0.md - path: /v1/Meteorology/TideStationList method: GET title: 5.2.1 Request parameters for Global Tide Gauge Stations List source: https://docs.shipfinder.com/431857907e0.md - path: /v1/Prediction/ETA method: GET title: 4.3 ETA Query source: https://docs.shipfinder.com/431244206e0.md - path: /v1/Prediction/RoutePlanPointToPoint method: GET title: 4.1 Point-to-Point Route Planning source: https://docs.shipfinder.com/431124483e0.md - path: /v1/Prediction/RoutePlanPortToPort method: GET title: 4.2 Port-to-Port Route Planning source: https://docs.shipfinder.com/431244012e0.md - path: /v1/Voyage/PortAnchoredVessels method: GET title: 2.3 Currently Anchored Vessels source: https://docs.shipfinder.com/430236145e0.md - path: /v1/Voyage/PortBerthedVessels method: GET title: 2.2 Currently Berthed Vessels source: https://docs.shipfinder.com/430197412e0.md - path: /v1/Voyage/PortExpectedArrivals method: GET title: 2.4 Inbound / Expected Arrivals source: https://docs.shipfinder.com/430249182e0.md - path: /v1/Voyage/PortInfo method: GET title: 2.1 Port Information source: https://docs.shipfinder.com/429932201e0.md - path: /v1/Warning/NavigationalWarnings method: GET title: 6.1 China Region Navigational Warnings source: https://docs.shipfinder.com/431872073e0.md