openapi: 3.2.0 info: title: ShipFinder Global Maritime Data 2 Voyage 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: 2 Voyage Dataset paths: /v1/Voyage/PortAnchoredVessels: get: summary: 2.3 Currently Anchored Vessels deprecated: false description: '## Description The Currently Anchored Vessels retrieves information of all vessels currently at the port anchorage using the port’s five-digit port code. Returned data includes the total count of vessels waiting at the port anchorage, vessel type, basic vessel details, port arrival time and vessel dwell time. ## Use Cases 1. Analyze the average patterns of vessel operation duration based on the dwell time of different vessel types in the returned dataset. 2. For logistic operations, filter vessels by type from the list of currently berthed vessels to identify suitable carriers for cargo transportation. 3. For vessel bunkering and marine equipment upgrade scenarios, obtain the list of in-port vessels first, then query vessel profiles to check equipment and other details, so as to identify targets eligible for bunkering services or equipment upgrade recommendations. ## 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/Voyage/PortAnchoredVessels` | GET | ## Example API Call https://api.elaneglobal.com/v1/Voyage/PortAnchoredVessels?key=1F6D701272402D1E7D8D316CCE519123&port_code=CNSHG **Note:** The key 1F6D701272402D1E7D8D316CCE519123 is the official key of Shipfinder.com, bound to the domain api.shipfinder.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 create your own key in the Dashboard.' tags: - 2 Voyage Dataset parameters: - name: key in: query description: Your personal Shipfinderer API key to verify service permissions required: true example: 1F6D701272402D1E7D8D316CCE519123 schema: type: string - name: port_code in: query description: Standard five-digit port code required: true example: CNSHG schema: type: string - name: ship_type in: query description: 'Filter the type of vessels: see Appendix for details. All vessels will be returned if this parameter is not specified.' required: false schema: type: integer - name: search_type in: query description: 'Query filtering type: 1=Exclude vessels that have not reported AIS data for an extended period; 0=Return all vessels. Note: Vessels with modified MMSI numbers may show as staying within the port boundary for a prolonged duration. This parameter can be used to filter out such vessels.' required: false schema: type: integer responses: '0': description: '' content: application/json: schema: type: object properties: status: type: integer description: API call status code,0 means success msg: type: string description: Exception prompt message total: type: integer description: Total number of vessels currently berthed at the port data: type: array items: type: object properties: mmsi: type: integer description: 9-digit numeric code of MMSI imo: type: integer description: 7-digit numeric code of IMO call_sign: type: string description: 'Call Sign ' ship_name: type: string description: Vessel name ship_type: type: integer description: 'Numeric code of vessel type: see Appendix for details ' length: type: number description: 'Ship length, meters, range (0 - 1022) ' width: type: number description: 'Vessel length in meters, valid value range: 0–1022' left: type: number description: Vessel breadth in meters (nautical standard term) trail: type: number description: Port distance in meters draught: type: number description: Stern Distance in meters stay_time: type: number description: Continuous dwell time of the vessel at the current port, measured in minutes. arrival_time: type: integer description: Vessel arrival time in Unix timestamp required: - mmsi - imo - call_sign - ship_name - ship_type - length - width - left - trail - draught - arrival_time - stay_time x-apifox-orders: - mmsi - imo - call_sign - ship_name - ship_type - length - width - left - trail - draught - arrival_time - stay_time required: - status - msg - total - data x-apifox-orders: - status - msg - total - data example: "{\n \"status\": 0,\n \"msg\": \"\",\n \"total\": 241,\n \"data\": [\n {\n \"mmsi\": 413611860,\n \"imo\": 1400704,\n \"call_sign\": \"\",\n \"ship_name\": \"QIANKUN02\",\n \"ship_type\": 79,\n \"length\": 102.0,\n \"width\": 18.0,\n \"left\": 9.0,\n \"trail\": 90.0,\n \"draught\": 4.1,\n \"arrival_time\": \"1753237238\",\n \"stay_time\": 34.6\n },\n {\n \"mmsi\": 413720847,\n \"imo\": 0,\n \"call_sign\": \"NZEXVC\",\n \"ship_name\": \"WANXUANCHENGHT9678\",\n \"ship_type\": 0,\n \"length\": 883.0,\n \"width\": 32.0,\n \"left\": 32.0,\n \"trail\": 387.0,\n \"draught\": 0.0,\n \"arrival_time\": \"1753080812\",\n \"stay_time\": 2641.7\n },\n ......\n ]\n}" headers: {} x-apifox-name: success security: [] x-apifox-folder: 2 Voyage Dataset x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-430236145-run operationId: getV1VoyagePortAnchoredVessels x-operation-id-source: derived /v1/Voyage/PortBerthedVessels: get: summary: 2.2 Currently Berthed Vessels deprecated: false description: '## Description The Currently Berthed Vessels retrieves information on all vessels currently berthed at a target port using the port’s five-digit port code. Returned data includes the total count of berthed vessels, vessel type, basic vessel details, port arrival time, and vessel dwell time. ## Use Cases 1. Analyze the average patterns of vessel operation duration based on the dwell time of different vessel types in the returned dataset. 2. For logistic operations, filter vessels by type from the list of currently berthed vessels to identify suitable carriers for cargo transportation. 3. For vessel bunkering and marine equipment upgrade scenarios, obtain the list of in-port vessels first, then query vessel profiles to check equipment and other details, so as to identify targets eligible for bunkering services or equipment upgrade recommendations. ## 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/Voyage/PortBerthedVessels` | GET | ## Example API Call https://api.elaneglobal.com/v1/Voyage/PortBerthedVessels?key=1F6D701272402D1E7D8D316CCE519123&port_code=CNSHG **Note:** The key 1F6D701272402D1E7D8D316CCE519123 is the official key of Shipfinder.com, bound to the domain api.shipfinder.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 create your own key in the Dashboard.' tags: - 2 Voyage Dataset parameters: - name: key in: query description: Your personal Shipfinderer API key to verify service permissions required: true example: 1F6D701272402D1E7D8D316CCE519123 schema: type: string - name: port_code in: query description: Standard five-digit port code required: true example: CNSHG schema: type: string - name: ship_type in: query description: 'Filter the type of vessels: see Appendix for details. All vessels will be returned if this parameter is not specified.' required: false schema: type: integer - name: search_type in: query description: 'Query filtering type: 1=Exclude vessels that have not reported AIS data for an extended period; 0=Return all vessels. Note: Vessels with modified MMSI numbers may show as staying within the port boundary for a prolonged duration. This parameter can be used to filter out such vessels.' required: false schema: type: integer responses: '200': description: '' content: application/json: schema: type: object properties: status: type: integer description: API call status code,0 means success msg: type: string description: Exception prompt message total: type: integer description: Total number of vessels currently berthed at the port data: type: array items: type: object properties: mmsi: type: integer description: 9-digit numeric code of MMSI imo: type: integer description: 7-digit numeric code of IMO call_sign: type: string description: 'Call Sign ' ship_name: type: string description: Vessel name ship_type: type: number description: 'Numeric code of vessel type: see Appendix for details ' length: type: number description: 'Ship length, meters, range (0 - 1022) ' width: type: number description: 'Vessel length in meters, valid value range: 0–1022' left: type: number description: Vessel breadth in meters (nautical standard term) trail: type: number description: Port distance in meters draught: type: number description: Stern Distance in meters stay_time: type: number description: Continuous dwell time of the vessel at the current port, measured in minutes arrival_time: type: integer description: 'Vessel arrival time. Format: YYYY-MM-DD HH:MM:SS, UTC' required: - mmsi - imo - call_sign - ship_name - ship_type - length - width - left - trail - draught - arrival_time - stay_time x-apifox-orders: - mmsi - imo - call_sign - ship_name - ship_type - length - width - left - trail - draught - arrival_time - stay_time required: - status - msg - total - data x-apifox-orders: - status - msg - total - data example: "{\n \"status\": 0,\n \"msg\": \"\",\n \"total\": 713,\n \"data\": [\n {\n \"mmsi\": 100900006,\n \"imo\": 0,\n \"call_sign\": \"YYYY\",\n \"ship_name\": \"AISTESTSHIP\",\n \"ship_type\": 70,\n \"length\": 50,\n \"width\": 6,\n \"left\": 5,\n \"trail\": 10,\n \"draught\": 0,\n \"arrival_time\": \"1746484554\",\n \"stay_time\": 2166.2\n },\n {\n \"mmsi\": 100900100,\n \"imo\": 0,\n \"call_sign\": \"YYYY\",\n \"ship_name\": \"AISTESTSHIP\",\n \"ship_type\": 70,\n \"length\": 50,\n \"width\": 6,\n \"left\": 5,\n \"trail\": 10,\n \"draught\": 0,\n \"arrival_time\": \"1746609269\",\n \"stay_time\": 87.7\n },\n ........\n ]\n}" headers: {} x-apifox-name: 成功 security: [] x-apifox-folder: 2 Voyage Dataset x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-430197412-run operationId: getV1VoyagePortBerthedVessels x-operation-id-source: derived /v1/Voyage/PortExpectedArrivals: get: summary: 2.4 Inbound / Expected Arrivals deprecated: false description: '## Description The Inbound/Expected Arrivals retrieves the list and detailed information of vessels expected to arrive at a target port within a specified future time period, using the port’s five-digit port code and the query time period. ## Use Cases 1. **Maritime Supervision** Filter vessels by type and flag state based on the inbound vessel schedule for a specified future period. It allows advance allocation of customs or border inspection resources, and supports risk vessel analysis by combining historical abnormal AIS events, vessel alongside records and other relevant information. 2. **Logistics Vessel Sourcing** Filter the list of inbound cargo vessels at ports near the shipping warehouse, and launch cargo booking solicitations by referring to the operating company information in vessel profiles or the vessel contact list maintained in the corporate shipping capacity pool. 3. **Maritime Traffic Analysis** Analyze port carrying capacity and the attribute profiles of all inbound vessels scheduled to arrive at the port. ## Request Limits This is a premium service that requires advanced permission application prior to use. An API key must be created before using this service. Service calls are subject to quota restrictions according to your permission type.To view your current service access permissions or activate service permissions, please contact our support team: support@elaneglobal.com. ## Endpoint | Endpoint | HTTP Method | |----------|-------------| | `https://api.elaneglobal.com/v1/Voyage/PortExpectedArrivals` | Get | ## Example API Call https://api.elaneglobal.com/v1/Voyage/PortExpectedArrivals?key=1F6D701272402D1E7D8D316CCE519123&port_code=CNSHG&start_time=1746612218&end_time=1747044218&ship_type=0 **Note:** The key `1F6D701272402D1E7D8D316CCE519123` is the official key of Shipfinder.com, bound to the domain api.shipfinder.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 create your own key in the Dashboard. ## Request Parameters | Parameter | Legend | Type | Required | Description | |-----------|--------|------|----------|-------------| | key | Authorization Code | string | yes | Your personal Shipfinder API key to verify service permissions | | port_code | Standard Port Code | string | yes | Standard five-digit port code | | start_time | Start Time | int | yes | Start time represented as a UTC timestamp. The start time must be later than the current time. | | end_time | End Time | int | yes | End time represented as a UTC timestamp. The interval between the start time and end time shall not exceed 1 week for a single request. | | ship_type | Ship Type | int | no | Filter the type of vessels: see References for details. All vessels will be returned if this parameter is not specified. |' tags: - 2 Voyage Dataset parameters: - name: key in: query description: Your personal Shipfinderer API key to verify service permissions required: true example: 1F6D701272402D1E7D8D316CCE519123 schema: type: string - name: port_code in: query description: Standard five-digit port code required: true example: PECLL schema: type: string - name: start_time in: query description: Start time represented as a UTC timestamp. The start time must be later than the current time. required: true example: 1746612218 schema: type: integer - name: end_time in: query description: End time represented as a UTC timestamp. The interval between the start time and end time shall not exceed 1 week for a single request. required: true example: 1747044218 schema: type: integer - name: ship_type in: query description: 'Filter the type of vessels: see Appendix for details. All vessels will be returned if this parameter is not specified.' required: false example: 0 schema: type: integer responses: '0': description: '' content: application/json: schema: type: object properties: status: type: integer description: API call status code,0 means success msg: type: string description: Exception prompt message total: type: integer description: Total number of vessels expected to arrive at the port within the specified time period. data: type: array items: type: object properties: mmsi: type: integer description: 9-digit numeric code of MMSI ship_name: type: string description: Vessel name imo: type: integer description: 7-digit numeric code of IMO dwt: type: integer description: Vessel deadweight tonnage. ship_type: type: integer description: 'Numeric code of vessel type: see Appendix for details ' length: type: number description: 'Vessel length in meters, valid value range: 0–1022' width: type: number description: Vessel breadth in meters (nautical standard term) draught: type: number description: Vessel draught depth in meters dest: type: string description: Standardized destination port names, e.g., SINGAPORE, SG ship_flag: type: string description: Name of the vessel’s flag state preport_name: type: string description: 'Chinese Name of the port of departure ' last_time: type: integer description: AIS last update time in Unix timestamp eta: type: integer description: Estimated Time of Arrival in Unix timestamp required: - mmsi - ship_name - length - width - draught - preport_name - last_time - eta - dest - ship_flag x-apifox-orders: - mmsi - ship_name - imo - dwt - ship_type - length - width - draught - dest - preport_name - last_time - eta - ship_flag required: - status - msg - total - data x-apifox-orders: - status - msg - total - data example: status: 0 msg: '' total: 1 data: - mmsi: 760004503 ship_name: TINO 3 imo: 0 dwt: 0 ship_type: 0 length: 12 width: 33 draught: 5.7 preport_name: Manzanillo last_time: 1774921277 eta: 1775100580 dest: Callao ship_flag: Peru headers: {} x-apifox-name: success security: [] x-apifox-folder: 2 Voyage Dataset x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-430249182-run operationId: getV1VoyagePortExpectedArrivals x-operation-id-source: derived /v1/Voyage/PortInfo: get: summary: 2.1 Port Information deprecated: false description: '## Description The Port Information supports partial search against the global port database. You can retrieve basic port information via partial search using port names or five-digit port code, time zone, and other related details.The five-digit port code returned in the results serves as the unique identifier for port-level data queries. ## Use Cases The five-digit port code obtained from this service can be used in conjunction with the following maritime query services: - Vessel Call Records at Specified Port - Port Vessel Arrival Notices - Port Berthing Vessels Query - Port Anchored Vessels Query ## 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/Voyage/PortInfo` | GET | ## Example API Call https://api.elaneglobal.com/v1/Voyage/PortInfo?key=1F6D701272402D1E7D8D316CCE519123&keywords=qingdao&max=6 **Note**: The key 1F6D701272402D1E7D8D316CCE519123 is the official key of Shipfinder.com, bound to the domain api.shipfinder.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 create your own key in the Dashboard.' tags: - 2 Voyage Dataset parameters: - name: key in: query description: Your personal Shipfinderer API key to verify service permissions required: true example: 1F6D701272402D1E7D8D316CCE519123 schema: type: string - name: keywords in: query description: 'The input keyword for port query can be the port name The maximum number of results to return, with a maximum value of 100.(Chinese supported) or the standard five-digit port code. ' required: true example: qingdao schema: type: string - name: max in: query description: '' required: false example: 6 schema: type: integer responses: '0': description: '' content: application/json: schema: type: object properties: status: type: integer description: API call status code,0 means success msg: type: string description: Exception prompt message total: type: integer data: type: array items: type: object properties: port_code: type: string description: Standard five-digit port code port_name: type: string description: Name of the port port_cnname: type: string description: Chinese name of the port port_time_zone: type: string description: Time zone of the port’s location 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 port_country_code: type: string description: Standard code of the country/region where the port is located x-apifox-orders: - port_code - port_name - port_cnname - port_time_zone - port_country_name - port_country_cnname - port_country_code required: - status - msg - total - data x-apifox-orders: - status - msg - total - data example: status: 0 msg: '' total: 1 data: - port_code: SGSGP port_name: Sigapore port_cnname: 新加坡 port_time_zone: '+8' port_country_name: Singapore port_country_cnname: 新加坡 port_country_code: SG headers: {} x-apifox-name: success security: [] x-apifox-folder: 2 Voyage Dataset x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-429932201-run operationId: getV1VoyagePortInfo 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