openapi: 3.2.0 info: title: ShipFinder Global Maritime Data 7 Event Dataset/7.2… description: Verbatim assembly of the per-endpoint OpenAPI 3.0.1 fragments ShipFinder publishes on docs.shipfinder.com (one fragment per endpoint page, indexed by the provider llms.txt). Path items are reproduced exactly as published; only the enclosing document (info/servers/tags) is API Evangelist assembly. No operation content was altered. version: 1.0.0 servers: [] tags: - name: 7 Event Dataset/7.2 Geofence Monitoring Push paths: /v1/Event/AddGeofence: post: summary: 7.2.1 Geofence Creation deprecated: false description: '' tags: - 7 Event Dataset/7.2 Geofence Monitoring Push 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: '0': description: '' 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: [] 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: postV1EventAddGeofence x-operation-id-source: derived /v1/Event/DeleteGeofence: delete: summary: 7.2.4 Geofence Deletion deprecated: false description: '' tags: - 7 Event Dataset/7.2 Geofence Monitoring Push 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: '0': description: '' 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: [] 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: deleteV1EventDeleteGeofence x-operation-id-source: derived /v1/Event/GetGeofence: get: summary: 7.2.3 Geofence Query deprecated: false description: '' tags: - 7 Event Dataset/7.2 Geofence Monitoring Push 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: '0': description: '' 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: [] 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: getV1EventGetGeofence x-operation-id-source: derived /v1/Event/UpdateGeofence: post: summary: 7.2.2 Geofence Update deprecated: false description: '' tags: - 7 Event Dataset/7.2 Geofence Monitoring Push 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: '0': description: '' 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: [] 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: postV1EventUpdateGeofence x-operation-id-source: derived x-evidence: harvested: '2026-08-09' index: https://docs.shipfinder.com/llms.txt index_http_status: 200 fragments: 40 note: Each path item was extracted verbatim from the "## OpenAPI Specification" yaml block on the corresponding docs page. The provider publishes no consolidated OpenAPI document. sources: - path: /v1/AIS/FleetPosition method: GET title: 1.1.3 Fleet Position source: https://docs.shipfinder.com/430293359e0.md - path: /v1/AIS/VesselFlagInfo method: GET title: 1.5 Vessel Flag Information source: https://docs.shipfinder.com/429919472e0.md - path: /v1/AIS/VesselPositionMulti method: GET title: 1.1.2 Multi-vessel Position source: https://docs.shipfinder.com/430292321e0.md - path: /v1/AIS/VesselPositionSingle method: GET title: 1.1.1 Single Vessel Position source: https://docs.shipfinder.com/428990613e0.md - path: /v1/AIS/VesselSearch method: GET title: 1.2 Vessel Search source: https://docs.shipfinder.com/428749512e0.md - path: /v1/AIS/VesselsInZone method: GET title: 1.4 Vessels in Zone source: https://docs.shipfinder.com/429583708e0.md - path: /v1/AIS/VesselsNearby method: GET title: 1.3 Vessels Nearby source: https://docs.shipfinder.com/429003024e0.md - path: /v1/Event/AddFleet method: POST title: 7.1.1 Create Fleet source: https://docs.shipfinder.com/432035260e0.md - path: /v1/Event/AddGeofence method: POST title: 7.2.1 Geofence Creation source: https://docs.shipfinder.com/433382008e0.md - path: /v1/Event/AddVesselSpeedAlert method: POST title: 7.3.1 Add Vessel Speed Alert Subscription source: https://docs.shipfinder.com/433460139e0.md - path: /v1/Event/AddVesselToFleet method: POST title: 7.1.5 Add Vessels to Fleet source: https://docs.shipfinder.com/432100231e0.md - path: /v1/Event/DeleteFleet method: POST title: 7.1.4 Delete Fleet source: https://docs.shipfinder.com/432076110e0.md - path: /v1/Event/DeleteFleetVessel method: POST title: 7.1.7 Remove Vessels from Fleet source: https://docs.shipfinder.com/432106004e0.md - path: /v1/Event/DeleteGeofence method: DELETE title: 7.2.4 Geofence Deletion source: https://docs.shipfinder.com/433422419e0.md - path: /v1/Event/DeleteVesselSpeedAlert method: POST title: 7.3.2 Delete Vessel Speed Alert Subscription source: https://docs.shipfinder.com/433471968e0.md - path: /v1/Event/GetFleet method: GET title: 7.1.3 Query Fleet source: https://docs.shipfinder.com/432057101e0.md - path: /v1/Event/GetGeofence method: GET title: 7.2.3 Geofence Query source: https://docs.shipfinder.com/433414777e0.md - path: /v1/Event/UpdateFleetInfo method: POST title: 7.1.2 Update Fleet Information source: https://docs.shipfinder.com/432048484e0.md - path: /v1/Event/UpdateFleetVessel method: POST title: 7.1.6 Batch Update Vessels in Fleet source: https://docs.shipfinder.com/432080706e0.md - path: /v1/Event/UpdateGeofence method: POST title: 7.2.2 Geofence Update source: https://docs.shipfinder.com/433396710e0.md - path: /v1/Event/VesselSpeedAlertList method: GET title: 7.3.3 Query Vessel Speed Alert Subscription List source: https://docs.shipfinder.com/433473614e0.md - path: /v1/History/PortCallRecordsByPort method: GET title: 3.6 Port Calls Records for Port source: https://docs.shipfinder.com/430531632e0.md - path: /v1/History/PortCallRecordsByVessel method: GET title: 3.3 Vessel Port Call History source: https://docs.shipfinder.com/430426234e0.md - path: /v1/History/PortCallRecordsByVesselAtPort method: GET title: 3.4 Vessel Port Call Records at Specific Port source: https://docs.shipfinder.com/430484162e0.md - path: /v1/History/VesselCurrentPortCall method: GET title: 3.5 Vessel Current Port Call source: https://docs.shipfinder.com/430498718e0.md - path: /v1/History/VesselHistoryTrack method: GET title: 3.1 Vessel History Track source: https://docs.shipfinder.com/430346103e0.md - path: /v1/History/VesselStsEvents method: GET title: 3.2 Ship-to-Ship (STS) Events source: https://docs.shipfinder.com/430352093e0.md - path: /v1/Meteorology/CycloneInfo method: GET title: 5.1.2 Tropical Cyclone Details by Point source: https://docs.shipfinder.com/431698143e0.md - path: /v1/Meteorology/CyclonesList method: GET title: 5.1.1 Global Tropical Cyclones List source: https://docs.shipfinder.com/431698053e0.md - path: /v1/Meteorology/MarineWeather method: GET title: 5.3 Global Marine Weather source: https://docs.shipfinder.com/431272522e0.md - path: /v1/Meteorology/TideStationInfo method: GET title: 5.2.2 Query Single Tide Gauge Station Details source: https://docs.shipfinder.com/431865286e0.md - path: /v1/Meteorology/TideStationList method: GET title: 5.2.1 Request parameters for Global Tide Gauge Stations List source: https://docs.shipfinder.com/431857907e0.md - path: /v1/Prediction/ETA method: GET title: 4.3 ETA Query source: https://docs.shipfinder.com/431244206e0.md - path: /v1/Prediction/RoutePlanPointToPoint method: GET title: 4.1 Point-to-Point Route Planning source: https://docs.shipfinder.com/431124483e0.md - path: /v1/Prediction/RoutePlanPortToPort method: GET title: 4.2 Port-to-Port Route Planning source: https://docs.shipfinder.com/431244012e0.md - path: /v1/Voyage/PortAnchoredVessels method: GET title: 2.3 Currently Anchored Vessels source: https://docs.shipfinder.com/430236145e0.md - path: /v1/Voyage/PortBerthedVessels method: GET title: 2.2 Currently Berthed Vessels source: https://docs.shipfinder.com/430197412e0.md - path: /v1/Voyage/PortExpectedArrivals method: GET title: 2.4 Inbound / Expected Arrivals source: https://docs.shipfinder.com/430249182e0.md - path: /v1/Voyage/PortInfo method: GET title: 2.1 Port Information source: https://docs.shipfinder.com/429932201e0.md - path: /v1/Warning/NavigationalWarnings method: GET title: 6.1 China Region Navigational Warnings source: https://docs.shipfinder.com/431872073e0.md