Introduction – Sea API Portal

The Sea API Portal is the central access point for a suite of customer-facing APIs designed to support our customers.
Through this portal, users can access multiple API products such as:

  • Charter Party API – streamline charter party contract data and workflows.

  • Carbon API – monitor, calculate, and report emissions data for sustainability compliance.

  • (and other Sea API products as available)

Each API is built to provide secure, reliable, and real-time data exchange.
The portal ensures:

  • Single authentication mechanism – one login for all API products.

  • High availability – accessible 24/7, 365 days a year.

  • Scalability – built to handle growing data and request volumes.

With the Sea API Portal, customers can easily integrate maritime data into their systems to drive operational efficiency, compliance, and transparency.

Sea API Portal – Authentication & Usage Guide

The Sea API Portal hosts multiple customer-facing API products (e.g., Charter Party API, Carbon API, etc).
All APIs use the same authentication mechanism.

Step 1: Token Issuance (Login)

Endpoint:
POST https://sea-api.portal.com/api/auth.json
(replace sea-api.portal.com with the actual base URL of your portal)

Headers:

Content-Type: application/x-www-form-urlencoded

Request Body:

ParameterTypeRequiredDescriptionuidstringYesAPI User IDpasswordstringYesAPI Password

Example (cURL):

curl --location 'https://sea-api.portal.com/api/auth.json' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'uid=YOUR_USER_ID' \
  --data-urlencode 'password=YOUR_PASSWORD'

Response (200 OK):

{"tokenId": "16d5edb8-4a24-48f7-bd9a-94548bdbbc89" }

Save this tokenId. It will be used in all subsequent API calls.

Step 2: Using the Token

For any API product (e.g., Charter Party API, Carbon API), include the token in the request headers:

Authorization: Bearer <tokenId>

Example (fetching Charter Party API data):

curl --location 'https://sea-api.portal.com/api/charterparty/v1/contracts' \
  --header 'Authorization: Bearer 16d5edb8-4a24-48f7-bd9a-94548bdbbc89'

Token Lifecycle

  • Tokens are issued per login session.

  • Expiration details depend on your subscription plan (check API product documentation).

  • If expired, repeat Step 1 to re-authenticate.

⚠️ Error Handling

 

Status CodeMeaning200 OKToken issued successfully.204 No ContentRequest succeeded but no new data available.400 Bad RequestInvalid request format / syntax error in parameters.401 UnauthorizedWrong User ID, Password, or expired token.403 ForbiddenYou don’t have permission to access this API data.404 Not FoundInvalid resource or unsupported API endpoint.429 Too Many RequestsRate limiting — too many requests in a given timeframe.500 Internal Server ErrorUnexpected server-side failure.