Introduction

What is the Onshore API about?

Access your Hoppe sensor and system data at any time through our cloud-based API, powered by our Data Butler and Data Inspector Services for ship‑to‑shore data transmission. Seamlessly integrate vessel sensor data into your preferred platform or data warehouse.

The API follows industry‑standard REST principles, ensuring simple, reliable, and well‑structured data access.

Who is the Onshore API specification for?

This specification is intended for developers, data analysts, and other onshore professionals integrating Hoppe sensor and system data.

For monitoring data transmission, checking data quality, troubleshooting, or performing occasional data downloads, please use our Fleet Connect portal.

What does the API feature?

The API enables smooth data integration and provides:

• Access to vessel details
• Metadata for sensor and system notifications
• Export of sensor data as time series
• Export of system notifications as an event log

Use Cases for data integration:

• Data Integration: Feed data into your data warehouse or analytics tools for comprehensive analysis.
• Verification: Compare and validate manually reported values or emission reports.
• Case Studies: Build case studies for retrofit validation or evaluating energy‑saving devices.
• Hull Evaluation: Supply hull models with sensor data to evaluate hull fouling and optimize performance.

You are welcome to explore additional use cases beyond these examples.

Service & Support

Our Data Solutions team consists of experienced data analysts, developers, and maritime experts.

Whether you have questions, encounter technical issues, need support with the API, or require assistance on integration projects, we are here to help.

Get access

How can I create and register a user account?​

To use the Onshore API and the Fleet Connect Portal, you must first request and register a user account. Please contact the user group administrator of your organization or email your request to datasolutions@hoppe-marine.com.

You will receive a one‑time password for account activation. Log in using this temporary password, set a new password, and you can then access the Fleet Connect portal with your registered email address.

I have activated an user account but I don't have access to data. How do I get access to vessel data?

To access the data of a specific vessel, you must either:

• Contact the administrator of the data owner or
• Contact Hoppe Support at datasolutions@hoppe-marine.com

If you contact Hoppe Support directly, please verify your identity and include:

• Your use case
• The email address associated with your user account
• A list of IMO numbers for which you received access permission from the data owner

Hoppe Support will then contact the data owner to confirm your request.

As a user group administrator, you can grant access by inviting users to the Fleet Connect portal. You may also create subgroups for more fine‑grained access control.

How can I create or manage my API key to use the Onshore APIs?​

Before using the Onshore API, you must create an API key. In the Fleet Connect portal:

1. Open the burger menu (top-right corner).
2. Select Manage API Keys.
3. In the pop‑up window, click New API Key.
4. Provide a meaningful description to distinguish keys later.

How to use the API key?

Include the API key in the Authorization header for every request:

Authorization: ApiKey <API-KEY-VALUE>

Example Python code:

import os
import requests

IMO = "...IMO-NUMBER..."
API_KEY = "...API-KEY-VALUE..."
API_URL = "https://api.hoppe-sts.com/"

request_url = f"{API_URL}fleet/{IMO}/timeseries?from_date=2024-05-01T13:00:00&to_date=2024-05-01T14:00:00"
response = requests.request("GET", request_url, headers={"Authorization": f"ApiKey {API_KEY}"})

We recommend rotating keys periodically. Annual rotation provides a good balance between security and effort. After generating a new key, update your applications and then deactivate the old key in the API key management console.

Testing the APIs​

To help you get started, the FAQ below includes several example API calls and explanations.

Are there limits when using the API? (Status code 429)

Yes. To protect our shore-side infrastructure and ensure stable service for all users, several technical limits apply when using the API.

These safeguards help maintain reliable operation, especially in cases of software bugs or unusually high request rates. The limits are designed with generous margins so that normal, intended usage should never be affected.

Usage limits

• Spike protection: Excessive short‑interval traffic may trigger temporary blocking based on API key or IP address
• Daily request quota: max. 70,000 requests per customer
• Daily volume quota: max. 30 GB per vessel, covering both
  • returned time‑series response data (responses from endpoints that deliver files or time‑series values),
  • and scanned data (the amount of data our backend must read in the time‑series database to produce such responses).
  • Any request that touches our time‑series database counts as at least 10 MB of scanned data.

In all cases above, the API responds with Limit exceeded (HTTP 429). You can monitor your current usage via the api-usage endpoint in the Fleet API.

If you need assistance or require higher quotas, please contact datasolutions@hoppe-marine.com. We will review your specific use case and adjust the limits when appropriate.

Contract-based access limitation (Status code 402)

The API grants only access to data covered by your contract period. The API may respond with status code 402 to indicate access limitation due to limited contract period.

You can view your contract information in the Fleet Connect portal:

• Open the burger menu (top right)
• Select Contract List

FAQ

I have a technical issue or need help integrating the API. Whom should I contact?

For all API‑related and Fleet Connect matters, please email datasolutions@hoppe-marine.com.

I need a list of vessels I have access to. Which endpoint should I use?

Use the ship information endpoint of the Fleet API.

I want to know which signals are available for a vessel. What should I use?

Use the signal mapping endpoint. It returns all signals currently transmitted from the vessel, including metadata (friendly names, units, limits, groups).

Are metadata (units, descriptions, limits, …) available?

Yes. Each signal contains additional metadata.

The most important field is the machine code, which uniquely identifies each signal and encodes technical properties.

The friendly name provides a human‑readable description.

I want to export time series data. Which endpoint should I use?

Use the timeseries endpoint. You may specify date ranges and signals.

What limitations apply to the time series endpoint?

Due to the high amount of data which can be expected from the time series endpoint the following limitations must be taken into account:

• You can query all signals for a period of up to 24 hours
• You can query up to 50 signals for a period up to 30 days.

For optimal performance, we recommend downloading data in the largest reasonable chunks rather than making many small requests.

How frequently is the data updated?

Update frequency depends on export settings and vessel connectivity. Typical intervals: every 5 minutes or 1 hour. If the vessel is offline, data is transmitted once connectivity is restored. You can monitor vessel status via Fleet Connect.

Can received data be edited or deleted on our Cloud server?

No. Data cannot be edited onboard or onshore. In rare cases, Hoppe may delete corrupted data in close coordination with the customer.

Can signal list be changed?

Yes, but rarely. The signal list depends on the vessel's export configuration, which typically remains stable after successful commissioning.

When is the vessel list updated?d?

Whenever a vessel joins or leaves your fleet.

If a commissioned online vessel is missing from the portal or API, this may indicate a missing service contract.

Can I export system notifications from the vessel?

Yes. Use the event notifications endpoint to export system notifications (alerts, also known as HOWAF events).