Sign Up & Log In

  1. Open ShipFinder and click API in the top navigation to enter the API homepage.


  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.)
  3. New users can register instantly using a Google account for one-click sign-up.
  4. After logging in, click API to access the Console.

Create Your API Key

  1. In the Console sidebar, click My API Keys to enter the key management interface.
  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.
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.)

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.

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.

Push-Based Services

In the Console, navigate to My API Keys to access fleet and zone management.

Note: Before configuring a webhook URL, ensure that your endpoint is ready to receive push data.

Create a Monitored Fleet

  1. Add a fleet — Click Add Fleet to create a vessel watchlist and associate it with the desired push permissions.


  2. Configure the URL — In the Webhook URL Management section, enter the endpoint that will receive push notifications.

Create a Monitored Zone (Geofence Alerts)

  1. Add a zone — Click Add Area to define a geographic area to monitor.
  2. Set vessel filters — Click Filter to choose whether to monitor all vessels, filter by vessel type, or restrict alerts to your own fleet.
  3. Configure the URL — In the Webhook URL Management section, enter the endpoint that will receive push notifications.

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.

Important Notes

  1. Data Format — Ensure that request payloads 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.

Contact Us

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

  Email: shipfinder@elaneglobal.com

Support

For technical assistance during integration, reach out to the ShipFinder support team.

Email: support@elaneglobal.com