openapi: 3.2.0 info: title: ShipFinder Global Maritime Data 3 History 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: 3 History Dataset paths: /v1/History/PortCallRecordsByPort: get: summary: 3.6 Port Calls Records for Port deprecated: false description: '## Description This Port Calls Records for Port service retrieves all vessels that have called at a port within a specified time frame by the port’s 5-digit port code. Returned data includes vessel basic details, port call records at the target port, and the corresponding previous/next port of call records for each vessel. ## Use Cases 1. **Logistics Tracking** Query and analyze the number of calling vessels, their berth distribution and port call time windows at a port during a specified period. Filter and aggregate the average vessel waiting time and operating time by vessel category, and estimate vessel queuing time at the port as a reference for overall voyage timeline calculation. 2. **Port Analytics** ## Request Limits An API key must be created before using this service. Service calls are subject to quota restrictions according to your permission type. This service queries port call records within the latest month by default. To view your current service access permissions or enable the query for port call records covering 6 months, 12 months or a longer period, please contact our support team: support@elaneglobal.com. ## Endpoint | Endpoint | HTTP Method | |----------|-------------| | `https://api.elaneglobal.com/v1/History/PortCallRecordsByPort` | GET | ## Example API Call [https://api.elaneglobal.com/v1/History/PortCallRecordsByPort?key=1F6D701272402D1E7D8D316CCE519123&port_code=CNSHG&start_time=1744467589&end_time=1744967589] **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: - 3 History 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 5-digit port code required: true example: CNSHG schema: type: string - name: start_time in: query description: Start time of historical berthing records, represented as a Unix timestamp. Both start_time and end_time are mandatory, defining the closed query interval [start_time, end_time]. A single query is limited to a maximum of 1 year (366 days) of port call records. required: true example: 1744467589 schema: type: integer - name: end_time in: query description: End time of historical berthing records, represented as a Unix timestamp. required: true example: 1744967589 schema: type: integer - name: type in: query description: 'Optional query type: 1=Query by ATA (Actual Time of Arrival); 2=Query by ATD (Actual Time of Departure). Default: 1' required: false schema: type: integer - name: time_zone in: query description: 'Time zone type (optional): 1=Local time zone (UTC if unavailable); 2=UTC+8; 3=UTC (Greenwich Mean Time). Default value: 2' required: false schema: type: integer responses: '0': description: '' content: application/json: schema: type: object properties: status: type: integer msg: type: string total: type: integer data: type: array items: type: object properties: imo: type: integer description: 7-digit numeric code of IMO mmsi: type: integer description: 9-digit numeric code of MMSI ship_type: type: integer description: 'Type of vessels: see Appendix for details. ' ship_name: type: string description: Vessel name call_sign: type: string description: 'Call Sign ' currentport: 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 port_time_zone: type: string description: Time zone of the port’s location terminal_name: type: string description: Name of the terminal where the vessel berthed. berth_name: type: string description: Name of the specific berth occupied by the vessel. arrival_anchorage: type: integer description: Actual time of arrival at the anchorage. Time zone varies based on the time_zone parameter. 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. arrival_draught: type: number description: Vessel draft upon arrival at the port, in meters. departure_draught: type: number description: Vessel draft upon departure from the port, in meters. stay_time: type: number description: 'Total time the vessel stayed at the port, in hours. Calculated as: ATD − ATA' stay_terminal_time: type: number description: 'Total time the vessel stayed at the terminal, in hours. Calculated as: ATD − ATB' required: - port_code - port_cnname - port_name - port_time_zone - terminal_name - berth_name - arrival_anchorage - ata - atb - arrival_draught - departure_draught - stay_time - stay_terminal_time x-apifox-orders: - port_code - port_cnname - port_name - port_time_zone - terminal_name - berth_name - arrival_anchorage - ata - atb - atd - arrival_draught - departure_draught - stay_time - stay_terminal_time description: 'List of current port of call information for the vessel. ' previousport: 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 port_time_zone: type: string description: Time zone of the port’s location arrival_anchorage: type: integer description: Actual time of arrival at the anchorage. Time zone varies based on the time_zone parameter. 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 - port_time_zone - arrival_anchorage - ata - atb - atd x-apifox-orders: - port_code - port_cnname - port_name - port_time_zone - arrival_anchorage - ata - atb - atd description: List of the vessel’s previous port of call information. 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 port_time_zone: type: string description: Time zone of the port’s location arrival_anchorage: type: integer description: Actual time of arrival at the anchorage. Time zone varies based on the time_zone parameter. 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 - port_time_zone x-apifox-orders: - port_code - port_cnname - port_name - port_time_zone - arrival_anchorage - ata - atb - atd description: Port of call information for the vessel’s next port. Returns empty if the vessel has not arrived at the next port. required: - imo - mmsi - ship_type - ship_name - call_sign - currentport - previousport - nextport x-apifox-orders: - imo - mmsi - ship_type - ship_name - call_sign - currentport - previousport - nextport required: - status - msg - total - data x-apifox-orders: - status - msg - total - data example: "{\n \"status\": 0,\n \"msg\": \"\",\n \"total\": 5140,\n \"data\": [\n {\n \"imo\": 0,\n \"mmsi\": 413842124,\n \"ship_type\": \"70\",\n \"ship_name\": \"ZHEJIAXINGHUO03191\",\n \"call_sign\": \"0\",\n \"currentport\": {\n \"port_code\": \"27999\",\n \"port_cnname\": \"上海\",\n \"port_name\": \"Shanghai\",\n \"port_time_zone\": \"+8\",\n \"terminal_name\": \"\",\n \"berth_name\": \"\",\n \"arrival_anchorage\": ,\n \"ata\": 1744468393,\n \"atb\": 1744468393,\n \"atd\": 1744635846,\n \"arrival_draught\": 0,\n \"departure_draught\": 0,\n \"stay_time\": 46.51,\n \"stay_terminal_time\": 46.51\n },\n \"previousport\": {\n \"port_code\": \"27999\",\n \"port_cnname\": \"上海\",\n \"port_name\": \"Shanghai\",\n \"port_time_zone\": \"+8\",\n \"arrival_anchorage\": \"\",\n \"ata\": 1744110014,\n \"atb\": 1744110014,\n \"atd\": 1744120857\n },\n \"nextport\": {\n \"port_code\": \"213479\",\n \"port_cnname\": \"奉贤\",\n \"port_name\": \"Fengxian\",\n \"port_time_zone\": \"+8\",\n \"arrival_anchorage\": \"\",\n \"ata\": 1744484085,\n \"atb\": 1744484085,\n \"atd\": 1744498411\n }\n },\n {\n \"imo\": 9302530,\n \"mmsi\": 412046070,\n \"ship_type\": \"90\",\n \"ship_name\": \"HU JIU 18\",\n \"call_sign\": \"BSAR\",\n \"currentport\": {\n \"port_code\": \"27999\",\n \"port_cnname\": \"上海\",\n \"port_name\": \"Shanghai\",\n \"port_time_zone\": \"+8\",\n \"terminal_name\": \"Eastern Tankstore Shanghai\",\n \"berth_name\": \"No 2\",\n \"arrival_anchorage\": \"\",\n \"ata\": 1744469305,\n \"atb\": 1744469305,\n \"atd\": 1745489204,\n \"arrival_draught\": 3500,\n \"departure_draught\": 3500,\n \"stay_time\": 283.31,\n \"stay_terminal_time\": 283.31\n },\n \"previousport\": {\n \"port_code\": \"213784\",\n \"port_cnname\": \"崇明\",\n \"port_name\": \"Chongming\",\n \"port_time_zone\": \"+8\",\n \"arrival_anchorage\": \"\",\n \"ata\": 1744469305,\n \"atb\": 1744469305,\n \"atd\": 1745489204\n },\n \"nextport\": {\n \"port_code\": \"213784\",\n \"port_cnname\": \"崇明\",\n \"port_name\": \"Chongming\",\n \"port_time_zone\": \"+8\",\n \"arrival_anchorage\": \"\",\n \"ata\": 1744469305,\n \"atb\": 1744469305,\n \"atd\": 1745489204\n }\n },\n ......\n ]\n}" headers: {} x-apifox-name: success security: [] x-apifox-folder: 3 History Dataset x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-430531632-run operationId: getV1HistoryPortCallRecordsByPort x-operation-id-source: derived /v1/History/PortCallRecordsByVessel: get: summary: 3.3 Vessel Port Call History deprecated: false description: '## Description The Vessel Port Call History queries a vessel’s historical port call records within a specified time period. It returns the vessel’s anchorage arrival time, port limits arrival time, berthing time, port dwell time, inbound and outbound draft conditions, and other relevant details. ## Use Cases 1. **Maritime Supervision** Analyze whether foreign vessels have berthed at high-risk ports based on historical berthing records, and verify the authenticity and accuracy of entry declaration information. 2. **Logistics Tracking** Track vessel voyage information, settle freight and trace logistics records based on actual port call times and voyage durations, and verify cargo loading/unloading activities by changes in vessel draft. 3. **Financial & Insurance** Compare and verify port call records and draft change records for each vessel voyage against shipping order data, to conduct vessel risk assessment and analysis. ## Request Limits An API key must be created before using this service. Service calls are subject to quota restrictions according to your permission type. This service queries port call records within the latest month by default. To view your current service access permissions or enable the query for port call records covering 6 months, 12 months or a longer period, please contact our support team: support@elaneglobal.com. ## Endpoint | Endpoint | HTTP Method | | --- | --- | | `https://api.elaneglobal.com/v1/History/PortCallRecordsByVessel` | GET | ## Example API Call https://api.elaneglobal.com/v1/History/PortCallRecordsByVessel?key=1F6D701272402D1E7D8D316CCE519123&mmsi=477172700&start_time=1744967589&end_time=1745572389 **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: - 3 History 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: imo in: query description: 7-digit numeric code of IMO required: false schema: type: integer - name: ship_name in: query description: "Vessel name. \nNote: Port call records for all distinct vessels sharing the same name will be returned if duplicate vessel names exist." required: false schema: type: string - name: call_sign in: query description: 'Call Sign. Matching Rule: Spaces are optional; letters are case-insensitive. The sequence and quantity of letters and digits must be consistent with the queried call sign. Note: Port call records for all distinct vessels with an identical call sign will be returned if duplicate call signs exist.' required: false schema: type: string - name: start_time in: query description: 'Start time of historical berthing records, represented as a Unix timestamp. Both start_time and end_time are mandatory, defining the closed query interval [start_time, end_time]. A single query is limited to a maximum of 1 year (366 days) of port call records.' required: true example: 1744967589 schema: type: integer - name: end_time in: query description: End time of historical berthing records, represented as a Unix timestamp. required: true example: 1745572389 schema: type: integer - name: time_zone in: query description: 'Time zone type (optional): 1=Local time zone (UTC if unavailable); 2=UTC+8; 3=UTC (Greenwich Mean Time). Default value: 2' required: false schema: type: integer responses: '0': description: '' content: application/json: schema: type: object properties: status: type: integer msg: type: string data: type: array items: type: object properties: ship_name: type: string description: Vessel name call_sign: type: string description: 'Call Sign ' imo: type: integer description: 7-digit numeric code of IMO mmsi: type: integer description: 9-digit numeric code of MMSI ship_type: type: integer description: 'Numeric code of vessel type: see Appendix for details ' port_cnname: type: string description: Chinese name of the port port_name: type: string description: Name of the port port_time_zone: type: string description: Time zone of the port’s location port_code: type: string description: Standard five-digit port code terminal_name: type: string description: Name of the terminal where the vessel berthed. berth_name: type: string description: Name of the specific berth occupied by the vessel. port_country_cnname: type: string description: Chinese name 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_code: type: string description: Standard code of the country/region where the port is located arrval_anchorage: type: string description: Actual time of arrival at the anchorage. Time zone varies based on the time_zone parameter. 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. arrival_draught: type: number description: Vessel draft upon arrival at the port, in meters. departure_draught: type: number description: Vessel draft upon departure from the port, in meters. stay_time: type: number description: 'Total time the vessel stayed at the port, in hours. Calculated as: ATD − ATA' stay_interminal_time: type: number description: 'Total time the vessel stayed at the terminal, in hours. Calculated as: ATD − ATB' x-apifox-orders: - ship_name - call_sign - imo - mmsi - ship_type - port_cnname - port_name - port_time_zone - port_code - terminal_name - berth_name - port_country_cnname - port_country_name - port_country_code - arrval_anchorage - ata - atb - atd - arrival_draught - departure_draught - stay_time - stay_interminal_time required: - ship_name - mmsi - ship_type - port_name - port_time_zone - port_code - terminal_name - berth_name - port_country_cnname - port_country_name - port_country_code - arrval_anchorage - ata - atb - atd - arrival_draught - departure_draught - stay_time - stay_interminal_time required: - status - msg - data x-apifox-orders: - status - msg - data example: "{\n \"status\": 0,\n \"msg\": \"\",\n \"data\": [\n {\n \"ship_name\": \"COSCOSHIPPINGLIBRA\",\n \"call_sign\": \"VRRV4\",\n \"imo\": 9783538,\n \"mmsi\": 477172700,\n \"ship_type\": 71,\n \"port_cnname\": \"广州\",\n \"port_name\": \"Guangzhou\",\n \"port_time_zone\": \"+8\",\n \"port_code\": \"CNGZG\",\n \"terminal_name\": \"\",\n \"berth_name\": \"\",\n \"port_country_cnname\": \"中国\",\n \"port_country_name\": \"China\",\n \"port_country_code\": \"CN\",\n \"arrval_anchorage\": ,\n \"ata\": 1745058319,\n \"atb\": 1745058319,\n \"atd\": 1745120468,\n \"arrival_draught\": 13.5,\n \"departure_draught\": 14.5,\n \"stay_time\": 17.26,\n \"stay_interminal_time\": 17.26\n }\n ]\n}" headers: {} x-apifox-name: success security: [] x-apifox-folder: 3 History Dataset x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-430426234-run operationId: getV1HistoryPortCallRecordsByVessel x-operation-id-source: derived /v1/History/PortCallRecordsByVesselAtPort: get: summary: 3.4 Vessel Port Call Records at Specific Port deprecated: false description: '## Description The Vessel Port Call Records queries a vessel’s port call records at a specific designated port within a specified time period. It returns the vessel’s time of arrival at the anchorage, time of arrival within port limits, time of berthing at the berth, port stay duration, as well as the vessel’s draft conditions upon port entry and departure. ## Use Cases 1. **Maritime Supervision** Analyze whether foreign vessels have berthed at high-risk ports based on historical port call records, and verify the authenticity and accuracy of the relevant entry declaration information. 2. **Logistics Tracking** Track vessel voyage details, settle freight and trace logistics records based on actual port entry/departure times and voyage durations, and verify cargo loading/unloading operations through changes in vessel draft. 3. **Finance & Insurance** Cross-verify port call records and draft fluctuation records of each vessel voyage against shipping order data for vessel risk analysis and authenticity validation. ## Request Limits An API key must be created before using this service. Service calls are subject to quota restrictions according to your permission type. This service queries port call records within the latest month by default. To view your current service access permissions or enable the query for port call records covering 6 months, 12 months or a longer period, please contact our support team: support@elaneglobal.com. ## Endpoint | Endpoint | HTTP Method | |----------|-------------| | `https://api.elaneglobal.com/v1/History/PortCallRecordsByVesselAtPort` | Get | ## Example API Call https://api.elaneglobal.com/v1/History/PortCallRecordsByVesselAtPort?key=1F6D701272402D1E7D8D316CCE519123&mmsi=477172700&port_code=CNGZG&start_time=1744967589&end_time=1745572389 **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: - 3 History 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: imo in: query description: 7-digit numeric code of IMO required: false schema: type: integer - name: ship_name in: query description: Vessel name required: false schema: type: string - name: call_sign in: query description: Call Sign required: false schema: type: string - name: port_code in: query description: Standard five-digit port code required: true example: CNGZG schema: type: string - name: start_time in: query description: 'Start time of historical berthing records, represented as a Unix timestamp. Both start_time and end_time are mandatory, defining the closed query interval [start_time, end_time]. A single query is limited to a maximum of 1 year (366 days) of port call records.' required: true example: '1744967589' schema: type: string - name: end_time in: query description: End time of historical berthing records, represented as a Unix timestamp. required: true example: '1745572389' schema: type: string - name: time_zone in: query description: 'Time zone type (optional): 1=Local time zone (UTC if unavailable); 2=UTC+8; 3=UTC (Greenwich Mean Time). Default value: 2' required: false schema: type: integer responses: '0': description: '' content: application/json: schema: type: object properties: status: type: integer msg: type: string total: type: integer data: type: array items: type: object properties: ship_name: type: string description: Vessel name call_sign: type: string description: 'Call Sign ' imo: type: integer description: 7-digit numeric code of IMO mmsi: type: integer description: 9-digit numeric code of MMSI ship_type: type: integer description: 'Numeric code of vessel type: see Appendix for details ' port_cnname: type: string description: Chinese name of the port port_name: type: string description: Name of the port port_time_zone: type: string description: Time zone of the port’s location port_code: type: string description: Standard five-digit port code terminal_name: type: string description: Name of the terminal where the vessel berthed. berth_name: type: string description: Name of the specific berth occupied by the vessel. port_country_cnname: type: string description: Chinese name 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_code: type: string description: Standard code of the country/region where the port is located arriveanchorage: type: string description: Actual time of arrival at the anchorage. Time zone varies based on the time_zone parameter. ata: type: string description: Actual time of arrival at the port. Time zone varies based on the time_zone parameter. atb: type: string description: Actual time of berthing at the terminal. Time zone varies based on the time_zone parameter. atd: type: string description: Actual time of departure from the port. Time zone varies based on the time_zone parameter. arrival_draught: type: number description: Vessel draft upon arrival at the port, in meters. departure_draught: type: number description: Vessel draft upon departure from the port, in meters. stay_time: type: number description: 'Total time the vessel stayed at the port, in hours. Calculated as: ATD − ATA' stay_terminal_time: type: number description: 'Total time the vessel stayed at the terminal, in hours. Calculated as: ATD − ATB' x-apifox-orders: - ship_name - call_sign - imo - mmsi - ship_type - port_cnname - port_name - port_time_zone - port_code - terminal_name - berth_name - port_country_cnname - port_country_name - port_country_code - arriveanchorage - ata - atb - atd - arrival_draught - departure_draught - stay_time - stay_terminal_time required: - status - msg - total - data x-apifox-orders: - status - msg - total - data example: "{\n \"status\": 0,\n \"msg\": \"\",\n \"total\": 1,\n \"data\": [\n {\n \"ship_name\": \"COSCO SHIPPING LIBRA\",\n \"call_sign\": \"VRRV4\",\n \"imo\": 9783538,\n \"mmsi\": 477172700,\n \"ship_type\": \"60\",\n \"port_cnname\": \"新加坡\",\n \"port_name\": \"Singapore\",\n \"port_time_zone\": \"+8\",\n \"port_code\": \"SGSIN\",\n \"terminal_name\": \"\",\n \"berth_name\": \"\",\n \"port_country_cnname\": \"新加坡\",\n \"port_country_name\": \"Singapore\",\n \"port_country_code\": \"SG\",\n \"arriveanchorage\": ,\n \"ata\": 1745058319,\n \"atb\": 1745058319,\n \"atd\": 1745120468,\n \"arrival_draught\": 13500,\n \"departure_draught\": 0,\n \"stay_time\": 17.26,\n \"stay_terminal_time\": 17.26\n }\n ]\n}" headers: {} x-apifox-name: success security: [] x-apifox-folder: 3 History Dataset x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-430484162-run operationId: getV1HistoryPortCallRecordsByVesselAtPort x-operation-id-source: derived /v1/History/VesselCurrentPortCall: get: summary: 3.5 Vessel Current Port Call deprecated: false description: '## Description The Vessel Current Port Call queries whether a vessel has an active port call. If an active port call exists, it returns the details of the current port of call and port entry time. ## Use Cases **Logistics Tracking** Track the vessel’s current berthing status. Combined with the real-time vessel position push service or port arrival/departure event push service, it supports vessel speed variation monitoring, and enables queries of the detailed port information as well as the specific port arrival and berthing times when the vessel calls at a port. ## 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/History/VesselCurrentPortCall` | GET | ## Example API Call https://api.elaneglobal.com/v1/History/VesselCurrentPortCall?key=1F6D701272402D1E7D8D316CCE519123&mmsi=477172700 **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: - 3 History 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: string - name: imo in: query description: 7-digit numeric code of IMO required: false schema: type: integer - name: ship_name in: query description: Vessel name required: false schema: type: string - name: call_sign in: query description: Call Sign required: false schema: type: string - name: time_zone in: query description: 'Time zone type (optional): 1=Local time zone (UTC if unavailable); 2=UTC+8; 3=UTC (Greenwich Mean Time). Default value: 2' required: false schema: type: integer responses: '0': description: '' content: application/json: schema: type: object properties: status: type: integer msg: type: string total: type: integer data: type: array items: type: object properties: ship_name: type: string description: Vessel name call_sign: type: string description: 'Call Sign ' imo: type: integer description: 7-digit numeric code of IMO mmsi: type: integer description: 9-digit numeric code of MMSI ship_type: type: integer description: 'Type of vessels: see Appendix for details. ' current_sea_area: type: string description: The current sea area where the vessel is located. sea_area_code: type: string description: Code of the sea area where the vessel is currently located. current_city: type: string description: Current city information of the vessel (only applicable to Chinese cities at present). current_city_code: type: string description: Current city code of the vessel (only applicable to Chinese cities at present). lng: type: number description: Coordinate longitude, WGS84 coordinate system lat: type: number description: Coordinate longitude, WGS84 coordinate system previousport: 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 arrive_anchorage: type: integer description: Actual time of arrival at the anchorage. Time zone varies based on the time_zone parameter. 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_name - port_cnname - port_time_zone - port_country_name - port_country_cnname - port_country_code - arrive_anchorage - ata - atb - atd x-apifox-orders: - port_code - port_name - port_cnname - port_time_zone - port_country_name - port_country_cnname - port_country_code - arrive_anchorage - ata - atb - atd description: List of the vessel’s previous port of call information. currentport: 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 country_en: 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 country_code: type: string description: National Standard Code Value arriveanchorage: type: integer description: Actual time of arrival at the anchorage. Time zone varies based on the time_zone parameter. 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. required: - port_code - port_name - port_cnname - port_time_zone - country_en - port_country_cnname - country_code - arriveanchorage - ata - atb x-apifox-orders: - port_code - port_name - port_cnname - port_time_zone - country_en - port_country_cnname - country_code - arriveanchorage - ata - atb description: List of current port of call information for the vessel. Returns empty if the vessel is not currently berthed at any port. x-apifox-orders: - ship_name - call_sign - imo - mmsi - ship_type - current_sea_area - sea_area_code - current_city - current_city_code - lng - lat - previousport - currentport description: Vessel Information required: - status - msg - total - data x-apifox-orders: - status - msg - total - data example: status: 0 msg: '' total: 1 data: - ship_name: COSCO SHIPPING LIBRA call_sign: VRRV4 imo: 9783538 mmsi: 477172700 ship_type: '60' current_sea_area: Persian gulf sea_area_code: '4266' current_city: '' current_city_code: '' lng: 54.659412 lat: 24.813847 previousport: port_code: '208866' port_name: Jebel Ali port_cnname: 杰贝阿里 port_time_zone: '+4' port_country_name: United Arab Emirates port_country_cnname: 阿联酋 port_country_code: AE arrive_anchorage: 1746526617 ata: 1746526617 atb: 1746540887 atd: 1746691874 currentport: port_code: '337404' port_name: Khalifa Port port_cnname: 哈里发港 port_time_zone: '+4' country_en: United Arab Emirates port_country_cnname: 阿联酋 country_code: AE arriveanchorage: 1746707992 ata: 1746707992 atb: 1746716722 headers: {} x-apifox-name: success security: [] x-apifox-folder: 3 History Dataset x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-430498718-run operationId: getV1HistoryVesselCurrentPortCall x-operation-id-source: derived /v1/History/VesselHistoryTrack: get: summary: 3.1 Vessel History Track deprecated: false description: '## Description The Vessel History Track retrieves historical track points of a vessel by its MMSI number and a specified time period. ## Use Cases 1. **Logistics Tracking** Track vessel historical track data, and support track query, track visualization and track playback in combination with nautical charts. 2. **Vessel Behavior Analysis** Analyze whether a vessel has abnormal navigational behaviors based on each track point in the historical voyage data, combined with meteorological data, navigational warnings and other relevant information. ## Request Limits An API key must be created before using this service. Service calls are subject to quota restrictions according to your permission type. The service only supports querying vessel tracks within the latest month by default. To view your current service access permissions or access vessel track records from an earlier time period, please contact our support team: support@elaneglobal.com. ## Endpoint | Endpoint | HTTP Method | |-----------------------------------------------|-------------| | `https://api.elaneglobal.com/v1/History/VesselHistoryTrack` | GET | ## Example API Call https://api.elaneglobal.com/v1/History/VesselHistoryTrack?key=1F6D701272402D1E7D8D316CCE519123&mmsi=477172700&start_time=1744017189&end_time=1744019589 **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: - 3 History 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: start_time in: query description: Query start time, represented as a Unix timestamp. required: true example: 1744017189 schema: type: integer - name: end_time in: query description: Query end time, represented as a Unix timestamp. required: true example: 1744019589 schema: type: integer - name: output in: query description: 'Output data format selection: 0=Binary data in Base64 encoding; 1=JSON format. Default value: 1' required: false schema: type: integer responses: '0': description: '' content: application/json: schema: type: object properties: status: type: integer msg: type: string data: type: array items: type: object properties: data_source: type: integer description: 0=Terrestrial AIS stations or Shipborne AIS; 1=Satellite AIS utc: type: integer description: Timestamp when the track point was updated and uploaded, represented as a Unix timestamp lng: type: number description: Coordinate latitude, WGS84 coordinate system lat: type: number description: Coordinate longitude, WGS84 coordinate system sog: type: number description: Real-time vessel speed over ground in knots; -1=invalid data cog: type: number description: Course over ground in degrees ; -1=invalid data required: - data_source - utc - lng - lat - sog - cog x-apifox-orders: - data_source - utc - lng - lat - sog - cog required: - status - msg - data x-apifox-orders: - status - msg - data example: status: 0 msg: '' data: - data_source: 0 utc: 1744017444 lng: 121.730682 lat: 38.272802 sog: 16.6 cog: 295.2 - data_source: 0 utc: 1744017749 lng: 121.703605 lat: 38.282833 sog: 16.7 cog: 294.9 - data_source: 0 utc: 1744018056 lng: 121.676097 lat: 38.293053 sog: 16.8 cog: 294.5 - data_source: 0 utc: 1744018361 lng: 121.648798 lat: 38.303138 sog: 16.8 cog: 294.7 - data_source: 0 utc: 1744018662 lng: 121.621805 lat: 38.313288 sog: 16.9 cog: 296.8 - data_source: 0 utc: 1744018968 lng: 121.594477 lat: 38.324208 sog: 17 cog: 296.7 - data_source: 0 utc: 1744019268 lng: 121.567605 lat: 38.334835 sog: 17 cog: 296.1 - data_source: 0 utc: 1744019568 lng: 121.540758 lat: 38.345627 sog: 17.1 cog: 297.1 headers: {} x-apifox-name: success security: [] x-apifox-folder: 3 History Dataset x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-430346103-run operationId: getV1HistoryVesselHistoryTrack x-operation-id-source: derived /v1/History/VesselStsEvents: get: summary: 3.2 Ship-to-Ship (STS) Events deprecated: false description: '## Description The Ship-to-Ship (STS) Events queries whether a specified vessel has had ship-to-ship (STS) operations within a specified time period. If STS events are detected, it will return details of the paired vessel, as well as the STS position, coordinates, start time and end time of the event. ## Applicable Scenarios **Freight Logistics** 1. **Normal STS Transshipment** Monitor the cargo transfer flow where large vessels transship cargo to small crafts via STS operations. Track and analyze each phase of cargo circulation by combining the small craft details and their subsequent port berthing records. 2. **Cargo Theft Monitoring** For non-transshipment scenarios, STS events detected during vessel navigation will trigger key monitoring for potential cargo theft. Determine whether small crafts are involved in cargo theft at the time of the STS event by integrating CCTV and other monitoring tools. **Maritime Supervision** - **Vessel Behavior Analysis** Maritime regulatory authorities can use vessel STS records to analyze vessel behavior patterns, and identify unauthorized STS operations as abnormal behaviors by combining other comprehensive datasets. ## 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/History/VesselStsEvents` | Get | ## Example API Call https://api.elaneglobal.com/v1/History/VesselStsEvents?key=1F6D701272402D1E7D8D316CCE519123&mmsi=477172700&start_time=1749956794&end_time=1751446602&approach_zone=3 **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: - 3 History 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: 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: 1749956794 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: 1751446602 schema: type: integer - name: approach_zone in: query description: 'STS operation area: 1=STS in port area; 2=STS at anchorage; 3=STS in other areas.' required: false example: 3 schema: type: integer responses: '0': description: '' content: application/json: schema: type: object properties: status: type: integer msg: type: string data: type: object properties: ship_data: 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: Vessel Type required: - mmsi - imo - call_sign - ship_name - ship_type x-apifox-orders: - mmsi - imo - call_sign - ship_name - ship_type description: Basic information of the current vessel approach_data: type: array items: type: object properties: approach_ship: 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 ' required: - mmsi - imo - call_sign - ship_name - ship_type x-apifox-orders: - mmsi - imo - call_sign - ship_name - ship_type description: Basic information of the STS vessel approach_event: type: object properties: duration: type: number description: Total duration of the STS operation between two vessels, measured in minutes. approach_zone: type: integer description: 'STS operation area: 1=STS in port area; 2=STS at anchorage; 3=STS in other areas.' lat: type: number description: Latitude of the STS event position, under the WGS84 coordinate system lng: type: number description: Longitude of the STS event position, under the WGS84 coordinate system port_code: type: string description: 5-digit code of the corresponding port. Returned only when the STS event takes place in the port or anchorage area. sog: type: number description: Total duration of the STS operation between two vessels, measured in minutes. approach_time: type: integer description: Latitude of the STS event position, under the WGS84 coordinate system separation_time: type: integer description: End time of the STS event, represented as a Unix timestamp required: - approach_time - separation_time - duration - approach_zone - lat - lng - port_code - sog x-apifox-orders: - approach_time - separation_time - duration - approach_zone - lat - lng - port_code - sog description: Mooring Event Information required: - approach_ship - approach_event x-apifox-orders: - approach_ship - approach_event description: 'STS Data ' required: - ship_data - approach_data x-apifox-orders: - ship_data - approach_data required: - status - msg - data x-apifox-orders: - status - msg - data example: status: 0 msg: '' data: ship_data: mmsi: 477172700 imo: 9783538 call_sign: VRRV4 ship_name: COSCO SHIPPING LIBRA ship_type: 70 approach_data: - approach_ship: mmsi: 477947300 imo: 9493107 call_sign: VRKQ6 ship_name: CSB HERALD ship_type: 70 approach_event: approach_time: 1751260066 separation_time: 1751260429 duration: 6.05 approach_zone: 3 lat: 31.372347 lng: 121.689075 port_code: '' sog: 1.75 - approach_ship: mmsi: 413372190 imo: 1400704 call_sign: BPPZ ship_name: ZHONG HAI TUO 3 ship_type: 52 approach_event: approach_time: 1751260138 separation_time: 1751262848 duration: 45.17 approach_zone: 3 lat: 31.372347 lng: 121.689075 port_code: '' sog: 0.82 - approach_ship: mmsi: 413377870 imo: 1400704 call_sign: BPQJ ship_name: ZHONG HAI TUO 7 ship_type: 52 approach_event: approach_time: 1751260161 separation_time: 1751260467 duration: 5.1 approach_zone: 3 lat: 31.372347 lng: 121.689075 port_code: '' sog: 1.75 headers: {} x-apifox-name: success security: [] x-apifox-folder: 3 History Dataset x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-430352093-run operationId: getV1HistoryVesselStsEvents 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