Getting Started

Welcome to the Logistics & Vessels API documentation. Our API provides comprehensive access to maritime logistics and vessel tracking data.

Quick Start

# Install using npm
npm install @vessels/tracking-sdk

# Or using yarn
yarn add @vessels/tracking-sdk

import { VesselsAPI } from '@vessels/tracking-sdk';

const api = new VesselsAPI('YOUR_API_KEY');

// Get vessel information
const vessel = await api.getVessel('9876543');

// Track vessel position
const position = await api.getVesselPosition('9876543');

// Subscribe to real-time updates
api.subscribe('9876543', (update) => {
  console.log('New position:', update);
});

Authentication

All API requests require an API key. Include it in the header of your requests:

Authorization: Bearer YOUR_API_KEY

Base URL

https://api.logistics-vessels.com/v1

Rate Limits

Plan	Requests/Day	WebSocket Connections
Free	1,000	1
Pro	10,000	5
Enterprise	Custom	Unlimited

Error Handling

The API uses conventional HTTP response codes:

• 200: Success
• 400: Bad Request
• 401: Unauthorized
• 403: Forbidden
• 404: Not Found
• 429: Too Many Requests
• 500: Server Error

Support

Need help? Contact our support team:

• Email: support@vessels-api.com
• Documentation: https://docs.vessels-api.com
• Status Page: https://status.vessels-api.com