ShipFinder
    • Global Maritime Data API Documentation
    • Shipfinder API Integration Tutorial
    • 1 AIS Dataset
      • 1.1 Vessel Position
        • 1.1.1 Single Vessel Position
        • 1.1.2 Multi-vessel Position
        • 1.1.3 Fleet Position
      • 1.2 Vessel Search
        GET
      • 1.3 Vessels Nearby
        GET
      • 1.4 Vessels in Zone
        GET
      • 1.5 Vessel Flag Information
        GET
    • 2 Voyage Dataset
      • 2.1 Port Information
        GET
      • 2.2 Currently Berthed Vessels
        GET
      • 2.3 Currently Anchored Vessels
        GET
      • 2.4 Inbound / Expected Arrivals
        GET
    • 3 History Dataset
      • 3.1 Vessel History Track
        GET
      • 3.2 Ship-to-Ship (STS) Events
        GET
      • 3.3 Vessel Port Call History
        GET
      • 3.4 Vessel Port Call Records at Specific Port
        GET
      • 3.5 Vessel Current Port Call
        GET
      • 3.6 Port Calls Records for Port
        GET
    • 4 Prediction Dataset
      • 4.1 Point-to-Point Route Planning
        GET
      • 4.2 Port-to-Port Route Planning
        GET
      • 4.3 ETA Query
        GET
    • 5 Meteorology Dataset
      • 5.1 Global Tropical Cyclone
        • 5.1.1 Global Tropical Cyclones List
        • 5.1.2 Tropical Cyclone Details by Point
      • 5.2 Global Port Tide Predictions
        • 5.2.1 Request parameters for Global Tide Gauge Stations List
        • 5.2.2 Query Single Tide Gauge Station Details
      • 5.3 Global Marine Weather
        GET
    • 6 China Region Coastline Warning Dataset
      • 6.1 China Region Navigational Warnings
        GET
    • 7 Event Dataset
      • 7.1 Monitored Fleet Management
        • 7.1.1 Create Fleet
        • 7.1.2 Update Fleet Information
        • 7.1.3 Query Fleet
        • 7.1.4 Delete Fleet
        • 7.1.5 Add Vessels to Fleet
        • 7.1.6 Batch Update Vessels in Fleet
        • 7.1.7 Remove Vessels from Fleet
      • 7.2 Geofence Monitoring Push
        • 7.2.1 Geofence Creation
        • 7.2.2 Geofence Update
        • 7.2.3 Geofence Query
        • 7.2.4 Geofence Deletion
        • 7.2.5 Geofence Monitoring Push
      • 7.3 Vessel Speed Alert Push
        • 7.3.1 Add Vessel Speed Alert Subscription
        • 7.3.2 Delete Vessel Speed Alert Subscription
        • 7.3.3 Query Vessel Speed Alert Subscription List
        • 7.3.4 Vessel Speed Anomaly Push
      • 7.4 Real-time Vessel Position Push
      • 7.5 Arrival/Departure Event Push
      • 7.6 Vessel Dynamic ETA Push
      • 7.7 Vessel AIS Signal Loss Event Push
      • 7.8 Vessel STS Event Push
    • Appendix
      • Vessel Type Comparison Table
      • Service Return Code
      • Sea Area Reference Table
      • Navigation Status Comparison Table
      • Deviation Node List
      • Aids to Navigation (AtoN) Type Table

    Shipfinder API Integration Tutorial

    1. Sign Up & Log In#

    1.
    Open ShipFinder and click API in the top navigation to enter the API homepage.
    image 10.png
    2.
    Click the avatar icon in the upper-right corner to log in. If you are a new user, please register a ShipFinder account first. (Existing users may log in directly.)
    image 1.png
    3.
    New users can register instantly using a Google account for one-click sign-up.
    image 6.png
    4.
    After logging in, click API to access the Console.
    image 3.png

    2. Create Your API Key#

    1.
    In the Console sidebar, click My API Keys to enter the key management interface.
    image 5.png
    2.
    Click Create API Key. You may create a key based on your intended use case — either a Starter (Trial) Key for personal evaluation or a Custom (Production) Key for live workloads.
    Note: Each account may hold a maximum of 5 API keys.
    “Starter (Trial) Key”
    Fill in the required information to generate a Starter key. This key is provisioned with a preset permission scope to help you validate core functionality and run integration tests.
    image 13.png
    “Custom (Production / Test) Key”
    Fill in the required information and select the services you need. A newly created Custom key has no active services by default. Our business team will reach out via email to confirm your requirements and enable the corresponding permissions within one business day.(You may hold one Starter key per account.)
    image 9.png
    3.
    Once created, your key will appear in the key list. Click to copy it for use in your application.
    A Starter key is ready for immediate use in personal development and testing.
    A Custom key requires service activation by the business team before it becomes operational.
    image 14.png

    3. Send Requests & Receive Data#

    1.
    Construct the HTTP request URL — Refer to the API Documentation to build your request URL and include your API key as a required parameter.
    2.
    Receive the response — ShipFinder returns data in JSON or binary format.
    3.
    Parse the payload — Extract and process the response data according to your business logic.

    4. Push-Based Services#

    In the Console, navigate to FLEET & Areas to access fleet and zone management.
    Note: Before configuring a webhook URL, ensure that your URL is ready to receive push data.
    image 7.png

    4.1 Create a Monitored Fleet#

    1.
    Add a fleet — Click Add Fleet to create a vessel watchlist and associate it with the desired push permissions.
    image 8.png
    2.
    Configure the URL — In the Webhook URL Management section, enter the URL that will receive push notifications.
    image 2.png

    4.2 Create a Monitored Zone (Geofence Alerts)#

    1.
    Add a zone — Click Add Area to define a geographic area to monitor.
    image 4.png
    2.
    Set vessel filters — Click Filter to choose whether to monitor all vessels, filter by vessel type, or restrict alerts to your own fleet.
    image 12.png
    3.
    Configure the URL — In the Webhook URL Management section, enter the URL that will receive push notifications.
    image.png
    Note: If you have multiple zones that need to push to different URLs, configure a separate webhook URL inside each zone. When a zone-level URL is set, it takes priority over the global webhook address。
    image 11.png

    5. Important Notes#

    1.
    Data Format — Ensure that request format conform to the formats specified in the API documentation. Incorrect formatting may cause request failures or parsing errors.
    2.
    Permission Management — Manage your API key permissions carefully. Insufficient or excessive permissions may impact operational stability.

    6. Contact Us#

    If you need to activate additional services for an API key, or require advanced capabilities, please contact our business team.

    Support#

    For technical assistance during integration, reach out to the ShipFinder support team.
    Email: support@elaneglobal.com
    Previous
    Global Maritime Data API Documentation
    Next
    1.1 Vessel Position