openapi: 3.0.1 info: title: ShipFinder Global Maritime Data API description: 'REST/HTTP API for global AIS vessel tracking and maritime intelligence, organised into seven datasets: AIS (real-time vessel positioning, search, nearby, in-zone, flag), Voyage (port information, berthed/anchored vessels, expected arrivals), History (position tracks, ship-to-ship events, port-call records), Prediction (point-to-point and port-to-port route planning, ETA), Meteorology (tropical cyclones, tide gauge stations, marine weather), China Region Coastline Warnings, and Event (monitored fleet management, geofences and speed-alert subscriptions that drive push streams). All requests carry the API key as the "key" query parameter; all responses are JSON with a {status, msg, data} envelope where status 0 means success. Assembled by API Evangelist from the per-endpoint OpenAPI 3.0.1 fragments ShipFinder publishes on docs.shipfinder.com. Operation content is the provider''s; API Evangelist added operationIds, servers, securitySchemes, dataset tags, externalDocs, and remapped the published "0" response key to "200" (see overlays/).' version: 1.0.0 contact: name: ShipFinder Support email: support@elaneglobal.com url: https://www.shipfinder.com/help-center termsOfService: https://www.shipfinder.com/Home/TermsConditions externalDocs: description: Global Maritime Data API Documentation url: https://docs.shipfinder.com/ servers: - url: https://api.elaneglobal.com description: Production tags: - name: AIS Dataset - name: Event Dataset - name: History Dataset - name: Meteorology Dataset - name: Prediction Dataset - name: Voyage Dataset - name: China Coastline Warning Dataset security: - apiKeyQuery: [] paths: /v1/AIS/FleetPosition: get: summary: 1.1.3 Fleet Position deprecated: false description: '' tags: - AIS Dataset parameters: - name: key in: query description: fleet ID personal Shipfinder API key to verify service permissions required: true example: 1F6D701272402D1E7D8D316CCE519123 schema: type: string - name: fleet_id in: query description: 'All vessel positions under the fleet can be retrieved by the fleet ID maintained in the Dashboard. ' required: true example: 98f1f00a-d2d4-431b-90bf-d5471b184ff6 schema: type: string responses: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. content: application/json: schema: type: object properties: status: type: integer msg: type: string total: type: integer data: type: array items: type: object properties: fleet_id: type: string description: Your fleet ID 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_cnname: type: string description: Chinese name of the vessel data_source: type: string description: 0=Terrestrial AIS stations or Shipborne AIS; 1=Satellite AIS lat: type: number description: Coordinate latitude, WGS84 coordinate system lng: type: number description: Coordinate longitude, WGS84 coordinate system ship_type: type: integer length: type: number description: 'Vessel length in meters, valid value range: 0–1022' width: type: number description: Vessel breadth in meters (nautical standard term) left: type: number description: Port distance in meters trail: type: number description: Stern Distance in meters draught: type: number description: Vessel draught depth in meters dest: type: string description: Standardized destination port names, e.g., SINGAPORE, SG destcode: type: string description: Port code of the destination, e.g., SGSGP navistat: type: integer description: 0, Vessel navigation status; -1=invalid data 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 hdg: type: integer description: Vessel heading in degrees; 511=invalid data rot: type: number description: Rate of turn in degrees per minute last_time: type: integer description: AIS last update time in Unix timestamp eta: type: integer description: Estimated Time of Arrival in Unix timestamp required: - fleet_id - mmsi - imo - call_sign - ship_name - ship_cnname - data_source - last_time - lat - lng - ship_type - length - width - left - trail - draught - dest - destcode - eta - navistat - sog - cog - hdg - rot x-apifox-orders: - fleet_id - mmsi - imo - call_sign - ship_name - ship_cnname - data_source - last_time - lat - lng - ship_type - length - width - left - trail - draught - dest - destcode - eta - navistat - sog - cog - hdg - rot required: - status - msg - total - data x-apifox-orders: - status - msg - total - data example: status: 0 msg: '' total: 3 data: - fleet_id: 98f1f00a-d2d4-431b-90bf-d5471b184ff6 mmsi: 241673000 imo: 9852119 call_sign: SVDF6 ship_name: SEA EMERALD ship_cnname: '' data_source: 1 last_time: 1774950228 lat: 25.622803 lng: 53.367208 ship_type: 80 length: 336 width: 60 left: 31 trail: 55 draught: 20.4 dest: CNZNG destcode: '' eta: 1776283200 navistat: 0 sog: 0.7003891 cog: 286.1 hdg: 126 rot: -0.01 - fleet_id: 98f1f00a-d2d4-431b-90bf-d5471b184ff6 mmsi: 477985700 imo: 9308479 call_sign: VRDJ3 ship_name: DAPENG SUN ship_cnname: '' data_source: 1 last_time: 1774950155 lat: 21.452173 lng: 114.80732 ship_type: 80 length: 291 width: 43 left: 22 trail: 55 draught: 9.6 dest: CN DPGAU DAM destcode: '' eta: 1775660400 navistat: 0 sog: 16.2140083 cog: 178.8 hdg: 179 rot: 0 headers: {} x-apifox-name: success security: - apiKeyQuery: [] x-apifox-folder: 1 AIS Dataset/1.1 Vessel Position x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-430293359-run operationId: getFleetPosition externalDocs: description: 1.1.3 Fleet Position url: https://docs.shipfinder.com/430293359e0 /v1/AIS/VesselFlagInfo: get: summary: 1.5 Vessel Flag Information deprecated: false description: "## Description\nThe Vessel Flag Information queries the flag state (country/region) information\ \ of the matching vessel by the vessel’s MMSI number.\n\n## Use Case\n### Maritime Supervision\nUsing the\ \ vessel MMSI numbers obtained from area-based vessel search results or port berthing vessel lists, this\ \ service quickly matches the country/region of registration for the target vessels. It supports analysis\ \ of the proportion and operational behaviors of foreign vessels within the port or specific designated\ \ maritime areas.\n\n## Request Limits\nAn 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. \n\n## Endpoint\n| Endpoint | HTTP\ \ Method |\n|----------|-------------|\n| `https://api.elaneglobal.com/v1/AIS/VesselFlagInfo` | GET |\n\n\ ## Example API Call\nhttps://api.elaneglobal.com/v1/AIS/VesselFlagInfo?key=1F6D701272402D1E7D8D316CCE519123&mmsi=477172700\n\ \n\n**Note:** \nThe key 1F6D701272402D1E7D8D316CCE519123 is the official key of elaneglobal.com, bound\ \ to the domain api.elaneglobal.com. \nUsers 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.\nTo trial the service, please\ \ contact our support team: support@elaneglobal.com. " tags: - AIS 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 responses: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. 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 data: type: object properties: mmsi: type: integer description: 9-digit numeric code of MMSI registry: type: string description: Name of the vessel’s flag state (country/region) required: - mmsi - registry x-apifox-orders: - mmsi - registry required: - status - msg - data x-apifox-orders: - status - msg - data example: status: 0 msg: '' data: mmsi: 477172700 registry: Panama headers: {} x-apifox-name: success security: - apiKeyQuery: [] x-apifox-folder: 1 AIS Dataset x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-429919472-run operationId: getVesselFlagInfo externalDocs: description: 1.5 Vessel Flag Information url: https://docs.shipfinder.com/429919472e0 /v1/AIS/VesselPositionMulti: get: summary: 1.1.2 Multi-vessel Position deprecated: false description: ' ' tags: - AIS Dataset parameters: - name: key in: query description: Your personal Shipfinderer API key to verify service permissions required: true example: 1F6D701272402D1E7D8D316CCE519123 schema: type: string - name: mmsis in: query description: For Multi-Vessel Search, 9-digit MMSIs shall be separated by English commas, with a maximum of 100 vessels per search.
**Note:** The required parameter is MMSIs (plural form), not the singular MMSI. For multi-vessel search, requests will still be processed successfully even if invalid parameter content is submitted. However, only valid 9-digit MMSIs will be counted toward your usage credits, and invalid MMSIs will not be recorded as used credits. required: true example: 477232800,477172700 schema: type: string responses: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. content: application/json: schema: type: object properties: status: type: integer msg: type: string 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_cnname: type: string description: Chinese name of the vessel data_source: type: integer description: 0=Terrestrial AIS stations or Shipborne AIS; 1=Satellite AIS 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) left: type: number description: Port distance in meters trail: type: number description: Stern Distance in meters draught: type: number description: Vessel draught depth in meters dest: type: string description: Standardized destination port names, e.g., SINGAPORE, SG destcode: type: string description: Port code of the destination, e.g., SGSGP navistat: type: integer description: 0, Vessel navigation status; -1=invalid data lat: type: number description: Coordinate latitude, WGS84 coordinate system lng: 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 hdg: type: number description: Vessel heading in degrees; 511=invalid data rot: type: number description: Rate of turn in degrees per minute 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 - imo - call_sign - ship_name - ship_cnname - data_source - ship_type - length - width - left - trail - draught - dest - destcode - eta - navistat - lat - lng - sog - cog - hdg - rot - last_time x-apifox-orders: - mmsi - imo - call_sign - ship_name - ship_cnname - data_source - ship_type - length - width - left - trail - draught - dest - destcode - eta - navistat - lat - lng - sog - cog - hdg - rot - last_time required: - status - msg - data x-apifox-orders: - status - msg - data example: status: 0 msg: '' data: - mmsi: 477232800 imo: 9789647 call_sign: VRSG2 ship_name: COSCO PISCES ship_cnname: '' data_source: 1 ship_type: 100 length: 400 width: 59 left: 24 trail: 241 draught: 12.5 dest: 'ESVLC > SGSIN-PWBGA ' destcode: '' eta: 1775145600 navistat: 0 lat: 4.095627 lng: 92.529245 sog: 12.7 cog: 48.5 hdg: 49 rot: 0 last_time: 1774945102 - mmsi: 477172700 imo: 9783538 call_sign: VRRV4 ship_name: COSCO SHIPPING LIBRA ship_cnname: '' data_source: 1 ship_type: 100 length: 399 width: 59 left: 33 trail: 256 draught: 13 dest: SHANGHAI,CN destcode: CNSHG eta: 1776691800 navistat: 0 lat: -21.220912 lng: 6.866182 sog: 17.9 cog: 142.9 hdg: 143 rot: 0 last_time: 1774945234 headers: {} x-apifox-name: success security: - apiKeyQuery: [] x-apifox-folder: 1 AIS Dataset/1.1 Vessel Position x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-430292321-run operationId: getVesselPositionMulti externalDocs: description: 1.1.2 Multi-vessel Position url: https://docs.shipfinder.com/430292321e0 /v1/AIS/VesselPositionSingle: get: summary: 1.1.1 Single Vessel Position deprecated: false description: '' tags: - AIS Dataset parameters: - name: key in: query description: Your personal Shipfinder 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: '413149000' schema: type: string responses: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. 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 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_cnname: type: string description: Chinese name of the vessel data_source: type: integer description: 0=Terrestrial AIS stations or Shipborne AIS; 1=Satellite AIS 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) left: type: number description: Port distance in meters trail: type: number description: Stern Distance in meters draught: type: number description: Vessel draught depth in meters dest: type: string description: Standardized destination port names, e.g., SINGAPORE, SG destcode: type: string description: Port code of the destination, e.g., SGSGP eta: type: string description: 'Estimated Time of Arrival. Format: YYYY-MM-DD HH:MM:SS, UTC' navistat: type: integer description: 0, Vessel navigation status; -1=invalid data lat: type: number description: Coordinate latitude, WGS84 coordinate system lng: 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 hdg: type: number description: Vessel heading in degrees; 511=invalid data rot: type: number description: Rate of turn in degrees per minute last_time: type: integer description: AIS last update time in Unix timestamp required: - mmsi - imo - call_sign - ship_name - ship_cnname - data_source - ship_type - length - width - left - trail - draught - dest - destcode - eta - navistat - lat - lng - sog - cog - hdg - rot - last_time x-apifox-orders: - mmsi - imo - call_sign - ship_name - ship_cnname - data_source - ship_type - length - width - left - trail - draught - dest - destcode - eta - navistat - lat - lng - sog - cog - hdg - rot - last_time required: - status - msg - data x-apifox-orders: - status - msg - data example: status: 0 msg: '' data: mmsi: 413961925 imo: 0 call_sign: P ship_name: WANHONGYUAN369 ship_cnname: 皖鸿远369 data_source: 0 ship_type: 70 length: 68 width: 13 left: 8 trail: 18 draught: 4.8 dest: TAIZHOU,CN destcode: CNTZO eta: 1745827548 navistat: 0 lat: 32.192517 lng: 119.628093 sog: 6.2 cog: 80.8 hdg: 511 rot: 0 last_time: 1745827548 headers: {} x-apifox-name: success security: - apiKeyQuery: [] x-apifox-folder: 1 AIS Dataset/1.1 Vessel Position x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-428990613-run operationId: getVesselPositionSingle externalDocs: description: 1.1.1 Single Vessel Position url: https://docs.shipfinder.com/428990613e0 /v1/AIS/VesselSearch: get: summary: 1.2 Vessel Search deprecated: false description: "## Description\nThe Vessel Search API performs partial matching searches against keywords (MMSI,\ \ IMO Number, Vessel Name, Call Sign, etc.) to retrieve eligible vessel static records. It returns all historical\ \ MMSI records linked to a specified IMO Number, or information of all vessels that have ever used the given\ \ vessel name in history.\n\n**Note:** \nMaritime Mobile Service Identity (MMSI) is a 9-digit numeric code\ \ used in maritime radio communication systems for unique identification of individual and group call stations.\ \ Unique to each vessel, an MMSI code may be changed upon vessel sale; its first three digits indicate the\ \ country or region of registration. \nIMO Number (International Maritime Organization Number) is a unique\ \ 7-digit identifier assigned to each vessel by the International Maritime Organization, used for global\ \ tracking and administration of vessel identity, technical specifications and safety records.\n\n## Use\ \ Cases\nThis service is generally integrated into systems or platforms. Returned MMSI numbers can act as\ \ input parameters for Single Vessel Position Query and Vessel Historical Track Query, to retrieve real-time\ \ vessel position, operational status and historical voyage track. \nIf you have a defined vessel MMSI\ \ list, you may skip this service and use Single Vessel Position API or Multi-Vessel Position API directly\ \ for fleet monitoring and management.\n\n## Request Limits\nAn API key must be created before using this\ \ service. This API has no access frequency limits—unlimited calls are allowed once access permission is\ \ granted. To apply for or inquire about your access permission, please contact our support team: support@elaneglobal.com.\ \ \n\n## Endpoint\n| Endpoint | HTTP Method | Remarks |\n| --- | --- | --- |\n| `https://api.elaneglobal.com/v1/AIS/VesselSearch`\ \ | GET | When using partial matching with vessel name or IMO number, multiple results will be returned.\ \ You can distinguish them by referring to the latest AIS report time. Vessels may have their MMSI changed\ \ during ownership transfers or certain leasing processes. Old MMSI numbers will still be retained in records—filter\ \ them based on your specific use case. |\n\n## Example API Call\nhttps://api.elaneglobal.com/apicall/v3/VesselSearch?key=1F6D701272402D1E7D8D316CCE519123&keywords=DENEBLEADER&max=5\n\ Note:\nThe key 1F6D701272402D1E7D8D316CCE519123 is the official key of elaneglobal.com, bound to the domain\ \ api.elaneglobal.com. \nUsers 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.\nTo trial the service, please contact our\ \ support team: support@elaneglobal.com. " tags: - AIS 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 keywords for vessel query can be vessel name, call sign, MMSI, IMO, etc. \nMatching\ \ Rule: MMSI is a 9-digit code; IMO is a 7-digit code." required: true example: DENEB LEADER schema: type: string - name: max in: query description: The maximum number of results to return, with a maximum value of 100. required: false example: 5 schema: type: integer responses: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. content: application/json: schema: type: object properties: status: type: integer description: API call status code,0 means success title: Status code msg: type: string description: Exception prompt message title: Message total: type: integer title: Total description: Number of query results data: type: array items: type: object properties: match_type: type: integer description: "Type of keyword matching results, matching types: \n1=Ship name; 2=Call\ \ sign; 3=MMSI; 5=IMO " title: Match Type mmsi: type: integer title: 'MMSI Number ' description: 9-digit numeric code of MMSI imo: type: integer title: IMO number description: 7-digit numeric code of IMO call_sign: type: string title: 'Call Sign ' description: 'Call Sign ' ship_name: type: string title: 'Vessel Name ' description: Vessel name data_source: type: integer title: AIS Data Source description: "0=Terrestrial AIS stations or Shipborne AIS; \n1=Satellite AIS" last_time: type: integer title: Last Update Time (UTC) description: AIS last update time in Unix timestamp required: - match_type - mmsi - imo - call_sign - ship_name - data_source - last_time x-apifox-orders: - match_type - mmsi - imo - call_sign - ship_name - data_source - last_time required: - status - msg - total - data x-apifox-orders: - status - msg - total - data example: status: 0 msg: '' total: 3 data: - match_type: 1 mmsi: 356688000 imo: 9738777 call_sign: 3EKQ ship_name: DENEB LEADER data_source: 0 last_time: 1773728217 - match_type: 1 mmsi: 346559616 imo: 9738777 call_sign: 3EKQ ship_name: DENEB LEADER data_source: 0 last_time: 1772838361 - match_type: 1 mmsi: 525007112 imo: 0 call_sign: '' ship_name: DENEB LEADER data_source: 0 last_time: 1765181535 headers: {} x-apifox-name: success security: - apiKeyQuery: [] x-apifox-folder: 1 AIS Dataset x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-428749512-run operationId: getVesselSearch externalDocs: description: 1.2 Vessel Search url: https://docs.shipfinder.com/428749512e0 /v1/AIS/VesselsInZone: get: summary: 1.4 Vessels in Zone deprecated: false description: "## Description\nThe Vessels in Zone retrieves all AIS data of vessels within a specified geographic\ \ area in a single request. You may pass multiple latitude and longitude coordinates to define a custom\ \ polygonal search area.\n\nThe recommended area size for a single request is within 1°×1° to ensure full\ \ data return in one call; otherwise, you will need to make multiple requests with the scode token to fetch\ \ all vessel data in the target area.\n\nThe JSON format returns approximately 2,600 vessel records per\ \ response, while the binary format returns around 8,000 records. For large search areas, you may split\ \ the area into smaller subareas and request data sequentially, and use the scode token to retrieve remaining\ \ vessel data iteratively.\n\nWe also provide customized push services for Vessels in Zone, supporting integration\ \ via TCP/IP or Kafka. Please contact our support team for more information: support@elaneglobal.com\n\n\ ## Use Cases\n1. **Customs and Border Inspection Area Monitoring** \n Monitor all vessels in coastal\ \ or key designated areas, track the vessel watchlist, and oversee vessel operating behaviors.\n2. **Port\ \ Vessel Density Analysis** \n Define a zone near the port to capture all vessel information within the\ \ scope, filter vessels by category and destination port data, and analyze the vessel distribution density\ \ around the port.\n3. **Logistics Vessel Matching** \n Specify a zone around the departure port/warehouse,\ \ filter information and destination ports of all cargo vessels, and generate a shortlist of qualified cargo\ \ vessels by combining vessel profile queries, historical behavior, ETA and other datasets.\n\n## Request\ \ Limits\nAn 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. \n\n\n## Endpoint\n| Endpoint | HTTP Method | Remarks |\n|----------|-------------|---------|\n\ | `https://api.elaneglobal.com/v1/AIS/VesselsInZone` | GET | Vessels that have not reported AIS data for\ \ more than 2 hours will be excluded from the area-based search results, as their presence in the target\ \ area cannot be verified.TCP/IP custom push services can be customized to your actual needs, supporting\ \ multiple filtering rules: designated geographic area, vessel type/length, and custom dedicated fleet lists.\ \ Push frequency and returned data fields can also be defined as required. |\n\n## Example API call\nhttps://api.elaneglobal.com/v1/AIS/VesselsInZone?key=1F6D701272402D1E7D8D316CCE519123®ion=121.289063,35.424868-122.783203,35.281501-122.167969,33.979809&output=1\n\ \n\n**Note:** \nThe key 1F6D701272402D1E7D8D316CCE519123 is the official key of elaneglobal.com, bound\ \ to the domain api.elaneglobal.com.\nUsers 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.\nTo trial the service, please\ \ contact our support team: support@elaneglobal.com. " tags: - AIS Dataset parameters: - name: key in: query description: Your personal Shipfinderer API key to verify service permissions required: true example: 1F6D701272402D1E7D8D316CCE519123 schema: type: string - name: region in: query description: "Geographic area defined by coordinates. Longitude and latitude are separated by a comma; multiple\ \ coordinate points are separated by a hyphen. \nExample: lng,lat-lng,lat-lng,lat-lng,lat\nNote: \n1.\ \ Multiple coordinate points must be listed sequentially in clockwise or counterclockwise order.\n2. A\ \ minimum of 3 coordinate points is required; 2 points only form a straight line and cannot define a closed\ \ geographic area.\n3. Longitude must be entered before latitude for every coordinate pair.\n4. The queried\ \ geographic area shall not exceed the assigned permission scope.\n5. Within the authorized scope, users\ \ may split the target area into multiple smaller subareas to request data based on actual business scenarios." required: true example: 121.289063,35.424868-122.783203,35.281501-122.167969,33.979809 schema: type: string - name: output in: query description: 'Data output format selector: 0 = Binary data encoded in Base64 1 = JSON format Default value: 1' required: false example: 1 schema: type: integer - name: scode in: query description: "Session token for area-based vessel query . Used to retrieve remaining vessel data when the\ \ full dataset cannot be returned in a single request due to an oversized search area.\nNote: \n1. A single\ \ HTTP request returns a maximum of 2,666 vessel records. Use the scode returned from the initial query\ \ to fetch remaining data. The query region must remain unchanged; otherwise, a new query session will\ \ be generated.\n2. Check the continue field in the response. A value of 0 indicates all vessel data in\ \ the target area has been fully retrieved, and no additional requests are needed." required: false schema: type: integer responses: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. 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 data: type: object properties: total: type: integer description: "Number of vessel records returned in the current request only; does not represent\ \ the total number of vessels in the target area. \nFor large areas requiring multiple\ \ requests with the scode token, sum the total values of all requests to get the full\ \ vessel count of the area." scode: type: integer description: Session token for paginated data retrieval. If the full vessel data of the area cannot be returned in a single request, use the scode returned from the initial request to fetch the remaining vessel records until full data is obtained. continue: type: integer description: 'Flag indicating whether all vessel data in the area has been fully returned: 0= All data returned (query completed) 1= Partial data remaining (query not completed, continue requesting with scode)' ship_list: 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_cnname: type: string description: Chinese name of the vessel data_source: type: integer description: 0=Terrestrial AIS stations or Shipborne AIS; 1=Satellite AIS 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) left: type: number description: Port distance in meters trail: type: number description: Stern Distance in meters draught: type: number description: Vessel draught depth in meters dest: type: string description: Standardized destination port names, e.g., SINGAPORE, SG destcode: type: string description: Port code of the destination, e.g., SGSGP eta: type: string description: 'Estimated Time of Arrival.Format: YYYY-MM-DD HH:MM:SS, UTC' navistat: type: integer description: 0, Vessel navigation status; -1=invalid data lat: type: number description: Coordinate latitude, WGS84 coordinate system lng: 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 hdg: type: integer description: Vessel heading in degrees; 511=invalid data rot: type: integer description: Rate of turn in degrees per minute last_time: type: integer description: AIS last update time in Unix timestamp required: - mmsi - imo - call_sign - ship_name - ship_cnname - data_source - ship_type - length - width - left - trail - draught - dest - destcode - eta - navistat - lat - lng - sog - cog - hdg - rot - last_time x-apifox-orders: - mmsi - imo - call_sign - ship_name - ship_cnname - data_source - ship_type - length - width - left - trail - draught - dest - destcode - eta - navistat - lat - lng - sog - cog - hdg - rot - last_time description: Vessel List required: - total - scode - continue - ship_list x-apifox-orders: - total - scode - continue - ship_list required: - status - msg - data x-apifox-orders: - status - msg - data example: status: 0 msg: '' data: total: 54 scode: 20 continue: 0 ship_list: - mmsi: 370286000 imo: 9844100 call_sign: HOLO ship_name: SEA VICTORIA ship_cnname: '' data_source: 0 ship_type: 70 length: 340 width: 62 left: 36 trail: 51 draught: 12.7 dest: SINGAPORE,SG destcode: SGSIN eta: '1746547200' navistat: 0 lat: 34.606657 lng: 121.966072 sog: 12.8 cog: 111.4 hdg: 114 rot: 0 last_time: 1745904185 - mmsi: 412304788 imo: 0 call_sign: '' ship_name: SUGANYU04788 ship_cnname: 苏赣渔04788 data_source: 0 ship_type: 30 length: 0 width: 0 left: 0 trail: 0 draught: 0 dest: '' destcode: '' eta: '' navistat: 0 lat: 34.507535 lng: 121.96778 sog: 8.6 cog: 246.9 hdg: 511 rot: 0 last_time: 1745902562 headers: {} x-apifox-name: success security: - apiKeyQuery: [] x-apifox-folder: 1 AIS Dataset x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-429583708-run operationId: getVesselsInZone externalDocs: description: 1.4 Vessels in Zone url: https://docs.shipfinder.com/429583708e0 /v1/AIS/VesselsNearby: get: summary: 1.3 Vessels Nearby deprecated: false description: "## Description\nThe Vessels Nearby retrieves vessel data within a 10 nautical mile radius circular\ \ area centered on the position of a target vessel by querying the vessel’s MMSI. The returned vessel dataset\ \ is sorted by distance in ascending order (from nearest to farthest).\n\nThe response includes IMO number,\ \ call sign, vessel name , vessel type, length and breadth. It also contains the latest real time AIS updates:\ \ vessel position, navigation status, destination port, speed over ground, estimated time of arrival at\ \ the destination port, vessel heading, course over ground and other standard AIS parameters.\n\n## Use\ \ Cases\n1. **Offshore Construction Safety Monitoring** \n Centered on construction vessels, the service\ \ returns a list of vessels within a 10 nautical mile radius to monitor their positions and trajectories.\ \ If any vessel approaches the construction zone, the construction team can issue timely warnings or adjust\ \ construction plans accordingly.\n\n2. **Maritime Collision Avoidance Early Warning** \n Centered on\ \ underway vessels, the service monitors the positions and courses of nearby vessels to assess collision\ \ risks. If potential collision risks are detected, the vessel operator can implement immediate collision\ \ avoidance maneuvers.\n\n3. **Maritime Emergency Search and Rescue** \n Centered on distressed vessels,\ \ the service locates and coordinates nearby vessels to conduct search and rescue (SAR) operations.\n\n\ ## Request Limits\nAn 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. \n\n## Endpoint\n| Endpoint | HTTP Method |\n|----------|-------------|\n\ | `https://api.elaneglobal.com/v1/AIS/VesselsNearby` | GET |\n\n## Example API Call\nhttps://api.elaneglobal.com/v1/AIS/VesselsNearby?key=1F6D701272402D1E7D8D316CCE519123&mmsi=413881597\n\ \n**Note:** \nThe key 1F6D701272402D1E7D8D316CCE519123 is the official key of elaneglobal.com, bound to\ \ the domain api.elaneglobal.com.\nUsers 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.\nTo trial the service, please\ \ contact our support team: support@elaneglobal.com. " tags: - AIS 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: 413149000 schema: type: integer responses: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. 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 proximity vessels 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_cnname: type: string description: Chinese name of the vessel data_source: type: integer description: 0=Terrestrial AIS stations or Shipborne AIS; 1=Satellite AIS lat: type: number description: Coordinate latitude, WGS84 coordinate system lng: type: number description: Coordinate longitude, WGS84 coordinate system 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) left: type: number description: Port distance in meters trail: type: number description: Stern Distance in meters draught: type: number description: Vessel draught depth in meters dest: type: string description: Standardized destination port names, e.g., SINGAPORE, SG destcode: type: string description: Port code of the destination, e.g., SGSGP navistat: type: integer description: 0, Vessel navigation status; -1=invalid data 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 hdg: type: number description: Vessel heading in degrees; 511=invalid data rot: type: number description: Rate of turn in degrees per minute eta: type: integer description: Estimated Time of Arrival in Unix timestamp last_time: type: integer description: AIS last update time in Unix timestamp required: - mmsi - imo - call_sign - ship_name - data_source - last_time - lat - lng - ship_type - length - width - left - trail - draught - dest - destcode - eta - navistat - sog - cog - hdg - rot x-apifox-orders: - mmsi - imo - call_sign - ship_name - ship_cnname - data_source - last_time - lat - lng - ship_type - length - width - left - trail - draught - dest - destcode - eta - navistat - sog - cog - hdg - rot description: List of detailed proximity vessel data required: - status - msg - total - data x-apifox-orders: - status - msg - total - data example: status: 0 msg: '' total: 221 data: - mmsi: 413761246 imo: 0 call_sign: YR0 ship_name: PINGNANHONGSHUN3778 ship_cnname: 平南宏顺3778 data_source: 0 last_time: 1747292158 lat: 23.453682 lng: 110.52463 ship_type: 70 length: 81 width: 16 left: 10 trail: 5 draught: 4.3 dest: GUANGZHOU,CN destcode: CNGZG eta: 1744896600 navistat: 1 sog: 0 cog: 0 hdg: 0 rot: 0 - mmsi: 413761521 imo: 0 call_sign: YR7 ship_name: PINGNANRONGDA333 ship_cnname: 平南荣达333 data_source: 0 last_time: 1747292207 lat: 23.472812 lng: 110.50188 ship_type: 70 length: 82 width: 16 left: 7 trail: 9 draught: 1.2 dest: 'XZ ' destcode: '' eta: 1748394000 navistat: 1 sog: 0 cog: 0 hdg: 0 rot: 0 - mmsi: 413762746 imo: 0 call_sign: JKKKJK ship_name: GUIPINGHANGKAI3358 ship_cnname: 桂平航凯3358 data_source: 0 last_time: 1747292077 lat: 23.468075 lng: 110.513635 ship_type: 70 length: 61 width: 13 left: 7 trail: 8 draught: 0 dest: '' destcode: '' eta: 0 navistat: 255 sog: 0 cog: 18.2 hdg: 511 rot: -2.77 headers: {} x-apifox-name: success security: - apiKeyQuery: [] x-apifox-folder: 1 AIS Dataset x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-429003024-run operationId: getVesselsNearby externalDocs: description: 1.3 Vessels Nearby url: https://docs.shipfinder.com/429003024e0 /v1/Event/AddFleet: post: summary: 7.1.1 Create Fleet deprecated: false description: "**Endpoint**\n| Endpoint | HTTP Method |\n| --- | --- |\n| `https://api.elaneglobal.com/v1/Event/AddFleet`\ \ | Post |\n\n**Example API Call**\n\nhttps://api.elaneglobal.com/v1/Event/AddFleet?key=1F6D701272402D1E7D8D316CCE519123&fleet_name=myfleet123&mmsis=477985700,412751690&monitor=6\n\ \n**Note:** \n- The key `1F6D701272402D1E7D8D316CCE519123` is the official key of Shipfinder.com, bound\ \ to the domain api.shipfinder.com. \n- 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. \n- To trial the service,\ \ please create your own key in the Dashboard.\n\n\nNote:\nEach monitoring type selected in the monitor\ \ field requires corresponding permissions to be enabled first.If you lack the required permissions, the\ \ system will return:\"You do not have access permission\".\nIf your services are already activated but\ \ the number of monitored vessels exceeds your permitted quota, the system will return:\"The number of queryable\ \ vessels exceeds the limit\".\nYou may check your current permission quota in the Permission section of\ \ the dashboard. To upgrade your services or expand your vessel monitoring quota, please contact our support\ \ team." tags: - Event Dataset parameters: [] requestBody: content: application/json: schema: type: object properties: key: type: string description: Your personal Shipfinderer API key to verify service permissions. fleet_name: type: string description: Unique identifier for the fleet, used for subsequent maintenance of fleet information. mmsis: type: string description: Add vessels to the fleet. Enter multiple MMSI numbers separated by commas. monitor: type: string description: 'Specifies the monitoring content for the fleet. 1 = Fleet Vessel Query 2 = Real-time Vessel Position Push 3 = Vessel Arrival/Departure Event Push 4 = Dynamic ETA Push 5 = AIS Abnormal Event Push 6 = Geofence Monitoring Push 7 = Vessel Alongside Event Push Separate multiple values by commas.' required: - key - fleet_name - mmsis - monitor x-apifox-orders: - key - fleet_name - mmsis - monitor - 01KMD0YYBXC401EWT6S1717M4X example: key: 1F6D701272402D1E7D8D316CCE519123 fleet_name: myfleet123 mmsis: 477985700,412751690 monitor: '6' responses: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. content: application/json: schema: type: object properties: status: type: integer msg: type: string data: type: object properties: fleet_id: type: string description: Unique identifier for the fleet, used for subsequent maintenance of fleet information. fleet_name: type: string description: Add vessels to the fleet. Enter multiple MMSI numbers separated by commas. mmsis: type: string description: Vessels MMSIs to be managed under the fleet. monitor: type: string description: Monitored content associated with the fleet; can be modified via the Update Fleet Information API or the Dashboard. required: - fleet_id - fleet_name - mmsis - monitor x-apifox-orders: - fleet_id - fleet_name - mmsis - monitor required: - status - msg - data x-apifox-orders: - status - msg - data example: status: 0 msg: '' data: fleet_id: 3f2062c6-b796-4a03-b923-48628794dd86 fleet_name: 自有船队在途监控 mmsis: 412751690,477985700 monitor: '6' headers: {} x-apifox-name: success security: - apiKeyQuery: [] x-apifox-folder: 7 Event Dataset/7.1 Monitored Fleet Management x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-432035260-run operationId: postAddFleet externalDocs: description: 7.1.1 Create Fleet url: https://docs.shipfinder.com/432035260e0 /v1/Event/AddGeofence: post: summary: 7.2.1 Geofence Creation deprecated: false description: '' tags: - Event Dataset parameters: [] requestBody: content: application/json: schema: type: object properties: key: type: string description: Your personal Shipfinderer API key to verify service permissions area_bounds: type: string description: 'Longitude and latitude separated by comma, multiple points separated by hyphen. Format: lng,lat-lng,lat-lng,lat. Multiple coordinate points must be entered clockwise or counter-clockwise order.' area_name: type: string description: Name of the created geofence, used for later query and identification. filter_type: type: string description: 'Monitoring filter type for the geofence: 1=All vessels; 2=Filter by vessel type and length; 3=Fleet vessels - For value 1: Vessel type, length and fleet ID are optional and will be ignored if provided. - For value 2: Vessel type and vessel length are required. - For value 3: Fleet ID is required.' fleet_id: type: string description: Fleet to be monitored by the geofence.You may create a fleet to monitor entry/exit of one or more vessels in the area.If fleet_id is provided, only vessels in the fleet are monitored; ship_type will be ignored. url: type: string description: URL to which data is pushed when a monitoring condition is triggered. ship_type: type: string description: Vessel type used for filtering and monitoring.Multiple types separated by a comma. Leave empty to include all types. See Appendix for vessel type list. length: type: string description: 'The vessel length range is used for filtering and monitoring. Multiple values separated by a comma. Leave empty to include all lengths. 1=0–40m 2=40–80m 3=80–160m 4=160–240m 5=240–320m 6=Above 320m' required: - key - area_bounds - area_name - filter_type - url x-apifox-orders: - key - area_bounds - area_name - filter_type - url - ship_type - length - fleet_id example: key: 1F6D701272402D1E7D8D316CCE519123 area_bounds: 119.846180,32.345143-119.814280,32.311867-119.4661,32.291067-119.375887,32.213847 area_name: area-1 filter_type: '3' fleet_id: 3f2062c6-b796-4a03-b923-48628794dd86 url: http://192.186.1.1:8000/shipxy/testdemo responses: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. content: application/json: schema: type: object properties: status: type: string msg: type: string data: type: object properties: area_id: type: string description: Unique identifier of the geofence, used for subsequent query, update and deletion operations. x-apifox-orders: - area_id required: - area_id x-apifox-orders: - status - msg - data required: - status - msg - data headers: {} x-apifox-name: success security: - apiKeyQuery: [] x-apifox-folder: 7 Event Dataset/7.2 Geofence Monitoring Push x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-433382008-run operationId: postAddGeofence externalDocs: description: 7.2.1 Geofence Creation url: https://docs.shipfinder.com/433382008e0 /v1/Event/AddVesselSpeedAlert: post: summary: 7.3.1 Add Vessel Speed Alert Subscription deprecated: false description: '' tags: - Event Dataset parameters: [] requestBody: content: application/json: schema: type: object properties: key: type: string description: Your personal Shipfinderer API key to verify service permissions mmsi: type: string description: Enter multiple MMSI numbers separated by commas. speed_limit: type: string description: 'Value format: 3-18, Min speed – Max speed, in knots. Separate the range with “-”. A push alert will be triggered after the vessel’s speed stays outside the allowed range for a continuous period. The alert is pushed only once when the speed is out of range. The next alert will be triggered only after the vessel returns to the allowed range and then exceeds it again. Min speed ≥ 0, max speed ≤ 50.' speed_duration: type: string description: "Speed duration in minutes. \nSet the trigger duration for the speed alert. Default\ \ value=5 minutes. A push alert is triggered when the vessel’s speed remains outside the configured\ \ range for the specified duration.\nNote: An excessively short duration may not work. For example,\ \ if speed duration is set to 0.1 minutes, no alert can be generated if AIS does not report\ \ position and speed information within that time window." x-apifox-orders: - key - mmsi - speed_limit - speed_duration required: - key - mmsi - speed_limit - speed_duration examples: {} responses: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. content: application/json: schema: type: object properties: status: type: integer msg: type: string x-apifox-orders: - status - msg required: - status - msg headers: {} x-apifox-name: success security: - apiKeyQuery: [] x-apifox-folder: 7 Event Dataset/7.3 Vessel Speed Alert Push x-apifox-status: developing x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-433460139-run operationId: postAddVesselSpeedAlert externalDocs: description: 7.3.1 Add Vessel Speed Alert Subscription url: https://docs.shipfinder.com/433460139e0 /v1/Event/AddVesselToFleet: post: summary: 7.1.5 Add Vessels to Fleet deprecated: false description: "**Endpoint**\n| Endpoint | HTTP Method |\n| --- | --- |\n|`https://api.elaneglobal.com/v1/Event/AddVesselToFleet`\ \ | Post |\n\n**Example API Call**\n\nhttps://api.elaneglobal.com/v1/Event/AddVesselToFleet?key=1F6D701272402D1E7D8D316CCE519123&fleet_id=3f2062c6-b796-4a03-b923-48628794dd86&mmsis=413983657\n\ \n**Note:** \n- The key `1F6D701272402D1E7D8D316CCE519123` is the official key of Shipfinder.com, bound\ \ to the domain api.shipfinder.com. \n- 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. \n- To trial the service,\ \ please create your own key in the Dashboard. New users receive a complimentary usage quota upon API key\ \ creation.\n\n**Note:** When adding vessels to a fleet, the system will validate your vessel monitoring\ \ quota. If the total number of vessels exceeds your permitted limit, the system will return the error:\ \ \"The number of vessels exceeds the permission limit.\" You may add an unlimited number of vessels to\ \ a fleet that has no monitoring permissions bound (this option is available when creating fleets via the\ \ dashboard). However, such fleets will not support any query or monitoring functions. The same quota validation\ \ will apply if you bind monitoring permissions to this fleet at a later stage, and the same over-limit\ \ error will be triggered if applicable. |" tags: - Event Dataset parameters: [] requestBody: content: application/json: schema: type: object properties: key: type: string description: Your personal Shipfinderer API key to verify service permissions fleet_id: type: string description: Unique identifier for the fleet, used for subsequent maintenance of fleet information. mmsis: type: string description: Add vessels to the fleet. Enter multiple MMSI numbers separated by commas. This is an incremental update that does not modify existing vessels in the fleet.Duplicate MMSI numbers will be ignored and not added again. required: - key - fleet_id - mmsis x-apifox-orders: - key - fleet_id - mmsis example: key: 1F6D701272402D1E7D8D316CCE519123 fleet_id: 3f2062c6-b796-4a03-b923-48628794dd86 mmsis: '413983657' responses: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. content: application/json: schema: type: object properties: status: type: integer msg: type: string data: type: object properties: fleet_id: type: string description: Unique identifier for the fleet, used for subsequent maintenance of fleet information. fleet_name: type: string description: Add vessels to the fleet. Enter multiple MMSI numbers separated by commas. mmsis: type: string description: Vessels MMSIs to be managed under the fleet. monitor: type: string description: Monitored content associated with the fleet; can be modified via the Update Fleet Information API or the Dashboard. required: - fleet_id - fleet_name - mmsis - monitor x-apifox-orders: - fleet_id - fleet_name - mmsis - monitor required: - status - msg - data x-apifox-orders: - status - msg - data example: status: 0 msg: '' data: fleet_id: 3f2062c6-b796-4a03-b923-48628794dd86 fleet_name: myfleet123 mmsis: 412751690,413983657,477985700 monitor: '6' headers: {} x-apifox-name: success security: - apiKeyQuery: [] x-apifox-folder: 7 Event Dataset/7.1 Monitored Fleet Management x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-432100231-run operationId: postAddVesselToFleet externalDocs: description: 7.1.5 Add Vessels to Fleet url: https://docs.shipfinder.com/432100231e0 /v1/Event/DeleteFleet: post: summary: '7.1.4 Delete Fleet ' deprecated: false description: "**Endpoint**\n| Endpoint | HTTP Method |\n| --- | --- |\n|`https://api.elaneglobal.com/v1/Event/DeleteFleet`\ \ | Post |\n\n**Example API Call**\n\nhttps://api.elaneglobal.com/v1/Event/DeleteFleet?key=1F6D701272402D1E7D8D316CCE519123&fleet_id=3f2062c6-b796-4a03-b923-48628794dd86\n\ \n**Note:** \n- The key `1F6D701272402D1E7D8D316CCE519123` is the official key of Shipfinder.com, bound\ \ to the domain api.shipfinder.com. \n- 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. \n- To trial the service,\ \ please create your own key in the Dashboard. New users receive a complimentary usage quota upon API key\ \ creation.\n\n**Note:** \nAfter a fleet is deleted, all related push services will stop including data\ \ from this fleet, including: fleet vessel queries, real-time position push, arrival/departure event push,\ \ ETA push, and AIS event push. If no other fleets remain bound to the push service, no further messages\ \ will be pushed. \nThe geofence alert push follows a different logic: if the bound fleet is deleted, the\ \ system will push alerts for all vessels entering or exiting the geofence. To modify geofence alerts, you\ \ must bind a new fleet or set new filters. To disable geofence alerts entirely, you must delete the geofence." tags: - Event Dataset parameters: - name: key in: query description: Your personal Shipfinderer API key to verify service permissions required: true example: 1F6D701272402D1E7D8D316CCE519123 schema: type: string - name: fleet_id in: query description: Unique identifier for the fleet, used for subsequent maintenance of fleet information. required: true example: 3f2062c6-b796-4a03-b923-48628794dd86 schema: type: string responses: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. content: application/json: schema: type: object properties: status: type: integer msg: type: string data: type: object properties: fleet_id: type: string description: Unique identifier for the fleet, used for subsequent maintenance of fleet information. fleet_name: type: string description: Add vessels to the fleet. Enter multiple MMSI numbers separated by commas. mmsis: type: string description: Vessels MMSIs to be managed under the fleet. monitor: type: string description: Monitored content associated with the fleet; can be modified via the Update Fleet Information API or the Dashboard. required: - fleet_id - fleet_name - mmsis - monitor x-apifox-orders: - fleet_id - fleet_name - mmsis - monitor required: - status - msg - data x-apifox-orders: - status - msg - data example: status: 0 msg: '' data: fleet_id: 3f2062c6-b796-4a03-b923-48628794dd86 fleet_name: 自有船队在途监控 mmsis: 413983657,412751690 monitor: '6' headers: {} x-apifox-name: success security: - apiKeyQuery: [] x-apifox-folder: 7 Event Dataset/7.1 Monitored Fleet Management x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-432076110-run operationId: postDeleteFleet externalDocs: description: 7.1.4 Delete Fleet url: https://docs.shipfinder.com/432076110e0 /v1/Event/DeleteFleetVessel: post: summary: 7.1.7 Remove Vessels from Fleet deprecated: false description: "**Endpoint**\n| Endpoint | HTTP Method |\n| --- | --- |\n| https://api.elaneglobal.com/v1/Event/DeleteFleetVessel\ \ | Post |\n\n**Example API Call**\n\nhttps://api.elaneglobal.com/v1/Event/DeleteFleetVessel?key=1F6D701272402D1E7D8D316CCE519123&fleet_id=3f2062c6-b796-4a03-b923-48628794dd86&mmsis=413461440\n\ \n**Note:** \n- The key `1F6D701272402D1E7D8D316CCE519123` is the official key of Shipfinder.com, bound\ \ to the domain api.shipfinder.com. \n- 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. \n- To trial the service,\ \ please create your own key in the Dashboard. New users receive a complimentary usage quota upon API key\ \ creation." tags: - Event Dataset parameters: [] requestBody: content: application/json: schema: type: object properties: key: type: string description: Your personal Shipfinderer API key to verify service permissions fleet_id: type: string description: Unique identifier for the fleet, used for subsequent maintenance of fleet information. mmsis: type: string description: Add vessels to the fleet. Enter vessel MMSI numbers separated by commas. Removes one or more vessels from the fleet. Only vessels already present in the fleet will be deleted; invalid or non-existent MMSIs will not affect other vessels. required: - key - fleet_id - mmsis x-apifox-orders: - key - fleet_id - mmsis example: key: 1F6D701272402D1E7D8D316CCE519123 fleet_id: 3f2062c6-b796-4a03-b923-48628794dd86 mmsis: '413461440' responses: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. content: application/json: schema: type: object properties: status: type: integer msg: type: string data: type: object properties: fleet_id: type: string description: Unique identifier for the fleet, used for subsequent maintenance of fleet information. fleet_name: type: string description: Unique identifier for the fleet, used for subsequent maintenance of fleet information. mmsis: type: string description: Vessels MMSIs to be managed under the fleet. monitor: type: string description: Monitored content associated with the fleet; can be modified via the Update Fleet Information API or the Dashboard. required: - fleet_id - fleet_name - mmsis - monitor x-apifox-orders: - fleet_id - fleet_name - mmsis - monitor required: - status - msg - data x-apifox-orders: - status - msg - data example: status: 0 msg: '' data: fleet_id: 3f2062c6-b796-4a03-b923-48628794dd86 fleet_name: 自有船队在途监控 mmsis: 413983657,412751690 monitor: '6' headers: {} x-apifox-name: success security: - apiKeyQuery: [] x-apifox-folder: 7 Event Dataset/7.1 Monitored Fleet Management x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-432106004-run operationId: postDeleteFleetVessel externalDocs: description: 7.1.7 Remove Vessels from Fleet url: https://docs.shipfinder.com/432106004e0 /v1/Event/DeleteGeofence: delete: summary: 7.2.4 Geofence Deletion deprecated: false description: '' tags: - Event Dataset parameters: [] requestBody: content: application/json: schema: type: object properties: key: type: string description: Your personal Shipfinderer API key to verify service permissions area_id: type: string description: Unique identifier of the geofence, used for subsequent query, update and deletion operations. required: - key - area_id x-apifox-orders: - key - area_id example: key: 1F6D701272402D1E7D8D316CCE519123 area_id: 65a03820-31dd-4db6-afd4-9517b81f94e1 responses: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. content: application/json: schema: title: '' type: object properties: status: type: integer msg: type: string x-apifox-orders: - status - msg required: - status - msg headers: {} x-apifox-name: success security: - apiKeyQuery: [] x-apifox-folder: 7 Event Dataset/7.2 Geofence Monitoring Push x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-433422419-run operationId: deleteGeofence externalDocs: description: 7.2.4 Geofence Deletion url: https://docs.shipfinder.com/433422419e0 /v1/Event/DeleteVesselSpeedAlert: post: summary: 7.3.2 Delete Vessel Speed Alert Subscription deprecated: false description: '' tags: - Event Dataset parameters: [] requestBody: content: application/json: schema: type: object properties: key: type: string description: Your personal Shipfinderer API key to verify service permissions mmsi: type: string description: MMSI numbers of monitored vessels. x-apifox-orders: - key - mmsi required: - key - mmsi examples: {} responses: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. content: application/json: schema: title: '' type: object properties: status: type: integer msg: type: string x-apifox-orders: - status - msg required: - status - msg headers: {} x-apifox-name: success security: - apiKeyQuery: [] x-apifox-folder: 7 Event Dataset/7.3 Vessel Speed Alert Push x-apifox-status: developing x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-433471968-run operationId: postDeleteVesselSpeedAlert externalDocs: description: 7.3.2 Delete Vessel Speed Alert Subscription url: https://docs.shipfinder.com/433471968e0 /v1/Event/GetFleet: get: summary: 7.1.3 Query Fleet deprecated: false description: "**Endpoint**\n| Endpoint | HTTP Method |\n| --- | --- |\n| `https://api.elaneglobal.com/v1/Event/GetFleet`\ \ | Get |\n\n**Example API Call**\n\nhttps://api.elaneglobal.com/v1/Event/GetFleet?key=1F6D701272402D1E7D8D316CCE519123&fleet_id=3f2062c6-b796-4a03-b923-48628794dd86\n\ \n**Note:** \n- The key `1F6D701272402D1E7D8D316CCE519123` is the official key of Shipfinder.com, bound\ \ to the domain api.shipfinder.com. \n- 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. \n- To trial the service,\ \ please create your own key in the Dashboard. New users receive a complimentary usage quota upon API key\ \ creation.\n" tags: - Event Dataset parameters: - name: key in: query description: '' required: true example: 1F6D701272402D1E7D8D316CCE519123 schema: type: string - name: fleet_id in: query description: '' required: true example: 3f2062c6-b796-4a03-b923-48628794dd86 schema: type: string responses: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. content: application/json: schema: type: object properties: status: type: integer msg: type: string data: type: object properties: fleet_id: type: string description: Unique identifier for the fleet, used for subsequent maintenance of fleet information. fleet_name: type: string description: Add vessels to the fleet. Enter multiple MMSI numbers separated by commas. mmsis: type: string description: Vessels MMSIs to be managed under the fleet. monitor: type: string description: Monitored content associated with the fleet; can be modified via the Update Fleet Information API or the Dashboard. required: - fleet_id - fleet_name - mmsis - monitor x-apifox-orders: - fleet_id - fleet_name - mmsis - monitor required: - status - msg - data x-apifox-orders: - status - msg - data headers: {} x-apifox-name: success security: - apiKeyQuery: [] x-apifox-folder: 7 Event Dataset/7.1 Monitored Fleet Management x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-432057101-run operationId: getFleet externalDocs: description: 7.1.3 Query Fleet url: https://docs.shipfinder.com/432057101e0 /v1/Event/GetGeofence: get: summary: 7.2.3 Geofence Query deprecated: false description: '' tags: - Event Dataset parameters: - name: key in: query description: Your personal Shipfinderer API key to verify service permissions required: true example: 1F6D701272402D1E7D8D316CCE519123 schema: type: string - name: area_id in: query description: Unique identifier of the geofence, used for subsequent query, update and deletion operations. required: true example: 65a03820-31dd-4db6-afd4-9517b81f94e1 schema: type: string responses: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. content: application/json: schema: title: '' type: object properties: status: type: integer msg: type: string data: type: object properties: area_id: type: string description: Unique identifier of the geofence, used for subsequent query, update and deletion operations. area_bounds: type: string description: 'Longitude and latitude separated by comma, multiple points separated by hyphen. Format: lng,lat-lng,lat-lng,lat. Multiple coordinate points must be entered clockwise or counter-clockwise order.' area_name: type: string description: Name of the created geofence, used for later query and identification. url: type: string description: URL to which data is pushed when a monitoring condition is triggered. filter_type: type: integer description: 'Monitoring filter type for the geofence: 1=All vessels; 2=Filter by vessel type and length; 3=Fleet vessels - For value 1: Vessel type, length and fleet ID are optional and will be ignored if provided. - For value 2: Vessel type and vessel length are required. - For value 3: Fleet ID is required.' ship_type: type: string description: Vessel type used for filtering and monitoring.Multiple types separated by a comma. Leave empty to include all types. See Appendix for vessel type list. length: type: string description: 'The vessel length range is used for filtering and monitoring. Multiple values separated by a comma. Leave empty to include all lengths. 1=0–40m 2=40–80m 3=80–160m 4=160–240m 5=240–320m 6=Above 320m' fleet_id: type: string description: Fleet to be monitored by the geofence.You may create a fleet to monitor entry/exit of one or more vessels in the area.If fleet_id is provided, only vessels in the fleet are monitored; ship_type will be ignored. x-apifox-orders: - area_id - area_bounds - area_name - url - filter_type - ship_type - length - fleet_id required: - area_id - area_bounds - area_name - url - filter_type - ship_type - length - fleet_id x-apifox-orders: - status - msg - data required: - status - msg - data headers: {} x-apifox-name: success security: - apiKeyQuery: [] x-apifox-folder: 7 Event Dataset/7.2 Geofence Monitoring Push x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-433414777-run operationId: getGeofence externalDocs: description: 7.2.3 Geofence Query url: https://docs.shipfinder.com/433414777e0 /v1/Event/UpdateFleetInfo: post: summary: 7.1.2 Update Fleet Information deprecated: false description: "**Endpoint**\n| Endpoint | HTTP Method |\n| --- | --- |\n| `https://api.elaneglobal.com/v1/Event/UpdateFleetInfo`\ \ | Post |\n\n**Example API Call**\n\nhttps://api.elaneglobal.com/v1/Event/UpdateFleetInfo?key=1F6D701272402D1E7D8D316CCE519123&fleet_id=3f2062c6-b796-4a03-b923-48628794dd86&mmsis=477985700&monitor=5\n\ \n**Note:** \n- The key `1F6D701272402D1E7D8D316CCE519123` is the official key of Shipfinder.com, bound\ \ to the domain api.shipfinder.com. \n- 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. \n- To trial the service,\ \ please create your own key in the Dashboard. New users receive a complimentary usage quota upon API key\ \ creation.\n\nNote:\nWhen updating fleet information, the submitted data will overwrite the existing records\ \ entirely, not incrementally. Please use this operation with caution, especially for the vessel list and\ \ monitoring content." tags: - Event Dataset parameters: [] requestBody: content: application/json: schema: type: object properties: key: type: string description: Your personal Shipfinderer API key to verify service permissions fleet_id: type: string description: Your personal Shipfinderer API key to verify service permissions mmsis: type: string description: Batch Update of Fleet Vessels. Enter vessel MMSI numbers separated by commas. This is a full overwrite update with no incremental addition or removal of individual vessels. monitor: type: string description: 'Update monitoring content for the fleet. 1 = Fleet Vessel Query 2 = Real-time Vessel Position Push 3 = Vessel Arrival/Departure Event Push 4 = Dynamic ETA Push 5 = AIS Abnormal Event Push 6 = Geofence Monitoring Push 7 = Vessel Alongside Event Push Separate multiple values by commas. This is a full overwrite update; no incremental addition or removal is performed.' fleet_name: type: string description: Enter a name to update the fleet name. required: - key - fleet_id - mmsis - monitor - fleet_name x-apifox-orders: - key - fleet_id - mmsis - monitor - fleet_name example: key: 1F6D701272402D1E7D8D316CCE519123 fleet_id: 3f2062c6-b796-4a03-b923-48628794dd86 mmsis: '477985700' monitor: '5' responses: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. content: application/json: schema: type: object properties: status: type: integer msg: type: string data: type: object properties: fleet_id: type: string description: Unique identifier for the fleet, used for subsequent maintenance of fleet information. fleet_name: type: string description: Add vessels to the fleet. Enter multiple MMSI numbers separated by commas. mmsis: type: string description: Vessels MMSIs to be managed under the fleet. monitor: type: string description: Monitored content associated with the fleet; can be modified via the Update Fleet Information API or the Dashboard. required: - fleet_id - fleet_name - mmsis - monitor x-apifox-orders: - fleet_id - fleet_name - mmsis - monitor required: - status - msg - data x-apifox-orders: - status - msg - data example: status: 0 msg: '' data: fleet_id: 3f2062c6-b796-4a03-b923-48628794dd86 fleet_name: 自有船队在途监控 mmsis: 412751690,477985700 monitor: '4' headers: {} x-apifox-name: success security: - apiKeyQuery: [] x-apifox-folder: 7 Event Dataset/7.1 Monitored Fleet Management x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-432048484-run operationId: postUpdateFleetInfo externalDocs: description: 7.1.2 Update Fleet Information url: https://docs.shipfinder.com/432048484e0 /v1/Event/UpdateFleetVessel: post: summary: 7.1.6 Batch Update Vessels in Fleet deprecated: false description: "**Endpoint**\n| Endpoint | HTTP Method |\n| --- | --- |\n| `https://api.elaneglobal.com/v1/Event/UpdateFleetVessel`\ \ | Post |\n\n**Example API Call**\n\nhttps://api.elaneglobal.com/v1/Event/UpdateFleetVessel?key=1F6D701272402D1E7D8D316CCE519123&fleet_id=3f2062c6-b796-4a03-b923-48628794dd86&mmsis=413461440,412751690,413983657\n\ \n**Note:** \n- The key `1F6D701272402D1E7D8D316CCE519123` is the official key of Shipfinder.com, bound\ \ to the domain api.shipfinder.com. \n- 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. \n- To trial the service,\ \ please create your own key in the Dashboard. New users receive a complimentary usage quota upon API key\ \ creation." tags: - Event Dataset parameters: [] requestBody: content: application/json: schema: type: object properties: key: type: string description: Your personal Shipfinderer API key to verify service permissions fleet_id: type: string description: Unique identifier for the fleet, used for subsequent maintenance of fleet information. mmsis: type: string description: Add vessels to the fleet. Enter vessel MMSI numbers separated by commas. This is a full overwrite update with no incremental addition or removal of individual vessels. required: - key - fleet_id - mmsis x-apifox-orders: - key - fleet_id - mmsis example: key: 1F6D701272402D1E7D8D316CCE519123 fleet_id: 3f2062c6-b796-4a03-b923-48628794dd86 mmsis: 413461440,412751690,413983657 responses: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. content: application/json: schema: type: object properties: status: type: integer msg: type: string data: type: object properties: fleet_id: type: string description: Unique identifier for the fleet, used for subsequent maintenance of fleet information. fleet_name: type: string description: Add vessels to the fleet. Enter multiple MMSI numbers separated by commas. mmsis: type: string description: Vessels MMSIs to be managed under the fleet. monitor: type: string description: Monitored content associated with the fleet; can be modified via the Update Fleet Information API or the Dashboard. required: - fleet_id - fleet_name - mmsis - monitor x-apifox-orders: - fleet_id - fleet_name - mmsis - monitor required: - status - msg - data x-apifox-orders: - status - msg - data example: status: 0 msg: '' data: fleet_id: 3f2062c6-b796-4a03-b923-48628794dd86 fleet_name: myfleet123 mmsis: 413983657,413461440,412751690 monitor: '6' headers: {} x-apifox-name: success security: - apiKeyQuery: [] x-apifox-folder: 7 Event Dataset/7.1 Monitored Fleet Management x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-432080706-run operationId: postUpdateFleetVessel externalDocs: description: 7.1.6 Batch Update Vessels in Fleet url: https://docs.shipfinder.com/432080706e0 /v1/Event/UpdateGeofence: post: summary: 7.2.2 Geofence Update deprecated: false description: '' tags: - Event Dataset parameters: [] requestBody: content: application/json: schema: type: object properties: key: type: string description: Your personal Shipfinderer API key to verify service permissions area_id: type: string description: Unique identifier of the geofence, used for subsequent query, update and deletion operations. area_bounds: type: string description: 'Longitude and latitude separated by comma, multiple points separated by hyphen. Format: lng,lat-lng,lat-lng,lat. Multiple coordinate points must be entered clockwise or counter-clockwise order.' area_name: type: string description: Name of the created geofence, used for later query and identification. filter_type: type: string description: 'Monitoring filter type for the geofence: 1=All vessels; 2=Filter by vessel type and length; 3=Fleet vessels - For value 1: Vessel type, length and fleet ID are optional and will be ignored if provided. - For value 2: Vessel type and vessel length are required. - For value 3: Fleet ID is required.' fleet_id: type: string description: Fleet to be monitored by the geofence.You may create a fleet to monitor entry/exit of one or more vessels in the area.If fleet_id is provided, only vessels in the fleet are monitored; ship_type will be ignored. url: type: string description: URL to which data is pushed when a monitoring condition is triggered. ship_type: type: string description: Vessel type used for filtering and monitoring.Multiple types separated by a comma. Leave empty to include all types. See Appendix for vessel type list. length: type: string description: 'The vessel length range is used for filtering and monitoring. Multiple values separated by a comma. Leave empty to include all lengths. 1=0–40m 2=40–80m 3=80–160m 4=160–240m 5=240–320m 6=Above 320m' required: - key - area_id - area_bounds - area_name - filter_type - url x-apifox-orders: - key - area_id - area_bounds - area_name - filter_type - url - ship_type - length - fleet_id example: key: 1F6D701272402D1E7D8D316CCE519123 area_id: 65a03820-31dd-4db6-afd4-9517b81f94e1 area_bounds: 119.846180,32.345143-119.814280,32.311867-119.4661,32.291067-119.375887,32.213847 area_name: area-1 filter_type: '3' fleet_id: 3f2062c6-b796-4a03-b923-48628794dd86 url: http://192.186.1.1:8000/shipxy/testdemo responses: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. content: application/json: schema: title: '' type: object properties: status: type: string msg: type: string data: type: object properties: area_id: type: string description: Unique identifier of the geofence, used for subsequent query, update and deletion operations. x-apifox-orders: - area_id required: - area_id x-apifox-orders: - status - msg - data required: - status - msg - data headers: {} x-apifox-name: success security: - apiKeyQuery: [] x-apifox-folder: 7 Event Dataset/7.2 Geofence Monitoring Push x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-433396710-run operationId: postUpdateGeofence externalDocs: description: 7.2.2 Geofence Update url: https://docs.shipfinder.com/433396710e0 /v1/Event/VesselSpeedAlertList: get: summary: 7.3.3 Query Vessel Speed Alert Subscription List deprecated: false description: '' tags: - Event Dataset parameters: - name: key in: query description: Your personal Shipfinderer API key to verify service permissions required: false example: '' schema: type: string responses: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. content: application/json: schema: title: '' type: object properties: total: type: integer description: Total number of subscribed vessels data: type: object properties: mmsi: type: integer description: 9-digit numeric code of MMSI speed_limit: type: string description: 'Value format: 3-18, Min speed – Max speed, in knots.' speed_duration: type: number description: 'Speed duration in minutes. Set the trigger duration for the speed alert. Default value=5 minutes. ' x-apifox-orders: - mmsi - speed_limit - speed_duration description: Vessel information required: - mmsi - speed_limit - speed_duration x-apifox-orders: - total - data required: - total - data headers: {} x-apifox-name: success security: - apiKeyQuery: [] x-apifox-folder: 7 Event Dataset/7.3 Vessel Speed Alert Push x-apifox-status: developing x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-433473614-run operationId: getVesselSpeedAlertList externalDocs: description: 7.3.3 Query Vessel Speed Alert Subscription List url: https://docs.shipfinder.com/433473614e0 /v1/History/PortCallRecordsByPort: get: summary: 3.6 Port Calls Records for Port deprecated: false description: "## Description\n\nThis 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.\n\n## Use Cases\n\n1. **Logistics Tracking** \n 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.\n\n2. **Port Analytics**\n\ \n## Request Limits\n\nAn API key must be created before using this service. \nService calls are subject\ \ to quota restrictions according to your permission type.\nThis 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.\ \ \n\n## Endpoint\n\n| Endpoint | HTTP Method |\n|----------|-------------|\n| `https://api.elaneglobal.com/v1/History/PortCallRecordsByPort`\ \ | GET |\n\n## Example API Call\n\n[https://api.elaneglobal.com/v1/History/PortCallRecordsByPort?key=1F6D701272402D1E7D8D316CCE519123&port_code=CNSHG&start_time=1744467589&end_time=1744967589]\n\ \n**Note:** \nThe key 1F6D701272402D1E7D8D316CCE519123 is the official key of elaneglobal.com, bound to\ \ the domain api.elaneglobal.com. \nUsers 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.\nTo trial the service, please\ \ contact our support team: support@elaneglobal.com. " tags: - 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: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. 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: "{\r\n \"status\": 0,\r\n \"msg\": \"\",\r\n \"total\": 5140,\r\n \"data\": [\r\n \ \ {\r\n \"imo\": 0,\r\n \"mmsi\": 413842124,\r\n \"ship_type\": \"70\",\r\n \ \ \"ship_name\": \"ZHEJIAXINGHUO03191\",\r\n \"call_sign\": \"0\",\r\n \"currentport\"\ : {\r\n \"port_code\": \"27999\",\r\n \"port_cnname\": \"上海\",\r\n \"port_name\"\ : \"Shanghai\",\r\n \"port_time_zone\": \"+8\",\r\n \"terminal_name\": \"\",\r\n \ \ \"berth_name\": \"\",\r\n \"arrival_anchorage\": ,\r\n \"ata\": 1744468393,\r\ \n \"atb\": 1744468393,\r\n \"atd\": 1744635846,\r\n \"arrival_draught\": 0,\r\ \n \"departure_draught\": 0,\r\n \"stay_time\": 46.51,\r\n \"stay_terminal_time\"\ : 46.51\r\n },\r\n \"previousport\": {\r\n \"port_code\": \"27999\",\r\n \ \ \"port_cnname\": \"上海\",\r\n \"port_name\": \"Shanghai\",\r\n \"port_time_zone\"\ : \"+8\",\r\n \"arrival_anchorage\": \"\",\r\n \"ata\": 1744110014,\r\n \"\ atb\": 1744110014,\r\n \"atd\": 1744120857\r\n },\r\n \"nextport\": {\r\n \ \ \"port_code\": \"213479\",\r\n \"port_cnname\": \"奉贤\",\r\n \"port_name\": \"\ Fengxian\",\r\n \"port_time_zone\": \"+8\",\r\n \"arrival_anchorage\": \"\",\r\n \ \ \"ata\": 1744484085,\r\n \"atb\": 1744484085,\r\n \"atd\": 1744498411\r\n\ \ }\r\n },\r\n {\r\n \"imo\": 9302530,\r\n \"mmsi\": 412046070,\r\n \"\ ship_type\": \"90\",\r\n \"ship_name\": \"HU JIU 18\",\r\n \"call_sign\": \"BSAR\",\r\n\ \ \"currentport\": {\r\n \"port_code\": \"27999\",\r\n \"port_cnname\": \"上海\"\ ,\r\n \"port_name\": \"Shanghai\",\r\n \"port_time_zone\": \"+8\",\r\n \"terminal_name\"\ : \"Eastern Tankstore Shanghai\",\r\n \"berth_name\": \"No 2\",\r\n \"arrival_anchorage\"\ : \"\",\r\n \"ata\": 1744469305,\r\n \"atb\": 1744469305,\r\n \"atd\": 1745489204,\r\ \n \"arrival_draught\": 3500,\r\n \"departure_draught\": 3500,\r\n \"stay_time\"\ : 283.31,\r\n \"stay_terminal_time\": 283.31\r\n },\r\n \"previousport\": {\r\n\ \ \"port_code\": \"213784\",\r\n \"port_cnname\": \"崇明\",\r\n \"port_name\"\ : \"Chongming\",\r\n \"port_time_zone\": \"+8\",\r\n \"arrival_anchorage\": \"\",\r\ \n \"ata\": 1744469305,\r\n \"atb\": 1744469305,\r\n \"atd\": 1745489204\r\n\ \ },\r\n \"nextport\": {\r\n \"port_code\": \"213784\",\r\n \"port_cnname\"\ : \"崇明\",\r\n \"port_name\": \"Chongming\",\r\n \"port_time_zone\": \"+8\",\r\n \ \ \"arrival_anchorage\": \"\",\r\n \"ata\": 1744469305,\r\n \"atb\": 1744469305,\r\ \n \"atd\": 1745489204\r\n }\r\n },\r\n ......\r\n ]\r\n}" headers: {} x-apifox-name: success security: - apiKeyQuery: [] 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: getPortCallRecordsByPort externalDocs: description: 3.6 Port Calls Records for Port url: https://docs.shipfinder.com/430531632e0 /v1/History/PortCallRecordsByVessel: get: summary: 3.3 Vessel Port Call History deprecated: false description: "## Description\nThe 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.\n\n\ ## Use Cases\n1. **Maritime Supervision** \n 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.\n\n2. **Logistics Tracking** \n 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.\n\n3. **Financial & Insurance** \n 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.\n\n## Request Limits\nAn API key must be created before using this service.\ \ \nService calls are subject to quota restrictions according to your permission type.\nThis 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. \n\n## Endpoint\n| Endpoint | HTTP Method |\n| --- | --- |\n\ | `https://api.elaneglobal.com/v1/History/PortCallRecordsByVessel` | GET |\n\n## Example API Call\nhttps://api.elaneglobal.com/v1/History/PortCallRecordsByVessel?key=1F6D701272402D1E7D8D316CCE519123&mmsi=477172700&start_time=1744967589&end_time=1745572389\n\ \n**Note:** \nThe key 1F6D701272402D1E7D8D316CCE519123 is the official key of elaneglobal.com, bound to\ \ the domain api.elaneglobal.com. \nUsers 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.\nTo trial the service, please\ \ contact our support team: support@elaneglobal.com. " tags: - 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: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. 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: "{\r\n \"status\": 0,\r\n \"msg\": \"\",\r\n \"data\": [\r\n {\r\n \"ship_name\"\ : \"COSCOSHIPPINGLIBRA\",\r\n \"call_sign\": \"VRRV4\",\r\n \"imo\": 9783538,\r\n \ \ \"mmsi\": 477172700,\r\n \"ship_type\": 71,\r\n \"port_cnname\": \"广州\",\r\n \"\ port_name\": \"Guangzhou\",\r\n \"port_time_zone\": \"+8\",\r\n \"port_code\": \"CNGZG\"\ ,\r\n \"terminal_name\": \"\",\r\n \"berth_name\": \"\",\r\n \"port_country_cnname\"\ : \"中国\",\r\n \"port_country_name\": \"China\",\r\n \"port_country_code\": \"CN\",\r\n\ \ \"arrval_anchorage\": ,\r\n \"ata\": 1745058319,\r\n \"atb\": 1745058319,\r\n \ \ \"atd\": 1745120468,\r\n \"arrival_draught\": 13.5,\r\n \"departure_draught\": 14.5,\r\ \n \"stay_time\": 17.26,\r\n \"stay_interminal_time\": 17.26\r\n }\r\n ]\r\n}" headers: {} x-apifox-name: success security: - apiKeyQuery: [] 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: getPortCallRecordsByVessel externalDocs: description: 3.3 Vessel Port Call History url: https://docs.shipfinder.com/430426234e0 /v1/History/PortCallRecordsByVesselAtPort: get: summary: 3.4 Vessel Port Call Records at Specific Port deprecated: false description: "## Description\nThe 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.\n\n## Use Cases\n1. **Maritime Supervision**\ \ \n 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.\n\n2. **Logistics\ \ Tracking** \n 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.\n\n3. **Finance & Insurance** \n Cross-verify port call records and draft\ \ fluctuation records of each vessel voyage against shipping order data for vessel risk analysis and authenticity\ \ validation.\n\n## Request Limits\nAn API key must be created before using this service. \nService calls\ \ are subject to quota restrictions according to your permission type.\nThis 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. \n\n## Endpoint\n| Endpoint | HTTP Method |\n|----------|-------------|\n| `https://api.elaneglobal.com/v1/History/PortCallRecordsByVesselAtPort`\ \ | Get |\n\n## Example API Call\nhttps://api.elaneglobal.com/v1/History/PortCallRecordsByVesselAtPort?key=1F6D701272402D1E7D8D316CCE519123&mmsi=477172700&port_code=CNGZG&start_time=1744967589&end_time=1745572389\n\ \n**Note:** \nThe key 1F6D701272402D1E7D8D316CCE519123 is the official key of elaneglobal.com, bound to\ \ the domain api.elaneglobal.com. \nUsers 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.\nTo trial the service, please\ \ contact our support team: support@elaneglobal.com. " tags: - 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: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. 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: "{\r\n \"status\": 0,\r\n \"msg\": \"\",\r\n \"total\": 1,\r\n \"data\": [\r\n {\r\ \n \"ship_name\": \"COSCO SHIPPING LIBRA\",\r\n \"call_sign\": \"VRRV4\",\r\n \"\ imo\": 9783538,\r\n \"mmsi\": 477172700,\r\n \"ship_type\": \"60\",\r\n \"port_cnname\"\ : \"新加坡\",\r\n \"port_name\": \"Singapore\",\r\n \"port_time_zone\": \"+8\",\r\n \ \ \"port_code\": \"SGSIN\",\r\n \"terminal_name\": \"\",\r\n \"berth_name\": \"\",\r\n\ \ \"port_country_cnname\": \"新加坡\",\r\n \"port_country_name\": \"Singapore\",\r\n \ \ \"port_country_code\": \"SG\",\r\n \"arriveanchorage\": ,\r\n \"ata\": 1745058319,\r\ \n \"atb\": 1745058319,\r\n \"atd\": 1745120468,\r\n \"arrival_draught\": 13500,\r\ \n \"departure_draught\": 0,\r\n \"stay_time\": 17.26,\r\n \"stay_terminal_time\"\ : 17.26\r\n }\r\n ]\r\n}" headers: {} x-apifox-name: success security: - apiKeyQuery: [] 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: getPortCallRecordsByVesselAtPort externalDocs: description: 3.4 Vessel Port Call Records at Specific Port url: https://docs.shipfinder.com/430484162e0 /v1/History/VesselCurrentPortCall: get: summary: 3.5 Vessel Current Port Call deprecated: false description: "## Description\nThe 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.\n\ \n## Use Cases\n**Logistics Tracking** \nTrack 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.\n\n## Request Limits\nAn 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.\ \ \n\n## Endpoint\n| Endpoint | HTTP Method |\n|----------|-------------|\n| `https://api.elaneglobal.com/v1/History/VesselCurrentPortCall`\ \ | GET |\n\n## Example API Call\nhttps://api.elaneglobal.com/v1/History/VesselCurrentPortCall?key=1F6D701272402D1E7D8D316CCE519123&mmsi=477172700\n\ \n\n**Note:** \nThe key 1F6D701272402D1E7D8D316CCE519123 is the official key of elaneglobal.com, bound\ \ to the domain api.elaneglobal.com. \nUsers 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.\nTo trial the service, please\ \ contact our support team: support@elaneglobal.com. " tags: - 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: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. 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: - apiKeyQuery: [] 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: getVesselCurrentPortCall externalDocs: description: 3.5 Vessel Current Port Call url: https://docs.shipfinder.com/430498718e0 /v1/History/VesselHistoryTrack: get: summary: 3.1 Vessel History Track deprecated: false description: "## Description\n\nThe Vessel History Track retrieves historical track points of a vessel by\ \ its MMSI number and a specified time period.\n\n## Use Cases\n\n1. **Logistics Tracking** \n Track\ \ vessel historical track data, and support track query, track visualization and track playback in combination\ \ with nautical charts.\n\n2. **Vessel Behavior Analysis** \n 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.\n\n## Request Limits\n\nAn API key must be created\ \ before using this service. \nService calls are subject to quota restrictions according to your permission\ \ type.\nThe service only supports querying vessel tracks within the latest month by default. \nTo view\ \ your current service access permissions or access vessel track records from an earlier time period, please\ \ contact our support team: support@elaneglobal.com. \n\n## Endpoint\n\n| Endpoint \ \ | HTTP Method |\n|-----------------------------------------------|-------------|\n| `https://api.elaneglobal.com/v1/History/VesselHistoryTrack`\ \ | GET |\n\n## Example API Call\n\nhttps://api.elaneglobal.com/v1/History/VesselHistoryTrack?key=1F6D701272402D1E7D8D316CCE519123&mmsi=477172700&start_time=1744017189&end_time=1744019589\n\ \n**Note:** \nThe key 1F6D701272402D1E7D8D316CCE519123 is the official key of elaneglobal.com, bound to\ \ the domain api.elaneglobal.com. \nUsers 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.\nTo trial the service, please\ \ contact our support team: support@elaneglobal.com. " tags: - 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: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. 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: - apiKeyQuery: [] 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: getVesselHistoryTrack externalDocs: description: 3.1 Vessel History Track url: https://docs.shipfinder.com/430346103e0 /v1/History/VesselStsEvents: get: summary: 3.2 Ship-to-Ship (STS) Events deprecated: false description: "## Description\nThe 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.\n\n\ ## Applicable Scenarios\n**Freight Logistics**\n1. **Normal STS Transshipment** \n 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.\n2. **Cargo Theft Monitoring** \n 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.\n\ \n**Maritime Supervision**\n- **Vessel Behavior Analysis** \n 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.\n\n## Request Limits\nThis is a premium service that\ \ requires advanced permission application prior to use.\nAn API key must be created before using this service.\ \ \nService 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.\ \ \n\n## Endpoint\n| Endpoint | HTTP Method |\n| --- | --- |\n| `https://api.elaneglobal.com/v1/History/VesselStsEvents`\ \ | Get |\n\n## Example API Call\nhttps://api.elaneglobal.com/v1/History/VesselStsEvents?key=1F6D701272402D1E7D8D316CCE519123&mmsi=477172700&start_time=1749956794&end_time=1751446602&approach_zone=3\n\ \n\n**Note:**\nThe key 1F6D701272402D1E7D8D316CCE519123 is the official key of elaneglobal.com, bound to\ \ the domain api.elaneglobal.com. \nUsers 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.\nTo trial the service, please\ \ contact our support team: support@elaneglobal.com. " tags: - 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: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. 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: - apiKeyQuery: [] 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: getVesselStsEvents externalDocs: description: 3.2 Ship-to-Ship (STS) Events url: https://docs.shipfinder.com/430352093e0 /v1/Meteorology/CycloneInfo: get: summary: 5.1.2 Tropical Cyclone Details by Point deprecated: false description: '' tags: - Meteorology Dataset parameters: - name: key in: query description: Your personal Shipfinderer API key to verify service permissions required: true example: 1F6D701272402D1E7D8D316CCE519123 schema: type: string - name: typhoon_id in: query description: 'Obtained via the Global Tropical Cyclones List. ' required: true example: '2477927' schema: type: string responses: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. content: application/json: schema: type: object properties: status: type: integer msg: type: string total: type: integer data: type: array items: type: object properties: typhoon_id: type: string description: Typhoon Serial Number typhoon_time: type: string description: Formation time of the tropical cyclone, defaulted to UTC+0 time. Add 8 hours when converting to China Standard Time (CST/UTC+8). forecast: type: string description: 'Marker for forecast/observed data points: Empty=Actual observation point; Non-empty=Forecast prediction point' fhour: type: string description: 'Time offset for forecast data, representing the hours ahead of the issuance time for which the cyclone parameters are predicted.Example: fhour=12 indicates the data is a 12‑hour ahead forecast issued at the reference timestamp. Note: For historical tropical cyclones, measured observational data overwrites the original forecast data, and the fhour field is returned empty.' lat: type: number description: Coordinate latitude, WGS84 coordinate system lng: type: number description: Coordinate longitude, WGS84 coordinate system grade: type: integer description: 'Tropical cyclone wind scale (range: 5–18)' mspeed: type: number description: 'Maximum sustained wind speed, Unit: meters per second (m/s)' pressure: type: number description: 'Tropical cyclone central pressure, Unit: hectopascals (hPa)' kspeed: type: number description: 'Cyclone translation speed, Unit: kilometers per hour (km/h)' direction: type: string description: 'Cyclone movement direction: East (E), West (W), South (S), North (N)' radius7: type: number description: 'Radius of 7-grade gale-force wind circle, Unit: kilometers (km)' radius10: type: number description: 'Radius of 10-grade storm-force wind circle, Unit: kilometers (km)' radius7_s: type: string description: '7-grade gale-force wind circle radius by quadrant, Unit: kilometers (km). Format: NE,SE,SW,NW (Northeast, Southeast, Southwest, Northwest)' radius10_s: type: string description: '10-grade storm-force wind circle radius by quadrant, Unit: kilometers (km)' radius12_s: type: string description: '12-grade hurricane-force wind circle radius by quadrant, Unit: kilometers (km)' required: - typhoon_id - typhoon_time - forecast - fhour - lat - lng - grade - mspeed - pressure - direction - radius7 - radius10 - radius7_s - radius10_s - radius12_s - kspeed x-apifox-orders: - typhoon_id - typhoon_time - forecast - fhour - lat - lng - grade - mspeed - pressure - kspeed - direction - radius7 - radius10 - radius7_s - radius10_s - radius12_s required: - status - msg - total - data x-apifox-orders: - status - msg - total - data example: "{\r\n \"status\": 0,\r\n \"msg\": \"\",\r\n \"total\": 15,\r\n \"data\": [\r\n {\r\ \n \"typhoon_id\": \"3063123\",\r\n \"typhoon_time\": \"202507231400\",\r\n \"forecast\"\ : \"BABJ\",\r\n \"fhour\": \"24\",\r\n \"lat\": 16.8667,\r\n \"lng\": 119.9667,\r\ \n \"grade\": 10,\r\n \"mspeed\": 28,\r\n \"pressure\": 985,\r\n \"kspeed\"\ : 0,\r\n \"direction\": \"\",\r\n \"radius7\": 0,\r\n \"radius10\": 0,\r\n \"\ radius7_s\": \"180,120,150,200\",\r\n \"radius10_s\": \"0\",\r\n \"radius12_s\": \"0\"\ \r\n },\r\n {\r\n \"typhoon_id\": \"3063123\",\r\n \"typhoon_time\": \"202507231400\"\ ,\r\n \"forecast\": \"\",\r\n \"fhour\": \"\",\r\n \"lat\": 17.6,\r\n \"lng\"\ : 118.7,\r\n \"grade\": 8,\r\n \"mspeed\": 18,\r\n \"pressure\": 992,\r\n \"\ kspeed\": 13,\r\n \"direction\": \"S\",\r\n \"radius7\": 180,\r\n \"radius10\": 0,\r\ \n \"radius7_s\": \"180,120,150,200\",\r\n \"radius10_s\": \"0\",\r\n \"radius12_s\"\ : \"0\"\r\n },\r\n .....\r\n ]\r\n}" headers: {} x-apifox-name: success security: - apiKeyQuery: [] x-apifox-folder: 5 Meteorology Dataset/5.1 Global Tropical Cyclone x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-431698143-run operationId: getCycloneInfo externalDocs: description: 5.1.2 Tropical Cyclone Details by Point url: https://docs.shipfinder.com/431698143e0 /v1/Meteorology/CyclonesList: get: summary: 5.1.1 Global Tropical Cyclones List deprecated: false description: '' tags: - Meteorology Dataset parameters: - name: key in: query description: Your personal Shipfinderer API key to verify service permissions required: true example: 1F6D701272402D1E7D8D316CCE519123 schema: type: string responses: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. content: application/json: schema: type: object properties: status: type: integer msg: type: string total: type: integer data: type: array items: type: object properties: typhoon_id: type: string description: "Obtained via the Global Tropical Cyclones List. \nNote: Tropical cyclone\ \ names are often reused, but each cyclone carries a unique typhoon_id. To query the\ \ latest cyclone data, first pull the up-to-date typhoon_id from the list, then use\ \ it to retrieve full cyclone details." typhoon_code: type: integer description: International serial number of the tropical cyclone typhoon_cncode: type: string description: Chinese serial number of the tropical cyclone; the first two digits represent the year, and the last two digits indicate sequential order by occurrence time typhoon_cnname: type: string description: Chinese name of the tropical cyclone typhoon_name: type: string description: Name of the tropical cyclone current_year: type: integer description: Year the tropical cyclone formed dataMark: type: string description: 'Indicator of whether the cyclone is active: ing=In progress; blank=Concluded' required: - typhoon_id - typhoon_code - typhoon_cncode - typhoon_cnname - typhoon_name - current_year - dataMark x-apifox-orders: - typhoon_id - typhoon_code - typhoon_cncode - typhoon_cnname - typhoon_name - current_year - dataMark required: - status - msg - total - data x-apifox-orders: - status - msg - total - data example: "{\r\n \"status\": 0,\r\n \"msg\": \"\",\r\n \"total\": 425,\r\n \"data\": [\r\n \ \ {\r\n \"typhoon_id\": \"3064324\",\r\n \"typhoon_code\": 0,\r\n \"typhoon_cncode\"\ : \"2509\",\r\n \"typhoon_cnname\": \"罗莎\",\r\n \"typhoon_name\": \"KROSA\",\r\n \ \ \"current_year\": 2025,\r\n \"dataMark\": \"\"\r\n },\r\n {\r\n \"typhoon_id\"\ : \"3063123\",\r\n \"typhoon_code\": 0,\r\n \"typhoon_cncode\": \"2508\",\r\n \"\ typhoon_cnname\": \"竹节草\",\r\n \"typhoon_name\": \"CO-MAY\",\r\n \"current_year\": 2025,\r\ \n \"dataMark\": \"\"\r\n },\r\n {\r\n \"typhoon_id\": \"3062724\",\r\n \"\ typhoon_code\": 0,\r\n \"typhoon_cncode\": \"2507\",\r\n \"typhoon_cnname\": \"范斯高\",\r\ \n \"typhoon_name\": \"FRANCISCO\",\r\n \"current_year\": 2025,\r\n \"dataMark\"\ : \"\"\r\n },\r\n ......\r\n ]\r\n}" headers: {} x-apifox-name: success security: - apiKeyQuery: [] x-apifox-folder: 5 Meteorology Dataset/5.1 Global Tropical Cyclone x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-431698053-run operationId: getCyclonesList externalDocs: description: 5.1.1 Global Tropical Cyclones List url: https://docs.shipfinder.com/431698053e0 /v1/Meteorology/MarineWeather: get: summary: 5.3 Global Marine Weather deprecated: false description: "## Description\nThe Global Marine Weather queries global marine meteorological data by geographic\ \ coordinates, covering core navigation-critical weather indicators including sea level pressure, pressure-driven\ \ current direction, wind direction, wind speed, significant wave height, visibility, etc.\n\nNote: Meteorological\ \ monitoring data is incomplete in certain regions. A return value of -32767 for fields such as barometric\ \ pressure and swell height indicates no valid meteorological readings are available for the queried location.\n\ \n## Use Cases\n1. **Route Planning & Optimization** \n Dynamic Route Adjustment: Retrieve real-time\ \ marine meteorological data during vessel transit. In the event of sudden severe weather or fluctuating\ \ meteorological conditions, adjust the sailing route promptly to avoid navigational hazards and guarantee\ \ maritime safety.\n2. **Vessel Navigation Safety** \n - Severe Weather Warning: Obtain advance forecasts\ \ of hazardous marine weather including tropical cyclones, storm surges, cold wave gales, and sea fog. Vessels\ \ may implement preemptive measures (e.g., altering course, adjusting speed, seeking a lee anchorage) to\ \ reduce sailing risks in adverse weather and lower accident probability.\n - Visibility Monitoring &\ \ Early Warning: Low-visibility events (e.g., sea fog) severely impact navigation safety. Visibility data\ \ from marine weather outputs enables vessels to assess visibility conditions in surrounding waters and\ \ deploy contingency measures in advance.\n3. **Port Operations & Management** \n Vessel Port Entry/Exit\ \ Scheduling: Port authorities may optimize vessel arrival/departure timetables based on marine meteorological\ \ data, suspending berthing/unberthing operations during severe weather to ensure the safety and efficiency\ \ of port activities.\n4. **Vessel Insurance Pricing & Risk Assessment** \n Risk Quantification: By analyzing\ \ historical marine meteorological data combined with vessel type, planned route, and sailing season, insurers\ \ can accurately quantify risk exposure under varying meteorological conditions and formulate rational premium\ \ rates.\n5. **Vessel Entry Risk Assessment for Border Inspection & Customs** \n - Adverse Weather Impact\ \ Evaluation: Border inspection and customs authorities review marine meteorological data along the vessel’s\ \ transit path to verify exposure to severe weather, and assess potential damages including hull structural\ \ impairment and cargo loss.\n - Sailing Trajectory Analysis: Correlate marine meteorological data with\ \ the vessel’s sailing trajectory to verify route compliance and identify abnormal detours or idle periods.\ \ Vessels with anomalous trajectories inconsistent with prevailing meteorological conditions shall undergo\ \ targeted inspection to deter illicit trade, smuggling, stowaway trafficking and other illegal activities.\n\ \n## Request Limits\n- This is a premium service that requires advanced permission application prior to\ \ use.\n- An API key must be created in the Dashboard before using this service.\n- Service calls are subject\ \ to quota restrictions according to your permission type; your current service access permissions can be\ \ viewed in the Dashboard.\n- Please contact our support team to activate service permissions.\n\n## Endpoint\n\ | Endpoint | HTTP Method |\n| --- | --- |\n| `https://api.elaneglobal.com/v1/Meteorology/MarineWeather `\ \ | Get |\n\n## Example API Call\nhttps://api.elaneglobal.com/v1/Meteorology/MarineWeather?key=1F6D701272402D1E7D8D316CCE519123&lng=123.58414&lat=27.37979\n\ \n\n**Note:**\nThe key 1F6D701272402D1E7D8D316CCE519123 is the official key of elaneglobal.com, bound to\ \ the domain api.elaneglobal.com. \nUsers 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.\nTo trial the service, please\ \ contact our support team: support@elaneglobal.com. \n" tags: - Meteorology Dataset parameters: - name: key in: query description: Your personal Shipfinderer API key to verify service permissions required: true example: 1F6D701272402D1E7D8D316CCE519123 schema: type: string - name: lng in: query description: Coordinate longitude, WGS84 coordinate system required: true example: 123.58414 schema: type: number - name: lat in: query description: Coordinate latitude, WGS84 coordinate system required: true example: 27.37979 schema: type: number - name: weather_time in: query description: 'UTC time in Unix timestamp format. When this parameter is not specified, the latest available meteorological data will be returned. Note: Only forecast data for the following fixed UTC hours daily is queryable within the next 7 days: 02:00:00, 08:00:00, 14:00:00, 20:00:00.' required: false schema: type: string responses: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. content: application/json: schema: type: object properties: status: type: integer description: Descriptive status of the data query result msg: type: string description: System response status code; refer to the Appendix for return code definitions data: type: object properties: bm500: type: number description: 500mb elevation pressure, unit (gpm), when the return value is -32767, it indicates that there is no corresponding data returned here. humidity: type: number description: 'Relative humidity, Unit: %' oceandir: type: number description: 'Ocean current direction, Unit: degrees (°)' oceanspeed: type: number description: 'Ocean current speed, Unit: meters per second (m/s)' pressure: type: number description: 'Sea level barometric pressure, Unit: hectopascals (hPa)' swelldir: type: number description: 'Swell propagation direction, Unit: degrees (°)' swellheight: type: number description: 'Significant swell height, Unit: meters (m)' swellperiod: type: number description: 'Swell wave period, Unit: seconds (s)' temperature: type: number description: 'Sea surface temperature (SST), Unit: degrees Celsius (℃)' visibility: type: number description: 'Horizontal atmospheric visibility, Unit: meters (m)' waveheight: type: number description: 'Significant total wave height (wind wave + swell), Unit: meters (m)' winddir: type: number description: 'Surface wind direction, Unit: degrees (°)' windspeed: type: number description: 'Surface wind speed, Unit: meters per second (m/s)' publish_time: type: integer description: Timestamp of the meteorological forecast issuance lng: type: number description: Longitude of the forecast grid point lat: type: number description: Latitude of the forecast grid point required: - bm500 - humidity - oceandir - oceanspeed - pressure - swelldir - swellheight - swellperiod - temperature - visibility - waveheight - winddir - windspeed - publish_time - lng - lat x-apifox-orders: - bm500 - humidity - oceandir - oceanspeed - pressure - swelldir - swellheight - swellperiod - temperature - visibility - waveheight - winddir - windspeed - publish_time - lng - lat required: - status - msg - data x-apifox-orders: - status - msg - data example: status: 0 msg: '' data: bm500: -32767 humidity: 93.5 oceandir: 234 oceanspeed: 0.2 pressure: 1008.5 swelldir: 158.7 swellheight: 2 swellperiod: 5.8 temperature: 24.5 visibility: 24134.8 waveheight: 2 winddir: 183.2 windspeed: 10.1 publish_time: 1746748800 lng: 123.58414 lat: 27.37979 headers: {} x-apifox-name: success security: - apiKeyQuery: [] x-apifox-folder: 5 Meteorology Dataset x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-431272522-run operationId: getMarineWeather externalDocs: description: 5.3 Global Marine Weather url: https://docs.shipfinder.com/431272522e0 /v1/Meteorology/TideStationInfo: get: summary: 5.2.2 Query Single Tide Gauge Station Details deprecated: false description: '' tags: - Meteorology 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: Unique ID of the port tide gauge station required: true example: 4000189 schema: type: integer - name: start_date in: query description: 'Start date for tidal data query. Format: YYYY-MM-DD. Historical data queries are supported from 2020 onwards.' required: true example: '2025-03-01' schema: type: string - name: end_date in: query description: "End date for tidal data query. Format: YYYY-MM-DD. \nNotes:\n1. Single query time range shall\ \ not exceed 90 days.\n2. Forecast data is limited to 30 days in advance; requests beyond this range will\ \ return an error.\n3. Historical tidal data is available for all dates from 2020 onwards.\n4. Tidal data\ \ is updated once daily.\n5. Future timestamps return forecast data; historical timestamps are overwritten\ \ with observed tidal data." required: true example: '2025-03-05' schema: type: string responses: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. content: application/json: schema: type: object properties: status: type: integer msg: type: string data: type: object properties: overview: type: array items: type: object properties: tide_date: type: string description: Calendar date of tidal records tide_time1: type: string description: First tidal time point on the query date tide_time2: type: string description: Second tidal time point on the query date tide_time3: type: string description: Third tidal time point on the query date tide_time4: type: string description: Fourth tidal time point on the query date tide_height1: type: number description: 'Tidal height at the first time point, Unit: meters (m)' tide_height2: type: number description: 'Tidal height at the second time point, Unit: meters (m)' tide_height3: type: number description: 'Tidal height at the third time point, Unit: meters (m)' tide_height4: type: number description: 'Tidal height at the fourth time point, Unit: meters (m)' tide_lowhigh1: type: string description: Stage label for the first tidal event (e.g., High Tide, Low Tide) tide_lowhigh2: type: string description: Stage label for the second tidal event (e.g., High Tide, Low Tide) tide_lowhigh3: type: string description: Stage label for the third tidal event (e.g., High Tide, Low Tide) tide_lowhigh4: type: string description: Stage label for the fourth tidal event (e.g., High Tide, Low Tide) required: - tide_date - tide_time1 - tide_time2 - tide_time3 - tide_time4 - tide_height1 - tide_height2 - tide_height3 - tide_height4 - tide_lowhigh1 - tide_lowhigh2 - tide_lowhigh3 - tide_lowhigh4 x-apifox-orders: - tide_date - tide_time1 - tide_time2 - tide_time3 - tide_time4 - tide_height1 - tide_height2 - tide_height3 - tide_height4 - tide_lowhigh1 - tide_lowhigh2 - tide_lowhigh3 - tide_lowhigh4 detail: type: array items: type: object properties: tide_date: type: string description: Tide Date h0: type: number description: 'Tidal height at 00:00 midnight, Unit: meters (m)' h1: type: number description: 'Tidal height at 01:00 midnight, Unit: meters (m)' h2: type: number description: 'Tidal height at 02:00 midnight, Unit: meters (m)' h3: type: number description: 'Tidal height at 03:00 midnight, Unit: meters (m)' h4: type: number description: 'Tidal height at 04:00 midnight, Unit: meters (m)' h5: type: number description: 'Tidal height at 05:00 midnight, Unit: meters (m)' h6: type: number description: 'Tidal height at 06:00 midnight, Unit: meters (m)' h7: type: number description: 'Tidal height at 07:00 midnight, Unit: meters (m)' h8: type: number description: 'Tidal height at 08:00 midnight, Unit: meters (m)' h9: type: number description: 'Tidal height at 09:00 midnight, Unit: meters (m)' h10: type: number description: 'Tidal height at 10:00 midnight, Unit: meters (m)' h11: type: number description: 'Tidal height at 11:00 midnight, Unit: meters (m)' h12: type: number description: 'Tidal height at 12:00 midnight, Unit: meters (m)' h13: type: number description: 'Tidal height at 13:00 midnight, Unit: meters (m)' h14: type: number description: 'Tidal height at 14:00 midnight, Unit: meters (m)' h15: type: number description: 'Tidal height at 15:00 midnight, Unit: meters (m)' h16: type: number description: 'Tidal height at 16:00 midnight, Unit: meters (m)' h17: type: number description: 'Tidal height at 17:00 midnight, Unit: meters (m)' h18: type: number description: 'Tidal height at 18:00 midnight, Unit: meters (m)' h19: type: number description: 'Tidal height at 19:00 midnight, Unit: meters (m)' h20: type: number description: 'Tidal height at 20:00 midnight, Unit: meters (m)' h21: type: number description: 'Tidal height at 21:00 midnight, Unit: meters (m)' h22: type: number description: 'Tidal height at 22:00 midnight, Unit: meters (m)' h23: type: number description: 'Tidal height at 23:00 midnight, Unit: meters (m)' required: - tide_date - h0 - h1 - h2 - h3 - h4 - h5 - h6 - h7 - h8 - h9 - h10 - h11 - h12 - h13 - h14 - h15 - h16 - h17 - h18 - h19 - h20 - h21 - h22 - h23 x-apifox-orders: - tide_date - h0 - h1 - h2 - h3 - h4 - h5 - h6 - h7 - h8 - h9 - h10 - h11 - h12 - h13 - h14 - h15 - h16 - h17 - h18 - h19 - h20 - h21 - h22 - h23 required: - overview - detail x-apifox-orders: - overview - detail required: - status - msg - data x-apifox-orders: - status - msg - data example: status: 0 msg: '' data: overview: - tide_date: '2025-03-05' tide_time1: 00:10 tide_time2: 06:33 tide_time3: '12:43' tide_time4: '19:12' tide_height1: 3.8 tide_height2: 0.1 tide_height3: 4.2 tide_height4: 0.6 tide_lowhigh1: high tide 1 tide_lowhigh2: low tide 2 tide_lowhigh3: high tide 3 tide_lowhigh4: low tide 4 - tide_date: '2025-03-04' tide_time1: 05:55 tide_time2: '11:56' tide_time3: '18:22' tide_time4: ' ' tide_height1: 0 tide_height2: 4.2 tide_height3: 0.3 tide_height4: 0 tide_lowhigh1: low tide 1 tide_lowhigh2: high tide 2 tide_lowhigh3: high tide 3 tide_lowhigh4: high tide 4 - tide_date: '2025-03-03' tide_time1: 05:19 tide_time2: '11:13' tide_time3: '17:38' tide_time4: '23:29' tide_height1: 0 tide_height2: 4.1 tide_height3: 0.1 tide_height4: 4.1 tide_lowhigh1: low tide 1 tide_lowhigh2: high tide 2 tide_lowhigh3: low tide 3 tide_lowhigh4: high tide 4 - tide_date: '2025-03-02' tide_time1: 04:44 tide_time2: '10:33' tide_time3: '16:55' tide_time4: '22:51' tide_height1: 0.1 tide_height2: 4 tide_height3: 0 tide_height4: 4.2 tide_lowhigh1: low tide 1 tide_lowhigh2: high tide 2 tide_lowhigh3: low tide 3 tide_lowhigh4: high tide 4 - tide_date: '2025-03-01' tide_time1: 04:10 tide_time2: 09:56 tide_time3: '16:14' tide_time4: '22:14' tide_height1: 0.2 tide_height2: 3.8 tide_height3: 0 tide_height4: 4.3 tide_lowhigh1: low tide 1 tide_lowhigh2: high tide 2 tide_lowhigh3: low tide 3 tide_lowhigh4: high tide 4 detail: - tide_date: '2025-03-05' h0: 3.79 h1: 3.64 h2: 3.1 h3: 2.31 h4: 1.44 h5: 0.65 h6: 0.14 h7: 0.11 h8: 0.64 h9: 1.57 h10: 2.62 h11: 3.52 h12: 4.07 h13: 4.17 h14: 3.86 h15: 3.22 h16: 2.4 h17: 1.59 h18: 0.92 h19: 0.6 h20: 0.75 h21: 1.3 h22: 2.04 h23: 2.77 - tide_date: '2025-03-04' h0: 3.99 h1: 3.53 h2: 2.74 h3: 1.81 h4: 0.91 h5: 0.22 h6: -0.03 h7: 0.33 h8: 1.2 h9: 2.29 h10: 3.29 h11: 3.98 h12: 4.2 h13: 3.95 h14: 3.32 h15: 2.45 h16: 1.56 h17: 0.78 h18: 0.33 h19: 0.41 h20: 1 h21: 1.87 h22: 2.78 h23: 3.47 - tide_date: '2025-03-03' h0: 3.9 h1: 3.2 h2: 2.28 h3: 1.32 h4: 0.49 h5: 0.02 h6: 0.14 h7: 0.84 h8: 1.87 h9: 2.93 h10: 3.73 h11: 4.1 h12: 3.97 h13: 3.41 h14: 2.56 h15: 1.64 h16: 0.79 h17: 0.21 h18: 0.14 h19: 0.67 h20: 1.59 h21: 2.63 h22: 3.5 h23: 3.99 - tide_date: '2025-03-02' h0: 3.62 h1: 2.76 h2: 1.8 h3: 0.9 h4: 0.26 h5: 0.11 h6: 0.57 h7: 1.46 h8: 2.48 h9: 3.35 h10: 3.87 h11: 3.9 h12: 3.48 h13: 2.71 h14: 1.8 h15: 0.93 h16: 0.25 h17: 0.01 h18: 0.38 h19: 1.25 h20: 2.35 h21: 3.36 h22: 4.04 h23: 4.22 - tide_date: '2025-03-01' h0: 3.2 h1: 2.29 h2: 1.38 h3: 0.62 h4: 0.25 h5: 0.44 h6: 1.11 h7: 2.02 h8: 2.9 h9: 3.54 h10: 3.75 h11: 3.49 h12: 2.85 h13: 2.01 h14: 1.15 h15: 0.42 h16: 0.04 h17: 0.21 h18: 0.94 h19: 2 h20: 3.1 h21: 3.92 h22: 4.31 h23: 4.18 headers: {} x-apifox-name: success security: - apiKeyQuery: [] x-apifox-folder: 5 Meteorology Dataset/5.2 Global Port Tide Predictions x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-431865286-run operationId: getTideStationInfo externalDocs: description: 5.2.2 Query Single Tide Gauge Station Details url: https://docs.shipfinder.com/431865286e0 /v1/Meteorology/TideStationList: get: summary: 5.2.1 Request parameters for Global Tide Gauge Stations List deprecated: false description: '' tags: - Meteorology Dataset parameters: - name: key in: query description: Your personal Shipfinderer API key to verify service permissions required: true example: 1F6D701272402D1E7D8D316CCE519123 schema: type: string responses: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. content: application/json: schema: type: object properties: status: type: integer msg: type: string total: type: integer data: type: array items: type: object properties: port_code: type: integer description: Port Tidal Observation Station ID port_cnname: type: string description: Chinese name of the port port_name: type: string description: Name of the port 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 lat: type: number description: Coordinate latitude, WGS84 coordinate system lng: type: number description: Coordinate longitude, WGS84 coordinate system port_time_zone: type: string description: Time zone of the port’s location datumn: type: number description: 'Vertical offset of the tidal datum below mean sea level, Unit: centimeters (cm)' required: - port_code - port_cnname - port_name - port_country_cnname - port_country_name - lat - lng - port_time_zone - datumn x-apifox-orders: - port_code - port_cnname - port_name - port_country_cnname - port_country_name - lat - lng - port_time_zone - datumn required: - status - msg - total - data x-apifox-orders: - status - msg - total - data example: "{\r\n \"status\": 0,\r\n \"msg\": \"\",\r\n \"total\": 4708,\r\n \"data\": [\r\n \ \ {\r\n \"port_code\": 4001466,\r\n \"port_cnname\": \"\",\r\n \"port_name\": \"Camocim\"\ ,\r\n \"port_country_cnname\": \"巴西\",\r\n \"port_country_name\": \"Brazil\",\r\n \ \ \"lat\": -2.88333,\r\n \"lng\": -40.85,\r\n \"port_time_zone\": \"UTC-3\",\r\n \ \ \"datumn\": \"182\"\r\n },\r\n {\r\n \"port_code\": 8000001,\r\n \"port_cnname\"\ : \"丹东\",\r\n \"port_name\": \"DANDONG\",\r\n \"port_country_cnname\": \"中国\",\r\n \ \ \"port_country_name\": \"China\",\r\n \"lat\": 40.11667,\r\n \"lng\": 124.4,\r\n \ \ \"port_time_zone\": \"UTC+8\",\r\n \"datumn\": \"150\"\r\n },\r\n ......\r\n \ \ ]\r\n}" headers: {} x-apifox-name: success security: - apiKeyQuery: [] x-apifox-folder: 5 Meteorology Dataset/5.2 Global Port Tide Predictions x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-431857907-run operationId: getTideStationList externalDocs: description: 5.2.1 Request parameters for Global Tide Gauge Stations List url: https://docs.shipfinder.com/431857907e0 /v1/Prediction/ETA: get: summary: 4.3 ETA Query deprecated: false description: "## Description\nQuery 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.\n\n## Use Case\n**Logistics Tracking** \nQuery 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.\n\n## Request Limits\nAn 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. \n\n## Endpoint\n| Endpoint\ \ | HTTP Method |\n|----------|-------------|\n| `https://api.elaneglobal.com/v1/Prediction/ETA` | GET |\n\ \n## Example API Call\nhttps://api.elaneglobal.com/v1/Prediction/ETA?key=1F6D701272402D1E7D8D316CCE519123&mmsi=477172700&port_code=CNSHG&speed=20\n\ \n\n**Note:** \nThe key 1F6D701272402D1E7D8D316CCE519123 is the official key of elaneglobal.com, bound\ \ to the domain api.elaneglobal.com. \nUsers 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.\nTo trial the service, please\ \ contact our support team: support@elaneglobal.com. " tags: - 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: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. 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: - apiKeyQuery: [] 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: getETA externalDocs: description: 4.3 ETA Query url: https://docs.shipfinder.com/431244206e0 /v1/Prediction/RoutePlanPointToPoint: get: summary: 4.1 Point-to-Point Route Planning deprecated: false description: "# 4.1 Point-to-Point Route Planning\n\n## Description\nThe 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.\n\n## Use Cases\n1. **Logistics Tracking** \n 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.\n\n2. **Navigation\ \ Guidance** \n 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.\n\n##\ \ Request Limits\nAn 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. \n\n## Endpoint\n| Endpoint | HTTP Method |\n| --- | --- |\n| `https://api.elaneglobal.com/v1/Prediction/RoutePlanPointToPoint`\ \ | GET |\n\n## Example API Call\nhttps://api.elaneglobal.com/v1/Prediction/RoutePlanPointToPoint?key=1F6D701272402D1E7D8D316CCE519123&start_point=113.571144,22.844316&end_point=121.58414,31.37979\n\ \nhttps://api.elaneglobal.com/v1/Prediction/RoutePlanPointToPoint?key=1F6D701272402D1E7D8D316CCE519123&start_point=113.571144,22.844316&end_port_code=CNQDG\n\ \n**Note:** \nThe key 1F6D701272402D1E7D8D316CCE519123 is the official key of elaneglobal.com, bound to\ \ the domain api.elaneglobal.com. \nUsers 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.\nTo trial the service, please\ \ contact our support team: support@elaneglobal.com. " tags: - 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: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. 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: - apiKeyQuery: [] 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: getRoutePlanPointToPoint externalDocs: description: 4.1 Point-to-Point Route Planning url: https://docs.shipfinder.com/431124483e0 /v1/Prediction/RoutePlanPortToPort: get: summary: 4.2 Port-to-Port Route Planning deprecated: false description: "## Description\nThe 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.\n\n## Use Case\n**Logistics Tracking** \nSave 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.\n\ \n## Request Limits\nAn 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. \n\n## Endpoint\n| Endpoint | HTTP Method |\n|----------|-------------|\n\ | `https://api.elaneglobal.com/v1/Prediction/RoutePlanPortToPort` | Get |\n\n## Example API Call\nhttps://api.elaneglobal.com/v1/Prediction/RoutePlanPortToPort?key=1F6D701272402D1E7D8D316CCE519123&start_port_code=CNGZG&end_port_code=CNSHG&avoid=11\n\ \n**Note:** \nThe key 1F6D701272402D1E7D8D316CCE519123 is the official key of elaneglobal.com, bound to\ \ the domain api.elaneglobal.com. \nUsers 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.\nTo trial the service, please\ \ contact our support team: support@elaneglobal.com. " tags: - 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: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. 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: - apiKeyQuery: [] 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: getRoutePlanPortToPort externalDocs: description: 4.2 Port-to-Port Route Planning url: https://docs.shipfinder.com/431244012e0 /v1/Voyage/PortAnchoredVessels: get: summary: 2.3 Currently Anchored Vessels deprecated: false description: "## Description\n\nThe 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.\n\n## Use Cases\n\n1. Analyze the average patterns of vessel operation duration based on the\ \ dwell time of different vessel types in the returned dataset.\n2. For logistic operations, filter vessels\ \ by type from the list of currently berthed vessels to identify suitable carriers for cargo transportation.\n\ 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.\n\n## Request Limits\n\nAn 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.\ \ \n\n## Endpoint\n| Endpoint | HTTP Method |\n|----------|-------------|\n| `https://api.elaneglobal.com/v1/Voyage/PortAnchoredVessels`\ \ | GET |\n\n## Example API Call\n\nhttps://api.elaneglobal.com/v1/Voyage/PortAnchoredVessels?key=1F6D701272402D1E7D8D316CCE519123&port_code=CNSHG\n\ \n**Note:** \n\nThe key 1F6D701272402D1E7D8D316CCE519123 is the official key of Shipfinder.com, bound to\ \ the domain api.shipfinder.com. \nUsers 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. \nTo trial the service, please\ \ create your own key in the Dashboard.\n" tags: - 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: Success. HTTP 200 with a JSON envelope whose "status" field is 0. 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: "{\r\n \"status\": 0,\r\n \"msg\": \"\",\r\n \"total\": 241,\r\n \"data\": [\r\ \n {\r\n \"mmsi\": 413611860,\r\n \"imo\": 1400704,\r\n \ \ \"call_sign\": \"\",\r\n \"ship_name\": \"QIANKUN02\",\r\n \"ship_type\"\ : 79,\r\n \"length\": 102.0,\r\n \"width\": 18.0,\r\n \"left\"\ : 9.0,\r\n \"trail\": 90.0,\r\n \"draught\": 4.1,\r\n \"arrival_time\"\ : \"1753237238\",\r\n \"stay_time\": 34.6\r\n },\r\n {\r\n \"\ mmsi\": 413720847,\r\n \"imo\": 0,\r\n \"call_sign\": \"NZEXVC\",\r\n \ \ \"ship_name\": \"WANXUANCHENGHT9678\",\r\n \"ship_type\": 0,\r\n \ \ \"length\": 883.0,\r\n \"width\": 32.0,\r\n \"left\": 32.0,\r\n \ \ \"trail\": 387.0,\r\n \"draught\": 0.0,\r\n \"arrival_time\": \"1753080812\"\ ,\r\n \"stay_time\": 2641.7\r\n },\r\n ......\r\n ]\r\n}" headers: {} x-apifox-name: success security: - apiKeyQuery: [] 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: getPortAnchoredVessels externalDocs: description: 2.3 Currently Anchored Vessels url: https://docs.shipfinder.com/430236145e0 /v1/Voyage/PortBerthedVessels: get: summary: 2.2 Currently Berthed Vessels deprecated: false description: "## Description\n\nThe 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.\n\n##\ \ Use Cases\n\n1. Analyze the average patterns of vessel operation duration based on the dwell time of different\ \ vessel types in the returned dataset.\n2. For logistic operations, filter vessels by type from the list\ \ of currently berthed vessels to identify suitable carriers for cargo transportation.\n3. 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.\n\n## Request Limits\n\nAn 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. \n\n## Endpoint\n| Endpoint\ \ | HTTP Method |\n|----------|-------------|\n| `https://api.elaneglobal.com/v1/Voyage/PortBerthedVessels`\ \ | GET |\n\n## Example API Call\nhttps://api.elaneglobal.com/v1/Voyage/PortBerthedVessels?key=1F6D701272402D1E7D8D316CCE519123&port_code=CNSHG\n\ \n\n**Note:** \nThe 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.\n" tags: - 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: "{\r\n \"status\": 0,\r\n \"msg\": \"\",\r\n \"total\": 713,\r\n \"data\": [\r\n {\r\ \n \"mmsi\": 100900006,\r\n \"imo\": 0,\r\n \"call_sign\": \"YYYY\",\r\n \"\ ship_name\": \"AISTESTSHIP\",\r\n \"ship_type\": 70,\r\n \"length\": 50,\r\n \"width\"\ : 6,\r\n \"left\": 5,\r\n \"trail\": 10,\r\n \"draught\": 0,\r\n \"arrival_time\"\ : \"1746484554\",\r\n \"stay_time\": 2166.2\r\n },\r\n {\r\n \"mmsi\": 100900100,\r\ \n \"imo\": 0,\r\n \"call_sign\": \"YYYY\",\r\n \"ship_name\": \"AISTESTSHIP\",\r\ \n \"ship_type\": 70,\r\n \"length\": 50,\r\n \"width\": 6,\r\n \"left\": 5,\r\ \n \"trail\": 10,\r\n \"draught\": 0,\r\n \"arrival_time\": \"1746609269\",\r\n \ \ \"stay_time\": 87.7\r\n },\r\n ........\r\n ]\r\n}" headers: {} x-apifox-name: 成功 security: - apiKeyQuery: [] 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: getPortBerthedVessels externalDocs: description: 2.2 Currently Berthed Vessels url: https://docs.shipfinder.com/430197412e0 /v1/Voyage/PortExpectedArrivals: get: summary: 2.4 Inbound / Expected Arrivals deprecated: false description: "## Description\nThe 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.\n\n## Use Cases\n1. **Maritime Supervision** \n 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.\n\n2. **Logistics Vessel\ \ Sourcing** \n 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.\n\n3. **Maritime Traffic Analysis**\ \ \n Analyze port carrying capacity and the attribute profiles of all inbound vessels scheduled to arrive\ \ at the port.\n\n## Request Limits\nThis is a premium service that requires advanced permission application\ \ prior to use.\nAn API key must be created before using this service. \nService 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. \n\n## Endpoint\n| Endpoint\ \ | HTTP Method |\n|----------|-------------|\n| `https://api.elaneglobal.com/v1/Voyage/PortExpectedArrivals`\ \ | Get |\n\n## Example API Call\nhttps://api.elaneglobal.com/v1/Voyage/PortExpectedArrivals?key=1F6D701272402D1E7D8D316CCE519123&port_code=CNSHG&start_time=1746612218&end_time=1747044218&ship_type=0\n\ \n**Note:** \nThe key `1F6D701272402D1E7D8D316CCE519123` is the official key of Shipfinder.com, bound to\ \ the domain api.shipfinder.com. \nUsers 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. \nTo trial the service, please\ \ create your own key in the Dashboard.\n\n## Request Parameters\n| Parameter | Legend | Type | Required\ \ | Description |\n|-----------|--------|------|----------|-------------|\n| key | Authorization Code |\ \ string | yes | Your personal Shipfinder API key to verify service permissions |\n| port_code | Standard\ \ Port Code | string | yes | Standard five-digit port code |\n| start_time | Start Time | int | yes | Start\ \ time represented as a UTC timestamp. The start time must be later than the current time. |\n| 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. |\n| 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: - 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: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. 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: - apiKeyQuery: [] 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: getPortExpectedArrivals externalDocs: description: 2.4 Inbound / Expected Arrivals url: https://docs.shipfinder.com/430249182e0 /v1/Voyage/PortInfo: get: summary: 2.1 Port Information deprecated: false description: "## Description\n\nThe 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.\n\n## Use Cases\n\nThe five-digit port code obtained from this\ \ service can be used in conjunction with the following maritime query services:\n- Vessel Call Records\ \ at Specified Port\n- Port Vessel Arrival Notices\n- Port Berthing Vessels Query\n- Port Anchored Vessels\ \ Query\n\n## Request Limits\n\nAn 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. \n\n## Endpoint\n\n| Endpoint | HTTP Method\ \ |\n|----------|-------------|\n| `https://api.elaneglobal.com/v1/Voyage/PortInfo` | GET |\n\n## Example\ \ API Call\n\nhttps://api.elaneglobal.com/v1/Voyage/PortInfo?key=1F6D701272402D1E7D8D316CCE519123&keywords=qingdao&max=6\n\ \n\n**Note**: \n\nThe key 1F6D701272402D1E7D8D316CCE519123 is the official key of Shipfinder.com, bound\ \ to the domain api.shipfinder.com.\nUsers 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.\nTo trial the service, please\ \ create your own key in the Dashboard." tags: - 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: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. 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: - apiKeyQuery: [] 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: getPortInfo externalDocs: description: 2.1 Port Information url: https://docs.shipfinder.com/429932201e0 /v1/Warning/NavigationalWarnings: get: summary: 6.1 China Region Navigational Warnings deprecated: false description: "## Description\nThe China Region Navigational Warnings is used to query navigation warning data\ \ in China’s coastal areas, including military operations, vessel drills, live-fire exercises, vessel operations,\ \ buoy dynamics, vessel grounding, vessel sea trials, shipwrecks, casualties, construction operations and\ \ other events.\nThe data is sourced from the China Maritime Safety Administration (MSA).\n\n## Use Cases\n\ **Vessel Navigation Safety**\n- **Hazard Area Avoidance**\n Navigation warning data helps vessels stay\ \ away from dangerous zones, such as military exercise areas, shipwreck areas, sand mining operation areas,\ \ etc.\n For example, when the maritime authority issues a navigation warning for military exercises in\ \ a certain sea area, vessels can adjust their routes according to the data to avoid entering the zone,\ \ thus reducing risks such as collisions and accidental intrusion into hazardous areas.\n\n**Port Management**\n\ - **Port Operation Optimization**\n Port authorities can use navigation warning data to grasp the dynamics\ \ of incoming vessels in advance and arrange port operations reasonably, including berth allocation, pilotage\ \ services, etc.\n- **Port Safety Assurance**\n Timely access to navigation warnings around ports helps\ \ port authorities monitor navigation safety in surrounding waters and prevent accidents such as vessel\ \ collisions and groundings.\n\n**Maritime Big Data Analysis**\n- **Risk Assessment**\n Shipping companies\ \ can conduct risk assessments using navigation warning data, analyze the risk level of specific routes\ \ or areas, and provide a basis for insurance pricing and risk management.\n\n## Request Limits\nThis is\ \ a premium service that requires advanced permission application prior to use.\nAn API key must be created\ \ before using this service. The corresponding monitored fleet vessels and push receiving URL must be configured\ \ under the API key.\n To view your current service access permissions, please contact our support team:\ \ support@elaneglobal.com. \n\n## Endpoint\n| Endpoint | HTTP Method |\n|----------|-------------|\n| `https://api.elaneglobal.com/v1/Warning/NavigationalWarnings`\ \ | GET |\n\n## Example API Call\nhttps://api.elaneglobal.com/v1/Warning/NavigationalWarnings?key=1F6D701272402D1E7D8D316CCE519123&start_time=2024-07-21%2020:00&end_time=2024-09-21%2020:00\n\ \n\n**Note:** \nThe key 1F6D701272402D1E7D8D316CCE519123 is the official key of elaneglobal.com, bound\ \ to the domain api.elaneglobal.com. \nUsers 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.\nTo trial the service, please\ \ contact our support team: support@elaneglobal.com. " tags: - China Coastline Warning 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_time in: query description: Used to filter the publish time of navigation warnings. required: true example: 2024-07-21 20:00 schema: type: string - name: end_time in: query description: Used to filter the publish time of navigation warnings. required: true example: 2024-09-21 20:00 schema: type: string - name: warning_type in: query description: 'Filter by warning type. 0=Default (all types returned); 1=Military operations; 2=Vessel drills; 3=Live-fire exercises; 4=Vessel operations; 5=AtoN (Aids to Navigation) dynamics; 6= Vessel grounding; 7=Vessel sea trials; 8=Sinking / Shipwreck; 9=Casualties; 10=Construction operations; 11=Navigation warning cancellation; 12=Others' required: false schema: type: string responses: '200': description: Success. HTTP 200 with a JSON envelope whose "status" field is 0. content: application/json: schema: type: object properties: status: type: integer msg: type: string total: type: integer description: Total number of navigation warnings within the query period data: type: array items: type: object properties: warning_type: type: integer description: 1=Military operations; 2=Vessel drills; 3=Live-fire exercises; 4=Vessel operations; 5=AtoN (Aids to Navigation) dynamics; 6= Vessel grounding; 7=Vessel sea trials; 8=Sinking / Shipwreck; 9=Casualties; 10=Construction operations; 11=Navigation warning cancellation; 12=Others source: type: string description: China Maritime Safety Administration (MSA) title: type: string description: Navigation warning title range_type: type: integer description: 1=Single coordinate point; 2=Polygon area; 3=Circular area; 4=No coordinate information range_points: type: string description: 'Coordinate system WGS84. Longitude and latitude are separated by comma , . Multiple coordinates are separated by semicolon ;.Multiple areas are separated by &.' expire_time: type: string description: 'Format: YYYY-MM-DD HH:MM, UTC+8' pub_time: type: string description: 'Format: YYYY-MM-DD HH:MM, UTC+8' content: type: string description: Navigation warning content required: - warning_type - source - title - range_points - pub_time - content - range_type - expire_time x-apifox-orders: - warning_type - source - title - range_type - range_points - expire_time - pub_time - content description: Navigation warning information required: - status - msg - total - data x-apifox-orders: - status - msg - total - data example: "{\r\n \"status\": 0,\r\n \"msg\": \"\",\r\n \"total\": 158,\r\n \"data\": [\r\ \n {\r\n \"warning_type\": 12,\r\n \"source\": \"中国海事局\",\r\n \ \ \"title\": \"TRIAL VOYAGE-H561-SD442/25\",\r\n \"range_type\": 2,\r\n \ \ \"range_points\": \"120.233333,38.416667;120.450000,38.416667;120.450000,38.208333;120.233333,38.279167&121.716667,38.500000;121.916667,38.500000;121.916667,38.250000;121.716667,38.333333&123.166667,37.800000;123.191667,37.800000;123.191667,37.783333;123.166667,37.783333\"\ ,\r\n \"expire_time\": \"2025-07-14 12:00:00\",\r\n \"pub_time\": \"2025-07-09\ \ 13:40:00\",\r\n \"content\": \"

SD442/25，BOHAI STRAIT, FROM\ \  092200UTC  TO  111400UTC  JUL，H561 TRIAL VOYAGE IN AREA 1 BOUNDED\ \ BY THE LINES JOINING 38-25.00N 120-14.00E、38-25.00N 120-27.00E、38-12.50N 120-27.00E、38-16.75N\ \ 120-14.00E AND AREA 2 BOUNDED BY THE LINES JOINING 38-30.00N 121-43.00E、38-30.00N 121-55.00E、38-15.00N\ \ 121-55.00E、38-20.00N 121-43.00E.FROM  111400UTC  TO  120200UTC  JUL,H561\ \ TRIAL VOYAGE IN AREA 3 BOUNDED BY THE LINES JOINING 37-48.00N 123-10.00E、37-48.00N 123-11.50E、37-47.00N\ \ 123-11.50E、37-47.00N 123-10.00E.FROM 120200UTC TO 141200UTC JUL,H561 TRIAL VOYAGE IN AREA 2 BOUNDED\ \ BY THE LINES JOINING 38-30.00N 121-43.00E、38-30.00N 121-55.00E、38-15.00N 121-55.00E、38-20.00N\ \ 121-43.00E.CAUTION TO AVOID. SHANDONG MSA CHINA.

\"\r\n },\r\n {\r\n \ \ \"warning_type\": 12,\r\n \"source\": \"中国海事局\",\r\n \"title\": \"黄浦江7月11日水上交通管制-沪航警455/25\"\ ,\r\n \"range_points\": \"\",\r\n \"pub_time\": \"2025-07-09 13:15:00\",\r\ \n \"content\": \"

沪航警455/25黄浦江7月11日0815时至0945时，在黄浦江苏州河口至轮渡泰公线之间水域范围内进行帆船展示，届时实行水上交通管制，请过往船舶注意。

\"\ \r\n },\r\n {\r\n \"warning_type\": 12,\r\n \"source\": \"中国海事局\"\ ,\r\n \"title\": \"中华人民共和国重庆海事局航行警告（渝航警50/25）\",\r\n \"pub_time\": \"2025-07-09\ \ 13:00:00\",\r\n \"content\": \"

渝航警50/25“长江救捞一号”轮拖带“航道趸03604”由猪圈门航道码头（长江上游航道里程723km）至扁担石航道基地（长江上游航道里程731km）。

\\\ n\\n

计划运行时刻：拟定于2025年7月10日1000时船队在猪圈门航道码头编队开航上行，1100时抵达扁担石航道基地。

\\n\\n

请过往船舶加强瞭望，主动与该拖带船队联系，辨明动态，提早统一会让意图，谨慎操作，以策安全。

\"\ \r\n },\r\n {\r\n \"warning_type\": 3,\r\n \"source\": \"中国海事局\"\ ,\r\n \"title\": \"冀航警379/25 军事任务\",\r\n \"range_points\": \"\",\r\n \ \ \"pub_time\": \"2025-07-09 11:28:00\",\r\n \"content\": \"

冀航警379/25，渤海，7月10日0000时至7月11日2400时，

\\\ n\\n

以N 39°24′35″、E 119°13′44″为顶点，正东方向至N 39°24′35″、E 119°17′32″，再至N 39°19′21″、E 119°29′47″端点，顶点正南偏西6°方向至N 39°11′16″、E 119°11′54″端点，以顶点为中心半径25公里的部分圆弧将两个端点连接，形成不规则的闭合范围。该区域内进行实弹射击活动。禁止驶入。

\"\ \r\n },\r\n {\r\n \"warning_type\": 12,\r\n \"source\": \"中国海事局\"\ ,\r\n \"title\": \"MILITARY MISSION——LN222/25\",\r\n \"range_type\": 2,\r\n\ \ \"range_points\": \"121.636667,38.861667;121.636667,38.570000;121.131667,38.565000;121.235000,38.803333\"\ ,\r\n \"expire_time\": \"2025-07-27 16:00:00\",\r\n \"pub_time\": \"2025-07-09\ \ 11:00:00\",\r\n \"content\": \"

LN222/25 BOHAI STRAIT AND NORTH YELLOW SEA MILITARY\ \ MISSION IN AREA BOUNDED BY THE LINES JOINING 38-51.7N121-38.2E,38-34.2N121-38.2E,38-33.9N121-07.9E,38-48.2N121-14.1E\ \ FROM 130800UTC TO 270800UTC JUL.ENTERING PROHIBITED. LIAONING MSA CHINA.

\"\r\n },\r\ \n {\r\n \"warning_type\": 1,\r\n \"source\": \"中国海事局\",\r\n \ \ \"title\": \"军事任务——辽航警222/25\",\r\n \"range_type\": 2,\r\n \"range_points\"\ : \"121.636667,38.861667;121.636667,38.570000;121.131667,38.565000;121.235000,38.803333\",\r\n \ \ \"expire_time\": \"2025-07-27 16:00:00\",\r\n \"pub_time\": \"2025-07-09\ \ 10:59:00\",\r\n \"content\": \"

辽航警222/25，渤海海峡黄海北部，自7月13日1600时至27日1600时在38-51.7N121-38.2E、38-34.2N121-38.2E、38-33.9N121-07.9E、38-48.2N121-14.1E诸点连线范围内执行军事任务。禁止驶入。

\"\ \r\n },\r\n {\r\n \"warning_type\": 12,\r\n \"source\": \"中国海事局\"\ ,\r\n \"title\": \"YANGANGRONGHEQIHAO AND YANGANGRONGHEBAHAO TOWING ZHAOSHANGZHONGGONG3-SD441/25\"\ ,\r\n \"range_type\": 4,\r\n \"range_points\": \"121.450000,37.600000;121.583333,37.666667;122.158333,37.666667;122.275000,37.520833;122.263333,37.507000;122.228333,37.480000\"\ ,\r\n \"expire_time\": \"2025-07-11 16:00:00\",\r\n \"pub_time\": \"2025-07-09\ \ 10:53:00\",\r\n \"content\": \"

SD441/25,BOHAI SEA,FROM 090800UTC TO  110800UTC\ \ JUL,TUG YANGANGRONGHEQIHAO AND YANGANGRONGHEBAHAO TOWING ZHAOSHANGZHONGGONG3,FROM 37-36.00N 121-27.00E TO\ \ 37-28.25N 122-13.83E,MAINLY VIA:37-40.00N 121-35.00E, 37-40.00N 122-09.50E,37-31.24N 122-16.50E,37-30.42N\ \ 122-15.80E, 37-28.80N 122-13.70E,TOWING LENGTH 400 METERS,SPEED 5 KNOTS.CAUTION TO AVOID.SHANDONG\ \ MSA CHINA.

\"\r\n },\r\n {\r\n \"warning_type\": 12,\r\n \ \ \"source\": \"中国海事局\",\r\n \"title\": \"拖带作业-烟港融合七号、烟港融合八号拖带招商重工3-鲁航警494/25\",\r\n\ \ \"range_type\": 4,\r\n \"range_points\": \"121.45,37.6;122.230556,37.470833;121.583333,37.666667;122.158333,37.666667;122.275,37.404;122.263333,37.390333;122.228333,37.363\"\ ,\r\n \"expire_time\": \"2025-07-11 16:00:00\",\r\n \"pub_time\": \"2025-07-09\ \ 10:52:00\",\r\n \"content\": \"

鲁航警494/25，渤海海峡，7月9日1600时至11日1600时，烟港融合七号、烟港融合八号拖带招商重工3,自37-36.00N\ \ 121-27.00E至37-28.25N 122-13.83E，主要经过以下各点：37-40.00N 121-35.00E、37-40.00N 122-09.50E、37-31.24N 122-16.50E、37-30.42N\ \ 122-15.80E、37-28.80N 122-13.70E，拖带长度400米，航速5节。注意避让。

\"\r\n },\r\n {\r\n \ \ \"warning_type\": 4,\r\n \"source\": \"中国海事局\",\r\n \"title\": \"\ 水深测量—津航警242/25\",\r\n \"expire_time\": \"2025-07-25 18:00:00\",\r\n \"pub_time\"\ : \"2025-07-09 09:36:00\",\r\n \"content\": \"

津航警242/25 天津港 自7月10日至25日，每天0600时至1800时，由顺航测11轮在大沽口港区大沽沙航道及附近水域进行水深测量作业。希各航船注意。

\"\ \r\n },\r\n ......\r\n ]\r\n}" headers: {} x-apifox-name: success security: - apiKeyQuery: [] x-apifox-folder: 6 China Region Coastline Warning Dataset x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7948067/apis/api-431872073-run operationId: getNavigationalWarnings externalDocs: description: 6.1 China Region Navigational Warnings url: https://docs.shipfinder.com/431872073e0 components: securitySchemes: apiKeyQuery: type: apiKey in: query name: key description: ShipFinder API key, created in the console at https://open.shipfinder.com/v1/console/overview. Starter (trial) keys are self-service; Custom (production) keys require per-service enablement by the ShipFinder business team. Keys may be bound to a domain (return code 14 = request from unbound domain). x-evidence: harvested: '2026-08-09' method: searched index: https://docs.shipfinder.com/llms.txt operations: 40 note: Path/operation content verbatim from provider-published fragments; see -openapi-original.yml.