MarineTraffic Containers API (1.7.0)

Download OpenAPI specification:Download

Introduction

The MarineTraffic Containers API is your way to access state-of-the-art real-time visibility for containers logistics.
For more information, please visit the solution landing page.

Get your API key

To get access to the solution, please reach out to sales@kpler.com.
If you have already issued one, sign in to marinetraffic.com and go to My API Services page to retrieve it.
The API key must be specified in all requests as the value of the API header X-Container-API-Key.

Rate Limits

The API enforces a rate limit of 500 requests per minute.
Exceeding this limit will result in a 429 Too Many Requests HTTP response.

  • Authenticated requests are tracked based on the associated API key.
  • Unauthenticated requests are monitored based on the originating IP address.

IP Whitelisting

To enhance network security, you may whitelist the following IP addresses:

  • API Requests: All requests to the API will be directed exclusively to the following IP address(es): 13.248.154.30, 76.223.25.242.
  • Webhooks: Webhooks will only be dispatched from the following IP address(es): 3.251.15.122, 52.215.44.244, 54.195.123.104.

Terminal Congestion

Access near real-time terminal congestion insights including:

  • Live Congestion: Vessel queues and congestion index.
  • Performance Metrics: 7d average waiting and stay times, performance index.
  • Carrier / Services Information: List of carriers operating at the terminal and their services.
  • Related Data: Associated port and terminal details when requested.

Data is updated every 30 minutes to provide near real-time terminal conditions.

List terminal congestions

Retrieve a list of terminal congestion data with live metrics and performance insights.
The list can be filtered using the following filter groups:

  • Performance Insights: performanceIndex, avgWaitingTime, avgStayTime
  • Live Metrics: congestionIndex, vesselsWaiting, vesselsWaitingAvgTime, vesselsStay, vesselsStayAvgTime
  • Terminal Properties: id, smdgCode, name
  • Port Properties: id, unlocode, name

Results are paginated with 50 entries per page.

SecurityApiKeyAuth
Request
query Parameters
filter[performanceInsights.performanceIndex]
number [ 0 .. 10 ]

Filter by performance index (0-10).

Example: filter[performanceInsights.performanceIndex]=7.5
filter[performanceInsights.performanceIndex][gt]
number [ 0 .. 10 ]

Filter by performance index (0-10): greater than the given value. Combine with filter[performanceInsights.performanceIndex][lt] or filter[performanceInsights.performanceIndex][lte] to filter a range.

Example: filter[performanceInsights.performanceIndex][gt]=7.5
filter[performanceInsights.performanceIndex][gte]
number [ 0 .. 10 ]

Filter by performance index (0-10): greater than or equal to the given value. Combine with filter[performanceInsights.performanceIndex][lt] or filter[performanceInsights.performanceIndex][lte] to filter a range.

Example: filter[performanceInsights.performanceIndex][gte]=7.5
filter[performanceInsights.performanceIndex][lt]
number [ 0 .. 10 ]

Filter by performance index (0-10): less than the given value. Combine with filter[performanceInsights.performanceIndex][gt] or filter[performanceInsights.performanceIndex][gte] to filter a range.

Example: filter[performanceInsights.performanceIndex][lt]=7.5
filter[performanceInsights.performanceIndex][lte]
number [ 0 .. 10 ]

Filter by performance index (0-10): less than or equal to the given value. Combine with filter[performanceInsights.performanceIndex][gt] or filter[performanceInsights.performanceIndex][gte] to filter a range.

Example: filter[performanceInsights.performanceIndex][lte]=7.5
filter[performanceInsights.avgWaitingTime]
number [ 0 .. 10000 ]

Filter by average waiting time in hours (0-10000).

Example: filter[performanceInsights.avgWaitingTime]=12.5
filter[performanceInsights.avgWaitingTime][gt]
number [ 0 .. 10000 ]

Filter by average waiting time in hours (0-10000): greater than the given value. Combine with filter[performanceInsights.avgWaitingTime][lt] or filter[performanceInsights.avgWaitingTime][lte] to filter a range.

Example: filter[performanceInsights.avgWaitingTime][gt]=12.5
filter[performanceInsights.avgWaitingTime][gte]
number [ 0 .. 10000 ]

Filter by average waiting time in hours (0-10000): greater than or equal to the given value. Combine with filter[performanceInsights.avgWaitingTime][lt] or filter[performanceInsights.avgWaitingTime][lte] to filter a range.

Example: filter[performanceInsights.avgWaitingTime][gte]=12.5
filter[performanceInsights.avgWaitingTime][lt]
number [ 0 .. 10000 ]

Filter by average waiting time in hours (0-10000): less than the given value. Combine with filter[performanceInsights.avgWaitingTime][gt] or filter[performanceInsights.avgWaitingTime][gte] to filter a range.

Example: filter[performanceInsights.avgWaitingTime][lt]=12.5
filter[performanceInsights.avgWaitingTime][lte]
number [ 0 .. 10000 ]

Filter by average waiting time in hours (0-10000): less than or equal to the given value. Combine with filter[performanceInsights.avgWaitingTime][gt] or filter[performanceInsights.avgWaitingTime][gte] to filter a range.

Example: filter[performanceInsights.avgWaitingTime][lte]=12.5
filter[performanceInsights.avgStayTime]
number [ 0 .. 10000 ]

Filter by average stay time in hours (0-10000).

Example: filter[performanceInsights.avgStayTime]=48.3
filter[performanceInsights.avgStayTime][gt]
number [ 0 .. 10000 ]

Filter by average stay time in hours (0-10000): greater than the given value. Combine with filter[performanceInsights.avgStayTime][lt] or filter[performanceInsights.avgStayTime][lte] to filter a range.

Example: filter[performanceInsights.avgStayTime][gt]=48.3
filter[performanceInsights.avgStayTime][gte]
number [ 0 .. 10000 ]

Filter by average stay time in hours (0-10000): greater than or equal to the given value. Combine with filter[performanceInsights.avgStayTime][lt] or filter[performanceInsights.avgStayTime][lte] to filter a range.

Example: filter[performanceInsights.avgStayTime][gte]=48.3
filter[performanceInsights.avgStayTime][lt]
number [ 0 .. 10000 ]

Filter by average stay time in hours (0-10000): less than the given value. Combine with filter[performanceInsights.avgStayTime][gt] or filter[performanceInsights.avgStayTime][gte] to filter a range.

Example: filter[performanceInsights.avgStayTime][lt]=48.3
filter[performanceInsights.avgStayTime][lte]
number [ 0 .. 10000 ]

Filter by average stay time in hours (0-10000): less than or equal to the given value. Combine with filter[performanceInsights.avgStayTime][gt] or filter[performanceInsights.avgStayTime][gte] to filter a range.

Example: filter[performanceInsights.avgStayTime][lte]=48.3
filter[liveMetrics.congestionIndex]
number [ 0 .. 10 ]

Filter by congestion index (0-10).

Example: filter[liveMetrics.congestionIndex]=6.2
filter[liveMetrics.congestionIndex][gt]
number [ 0 .. 10 ]

Filter by congestion index (0-10): greater than the given value. Combine with filter[liveMetrics.congestionIndex][lt] or filter[liveMetrics.congestionIndex][lte] to filter a range.

Example: filter[liveMetrics.congestionIndex][gt]=6.2
filter[liveMetrics.congestionIndex][gte]
number [ 0 .. 10 ]

Filter by congestion index (0-10): greater than or equal to the given value. Combine with filter[liveMetrics.congestionIndex][lt] or filter[liveMetrics.congestionIndex][lte] to filter a range.

Example: filter[liveMetrics.congestionIndex][gte]=6.2
filter[liveMetrics.congestionIndex][lt]
number [ 0 .. 10 ]

Filter by congestion index (0-10): less than the given value. Combine with filter[liveMetrics.congestionIndex][gt] or filter[liveMetrics.congestionIndex][gte] to filter a range.

Example: filter[liveMetrics.congestionIndex][lt]=6.2
filter[liveMetrics.congestionIndex][lte]
number [ 0 .. 10 ]

Filter by congestion index (0-10): less than or equal to the given value. Combine with filter[liveMetrics.congestionIndex][gt] or filter[liveMetrics.congestionIndex][gte] to filter a range.

Example: filter[liveMetrics.congestionIndex][lte]=6.2
filter[liveMetrics.vesselsWaiting]
integer [ 0 .. 10000 ]

Filter by number of vessels currently waiting (0-10000).

Example: filter[liveMetrics.vesselsWaiting]=5
filter[liveMetrics.vesselsWaiting][gt]
integer [ 0 .. 10000 ]

Filter by number of vessels currently waiting (0-10000): greater than the given value. Combine with filter[liveMetrics.vesselsWaiting][lt] or filter[liveMetrics.vesselsWaiting][lte] to filter a range.

Example: filter[liveMetrics.vesselsWaiting][gt]=5
filter[liveMetrics.vesselsWaiting][gte]
integer [ 0 .. 10000 ]

Filter by number of vessels currently waiting (0-10000): greater than or equal to the given value. Combine with filter[liveMetrics.vesselsWaiting][lt] or filter[liveMetrics.vesselsWaiting][lte] to filter a range.

Example: filter[liveMetrics.vesselsWaiting][gte]=5
filter[liveMetrics.vesselsWaiting][lt]
integer [ 0 .. 10000 ]

Filter by number of vessels currently waiting (0-10000): less than the given value. Combine with filter[liveMetrics.vesselsWaiting][gt] or filter[liveMetrics.vesselsWaiting][gte] to filter a range.

Example: filter[liveMetrics.vesselsWaiting][lt]=5
filter[liveMetrics.vesselsWaiting][lte]
integer [ 0 .. 10000 ]

Filter by number of vessels currently waiting (0-10000): less than or equal to the given value. Combine with filter[liveMetrics.vesselsWaiting][gt] or filter[liveMetrics.vesselsWaiting][gte] to filter a range.

Example: filter[liveMetrics.vesselsWaiting][lte]=5
filter[liveMetrics.vesselsWaitingAvgTime]
number

Filter by average waiting time in hours of the vessels currently waiting to berth at this terminal.

Example: filter[liveMetrics.vesselsWaitingAvgTime]=12.5
filter[liveMetrics.vesselsWaitingAvgTime][gt]
number

Filter by average waiting time in hours of the vessels currently waiting to berth at this terminal: greater than the given value. Combine with filter[liveMetrics.vesselsWaitingAvgTime][lt] or filter[liveMetrics.vesselsWaitingAvgTime][lte] to filter a range.

Example: filter[liveMetrics.vesselsWaitingAvgTime][gt]=12.5
filter[liveMetrics.vesselsWaitingAvgTime][gte]
number

Filter by average waiting time in hours of the vessels currently waiting to berth at this terminal: greater than or equal to the given value. Combine with filter[liveMetrics.vesselsWaitingAvgTime][lt] or filter[liveMetrics.vesselsWaitingAvgTime][lte] to filter a range.

Example: filter[liveMetrics.vesselsWaitingAvgTime][gte]=12.5
filter[liveMetrics.vesselsWaitingAvgTime][lt]
number

Filter by average waiting time in hours of the vessels currently waiting to berth at this terminal: less than the given value. Combine with filter[liveMetrics.vesselsWaitingAvgTime][gt] or filter[liveMetrics.vesselsWaitingAvgTime][gte] to filter a range.

Example: filter[liveMetrics.vesselsWaitingAvgTime][lt]=12.5
filter[liveMetrics.vesselsWaitingAvgTime][lte]
number

Filter by average waiting time in hours of the vessels currently waiting to berth at this terminal: less than or equal to the given value. Combine with filter[liveMetrics.vesselsWaitingAvgTime][gt] or filter[liveMetrics.vesselsWaitingAvgTime][gte] to filter a range.

Example: filter[liveMetrics.vesselsWaitingAvgTime][lte]=12.5
filter[liveMetrics.vesselsStay]
integer

Filter by number of vessels currently staying at the terminal.

Example: filter[liveMetrics.vesselsStay]=5
filter[liveMetrics.vesselsStay][gt]
integer

Filter by number of vessels currently staying at the terminal: greater than the given value. Combine with filter[liveMetrics.vesselsStay][lt] or filter[liveMetrics.vesselsStay][lte] to filter a range.

Example: filter[liveMetrics.vesselsStay][gt]=5
filter[liveMetrics.vesselsStay][gte]
integer

Filter by number of vessels currently staying at the terminal: greater than or equal to the given value. Combine with filter[liveMetrics.vesselsStay][lt] or filter[liveMetrics.vesselsStay][lte] to filter a range.

Example: filter[liveMetrics.vesselsStay][gte]=5
filter[liveMetrics.vesselsStay][lt]
integer

Filter by number of vessels currently staying at the terminal: less than the given value. Combine with filter[liveMetrics.vesselsStay][gt] or filter[liveMetrics.vesselsStay][gte] to filter a range.

Example: filter[liveMetrics.vesselsStay][lt]=5
filter[liveMetrics.vesselsStay][lte]
integer

Filter by number of vessels currently staying at the terminal: less than or equal to the given value. Combine with filter[liveMetrics.vesselsStay][gt] or filter[liveMetrics.vesselsStay][gte] to filter a range.

Example: filter[liveMetrics.vesselsStay][lte]=5
filter[liveMetrics.vesselsStayAvgTime]
number

Filter by average stay time in hours of the vessels currently staying at the terminal.

Example: filter[liveMetrics.vesselsStayAvgTime]=12.5
filter[liveMetrics.vesselsStayAvgTime][gt]
number

Filter by average stay time in hours of the vessels currently staying at the terminal: greater than the given value. Combine with filter[liveMetrics.vesselsStayAvgTime][lt] or filter[liveMetrics.vesselsStayAvgTime][lte] to filter a range.

Example: filter[liveMetrics.vesselsStayAvgTime][gt]=12.5
filter[liveMetrics.vesselsStayAvgTime][gte]
number

Filter by average stay time in hours of the vessels currently staying at the terminal: greater than or equal to the given value. Combine with filter[liveMetrics.vesselsStayAvgTime][lt] or filter[liveMetrics.vesselsStayAvgTime][lte] to filter a range.

Example: filter[liveMetrics.vesselsStayAvgTime][gte]=12.5
filter[liveMetrics.vesselsStayAvgTime][lt]
number

Filter by average stay time in hours of the vessels currently staying at the terminal: less than the given value. Combine with filter[liveMetrics.vesselsStayAvgTime][gt] or filter[liveMetrics.vesselsStayAvgTime][gte] to filter a range.

Example: filter[liveMetrics.vesselsStayAvgTime][lt]=12.5
filter[liveMetrics.vesselsStayAvgTime][lte]
number

Filter by average stay time in hours of the vessels currently staying at the terminal: less than or equal to the given value. Combine with filter[liveMetrics.vesselsStayAvgTime][gt] or filter[liveMetrics.vesselsStayAvgTime][gte] to filter a range.

Example: filter[liveMetrics.vesselsStayAvgTime][lte]=12.5
filter[terminal.id]
integer [ 1 .. 999999999 ]

Filter by terminal MT ID, exact match.

Example: filter[terminal.id]=215
filter[terminal.id][]
Array of integers <= 5 items

Filter by terminal MT IDs (max 5 values, no leading zeros), exact match only.

Example: filter[terminal.id][]=214&filter[terminal.id][]=215&filter[terminal.id][]=216
filter[terminal.name]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by terminal name. Exact match only, case-sensitive.

Example: filter[terminal.name]=HHLA Container Terminal Burchardkai
filter[terminal.name][ne]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by terminal name: not equal to the given value. Case-sensitive.

Example: filter[terminal.name][ne]=HHLA Container Terminal Burchardkai
filter[terminal.name][contains]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by terminal name: partial match (contains the given value). Case-insensitive.

Example: filter[terminal.name][contains]=Burchardkai
filter[terminal.name][]
Array of strings <= 5 items

Filter by terminal name (max 5 values, exact match only, case-sensitive).

Example: filter[terminal.name][]=HHLA Container Terminal Burchardkai&filter[terminal.name][]=Eurogate Container Terminal Hamburg
filter[terminal.smdgCode]
string [ 3 .. 6 ] characters ^[A-Za-z0-9]+$

Filter by terminal SMDG code. Exact match only.

Example: filter[terminal.smdgCode]=CTB
filter[terminal.smdgCode][ne]
string [ 3 .. 6 ] characters ^[A-Za-z0-9]+$

Filter by terminal SMDG code: not equal to the given value.

Example: filter[terminal.smdgCode][ne]=CTB
filter[terminal.smdgCode][]
Array of strings <= 5 items

Filter by terminal SMDG code (exact match only, max 5 values).

Example: filter[terminal.smdgCode][]=CTB&filter[terminal.smdgCode][]=EGH
filter[port.id]
integer [ 1 .. 999999999 ]

Filter by port MT ID.

Example: filter[port.id]=172
filter[port.id][]
Array of integers <= 5 items

Filter by port MT IDs (max 5 values, no leading zeros)

Example: filter[port.id][]=172&filter[port.id][]=117&filter[port.id][]=2037
filter[port.name]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by port name. Exact match only, case-sensitive. Port names are uppercase, e.g. HAMBURG.

Example: filter[port.name]=HAMBURG
filter[port.name][ne]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by port name: not equal to the given value. Case-sensitive. Port names are uppercase, e.g. HAMBURG.

Example: filter[port.name][ne]=HAMBURG
filter[port.name][contains]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by port name: partial match (contains the given value). Case-insensitive.

Example: filter[port.name][contains]=HAMBURG
filter[port.name][]
Array of strings <= 5 items

Filter by port name (max 5 values, exact match only, case-sensitive). Port names are uppercase, e.g. HAMBURG.

Example: filter[port.name][]=HAMBURG&filter[port.name][]=ROTTERDAM MAASVLAKTE
filter[port.unlocode]
string = 5 characters ^[A-Z0-9]+$

Filter by port UN/LOCODE. Exact match only.

Example: filter[port.unlocode]=DEHAM
filter[port.unlocode][ne]
string = 5 characters ^[A-Z0-9]+$

Filter by port UN/LOCODE: not equal to the given value.

Example: filter[port.unlocode][ne]=DEHAM
filter[port.unlocode][]
Array of strings <= 5 items

Filter by port UN/LOCODE (exact match only, max 5 values)

Example: filter[port.unlocode][]=DEHAM&filter[port.unlocode][]=BEANR
include
string^(terminals|ports)(,(terminals|ports))*$

Comma-separated list of related resources to include in the response. Values can be combined in any order, for example include=ports,terminals.

Supported values:

  • terminals — sideloads the terminal resource for each terminal congestion.
  • ports — sideloads the port resource of each terminal.
Example: include=terminals,ports
page
integer >= 1
Default: 1

Page number for pagination

Example: page=1
header Parameters
Accept
string

Specify the desired response format.

  • For JSON responses (JsonAPI standard), use application/vnd.api+json, application/json or */*.
  • For CSV responses, use text/csv.

If not specified, the response will be in application/vnd.api+json format.

Enum: "*/*" "application/vnd.api+json" "application/json" "text/csv"
Example: application/vnd.api+json
Responses
200

A list of terminal congestion data

422

Validation error

500

Internal Server Error

get/terminal-congestions
Request samples
const axios = require('axios');

const API_KEY = 'API_KEY';

const params = {
  'filter[performanceInsights.performanceIndex][gte]': 5,
  'filter[performanceInsights.avgStayTime][lte]': 100,
  'filter[performanceInsights.avgWaitingTime][gte]': 4,
  'filter[liveMetrics.congestionIndex][gte]': 5,
  'filter[liveMetrics.vesselsWaiting][gte]': 2,
  'filter[port.name][contains]': 'HAM',
  'filter[port.unlocode]': ['DEHAM', 'BEANR'],
  include: 'ports,terminals'
};

axios.get('https://api.kpler.com/v1/logistics/containers/terminal-congestions', {
  headers: {
    'Accept': 'application/vnd.api+json',
    'X-Container-API-Key': API_KEY
  },
  params
})
.then(response => {
  console.dir(response.data, {depth:null});
})
.catch(error => {
  if (error.response) {
    console.dir(error.response.data, {depth:null});
  } else {
    console.error('Request failed:', error.message);
  }
});
Response samples
{}

Shipping Calls

List shipping calls

Retrieve a list of shipping calls with vessel call data including waiting times, arrival and departure details.
The list can be filtered using the following filter groups:

  • Call Status: status
  • Metrics: waitingTime, stayTime
  • Waiting Start: waitingStart.timestampUtc
  • Arrival: arrival.timestampUtc, arrival.services.carrierScac, arrival.services.code
  • Departure: departure.timestampUtc, departure.services.carrierScac, departure.services.code
  • Last Updated: lastUpdatedAt
  • Vessel Properties: id, imo, mmsi, name, teuCapacity
  • Terminal Properties: id, name, smdgCode
  • Port Properties: id, unlocode, name
  • Berth Properties: berth.id, berth.name
  • Carrier Properties: carriers.scac, carriers.name, commercialOperator.scac, commercialOperator.name
  • Carrier Group / Alliance Properties: commercialOperatorGroup.name, commercialOperatorGroup.country, commercialOperatorAlliance.name

Results are paginated with 50 entries per page.

SecurityApiKeyAuth
Request
query Parameters
filter[status]
string

Filter by call status.

Enum: "future" "ongoing" "past"
Example: filter[status]=ongoing
filter[status][ne]
string

Filter by call status: not equal to the given value.

Enum: "future" "ongoing" "past"
Example: filter[status][ne]=ongoing
filter[status][]
Array of strings <= 3 items

Filter by call status (max 3 values).

Items Enum: "future" "ongoing" "past"
Example: filter[status][]=ongoing&filter[status][]=past
filter[metrics.waitingTime]
number [ 0 .. 10000 ]

Filter by waiting time in hours (0-10000).

Example: filter[metrics.waitingTime]=12.5
filter[metrics.waitingTime][gt]
number [ 0 .. 10000 ]

Filter by waiting time in hours (0-10000): greater than the given value. Combine with filter[metrics.waitingTime][lt] or filter[metrics.waitingTime][lte] to filter a range.

Example: filter[metrics.waitingTime][gt]=12.5
filter[metrics.waitingTime][gte]
number [ 0 .. 10000 ]

Filter by waiting time in hours (0-10000): greater than or equal to the given value. Combine with filter[metrics.waitingTime][lt] or filter[metrics.waitingTime][lte] to filter a range.

Example: filter[metrics.waitingTime][gte]=12.5
filter[metrics.waitingTime][lt]
number [ 0 .. 10000 ]

Filter by waiting time in hours (0-10000): less than the given value. Combine with filter[metrics.waitingTime][gt] or filter[metrics.waitingTime][gte] to filter a range.

Example: filter[metrics.waitingTime][lt]=12.5
filter[metrics.waitingTime][lte]
number [ 0 .. 10000 ]

Filter by waiting time in hours (0-10000): less than or equal to the given value. Combine with filter[metrics.waitingTime][gt] or filter[metrics.waitingTime][gte] to filter a range.

Example: filter[metrics.waitingTime][lte]=12.5
filter[metrics.stayTime]
number [ 0 .. 10000 ]

Filter by stay time in hours (0-10000).

Example: filter[metrics.stayTime]=24.6
filter[metrics.stayTime][gt]
number [ 0 .. 10000 ]

Filter by stay time in hours (0-10000): greater than the given value. Combine with filter[metrics.stayTime][lt] or filter[metrics.stayTime][lte] to filter a range.

Example: filter[metrics.stayTime][gt]=24.6
filter[metrics.stayTime][gte]
number [ 0 .. 10000 ]

Filter by stay time in hours (0-10000): greater than or equal to the given value. Combine with filter[metrics.stayTime][lt] or filter[metrics.stayTime][lte] to filter a range.

Example: filter[metrics.stayTime][gte]=24.6
filter[metrics.stayTime][lt]
number [ 0 .. 10000 ]

Filter by stay time in hours (0-10000): less than the given value. Combine with filter[metrics.stayTime][gt] or filter[metrics.stayTime][gte] to filter a range.

Example: filter[metrics.stayTime][lt]=24.6
filter[metrics.stayTime][lte]
number [ 0 .. 10000 ]

Filter by stay time in hours (0-10000): less than or equal to the given value. Combine with filter[metrics.stayTime][gt] or filter[metrics.stayTime][gte] to filter a range.

Example: filter[metrics.stayTime][lte]=24.6
filter[waitingStart.timestampUtc]
string <date-time> ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

Filter by waiting start timestamp in UTC, formatted exactly as YYYY-MM-DDThh:mm:ssZ.

Example: filter[waitingStart.timestampUtc]=2025-01-01T00:00:00Z
filter[waitingStart.timestampUtc][gt]
string <date-time> ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

Filter by waiting start timestamp in UTC, formatted exactly as YYYY-MM-DDThh:mm:ssZ: greater than the given value. Combine with filter[waitingStart.timestampUtc][lt] or filter[waitingStart.timestampUtc][lte] to filter a range.

Example: filter[waitingStart.timestampUtc][gt]=2025-01-01T00:00:00Z
filter[waitingStart.timestampUtc][gte]
string <date-time> ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

Filter by waiting start timestamp in UTC, formatted exactly as YYYY-MM-DDThh:mm:ssZ: greater than or equal to the given value. Combine with filter[waitingStart.timestampUtc][lt] or filter[waitingStart.timestampUtc][lte] to filter a range.

Example: filter[waitingStart.timestampUtc][gte]=2025-01-01T00:00:00Z
filter[waitingStart.timestampUtc][lt]
string <date-time> ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

Filter by waiting start timestamp in UTC, formatted exactly as YYYY-MM-DDThh:mm:ssZ: less than the given value. Combine with filter[waitingStart.timestampUtc][gt] or filter[waitingStart.timestampUtc][gte] to filter a range.

Example: filter[waitingStart.timestampUtc][lt]=2025-01-01T00:00:00Z
filter[waitingStart.timestampUtc][lte]
string <date-time> ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

Filter by waiting start timestamp in UTC, formatted exactly as YYYY-MM-DDThh:mm:ssZ: less than or equal to the given value. Combine with filter[waitingStart.timestampUtc][gt] or filter[waitingStart.timestampUtc][gte] to filter a range.

Example: filter[waitingStart.timestampUtc][lte]=2025-01-01T00:00:00Z
filter[arrival.timestampUtc]
string <date-time> ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

Filter by arrival timestamp in UTC, formatted exactly as YYYY-MM-DDThh:mm:ssZ.

Example: filter[arrival.timestampUtc]=2025-01-01T00:00:00Z
filter[arrival.timestampUtc][gt]
string <date-time> ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

Filter by arrival timestamp in UTC, formatted exactly as YYYY-MM-DDThh:mm:ssZ: greater than the given value. Combine with filter[arrival.timestampUtc][lt] or filter[arrival.timestampUtc][lte] to filter a range.

Example: filter[arrival.timestampUtc][gt]=2025-01-01T00:00:00Z
filter[arrival.timestampUtc][gte]
string <date-time> ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

Filter by arrival timestamp in UTC, formatted exactly as YYYY-MM-DDThh:mm:ssZ: greater than or equal to the given value. Combine with filter[arrival.timestampUtc][lt] or filter[arrival.timestampUtc][lte] to filter a range.

Example: filter[arrival.timestampUtc][gte]=2025-01-01T00:00:00Z
filter[arrival.timestampUtc][lt]
string <date-time> ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

Filter by arrival timestamp in UTC, formatted exactly as YYYY-MM-DDThh:mm:ssZ: less than the given value. Combine with filter[arrival.timestampUtc][gt] or filter[arrival.timestampUtc][gte] to filter a range.

Example: filter[arrival.timestampUtc][lt]=2025-01-01T00:00:00Z
filter[arrival.timestampUtc][lte]
string <date-time> ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

Filter by arrival timestamp in UTC, formatted exactly as YYYY-MM-DDThh:mm:ssZ: less than or equal to the given value. Combine with filter[arrival.timestampUtc][gt] or filter[arrival.timestampUtc][gte] to filter a range.

Example: filter[arrival.timestampUtc][lte]=2025-01-01T00:00:00Z
filter[departure.timestampUtc]
string <date-time> ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

Filter by departure timestamp in UTC, formatted exactly as YYYY-MM-DDThh:mm:ssZ.

Example: filter[departure.timestampUtc]=2025-01-01T00:00:00Z
filter[departure.timestampUtc][gt]
string <date-time> ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

Filter by departure timestamp in UTC, formatted exactly as YYYY-MM-DDThh:mm:ssZ: greater than the given value. Combine with filter[departure.timestampUtc][lt] or filter[departure.timestampUtc][lte] to filter a range.

Example: filter[departure.timestampUtc][gt]=2025-01-01T00:00:00Z
filter[departure.timestampUtc][gte]
string <date-time> ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

Filter by departure timestamp in UTC, formatted exactly as YYYY-MM-DDThh:mm:ssZ: greater than or equal to the given value. Combine with filter[departure.timestampUtc][lt] or filter[departure.timestampUtc][lte] to filter a range.

Example: filter[departure.timestampUtc][gte]=2025-01-01T00:00:00Z
filter[departure.timestampUtc][lt]
string <date-time> ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

Filter by departure timestamp in UTC, formatted exactly as YYYY-MM-DDThh:mm:ssZ: less than the given value. Combine with filter[departure.timestampUtc][gt] or filter[departure.timestampUtc][gte] to filter a range.

Example: filter[departure.timestampUtc][lt]=2025-01-01T00:00:00Z
filter[departure.timestampUtc][lte]
string <date-time> ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

Filter by departure timestamp in UTC, formatted exactly as YYYY-MM-DDThh:mm:ssZ: less than or equal to the given value. Combine with filter[departure.timestampUtc][gt] or filter[departure.timestampUtc][gte] to filter a range.

Example: filter[departure.timestampUtc][lte]=2025-01-01T00:00:00Z
filter[vessel.id]
integer [ 1 .. 999999999 ]

Filter by vessel MT ID, exact match.

Example: filter[vessel.id]=258634
filter[vessel.id][]
Array of integers <= 5 items

Filter by vessel MT IDs (max 5 values, no leading zeros), exact match only.

Example: filter[vessel.id][]=258634&filter[vessel.id][]=9265908&filter[vessel.id][]=688654
filter[vessel.imo]
string = 7 characters ^[0-9]{7}$

Filter by vessel IMO number, exact match only.

Example: filter[vessel.imo]=9387425
filter[vessel.imo][]
Array of strings <= 5 items

Filter by vessel IMO numbers (exact match only, max 5 values).

Example: filter[vessel.imo][]=9387425&filter[vessel.imo][]=9961805
filter[vessel.mmsi]
string = 9 characters ^[0-9]{9}$

Filter by vessel MMSI, exact match only.

Example: filter[vessel.mmsi]=255917275
filter[vessel.mmsi][]
Array of strings <= 5 items

Filter by vessel MMSI numbers (exact match only, max 5 values).

Example: filter[vessel.mmsi][]=255917275&filter[vessel.mmsi][]=219686000
filter[vessel.name]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by vessel name. Exact match only, case-sensitive. Vessel names are uppercase, e.g. ALBERT MAERSK.

Example: filter[vessel.name]=ALBERT MAERSK
filter[vessel.name][ne]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by vessel name: not equal to the given value. Case-sensitive. Vessel names are uppercase, e.g. ALBERT MAERSK.

Example: filter[vessel.name][ne]=ALBERT MAERSK
filter[vessel.name][contains]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by vessel name: partial match (contains the given value). Case-insensitive.

Example: filter[vessel.name][contains]=MAERSK
filter[vessel.name][]
Array of strings <= 5 items

Filter by vessel name (max 5 values, exact match only, case-sensitive). Vessel names are uppercase, e.g. ALBERT MAERSK.

Example: filter[vessel.name][]=ALBERT MAERSK&filter[vessel.name][]=SEASPAN EMPIRE
filter[vessel.teuCapacity]
integer [ 0 .. 100000 ]

Filter by vessel TEU capacity.

Example: filter[vessel.teuCapacity]=1400
filter[vessel.teuCapacity][gt]
integer [ 0 .. 100000 ]

Filter by vessel TEU capacity: greater than the given value. Combine with filter[vessel.teuCapacity][lt] or filter[vessel.teuCapacity][lte] to filter a range.

Example: filter[vessel.teuCapacity][gt]=1400
filter[vessel.teuCapacity][gte]
integer [ 0 .. 100000 ]

Filter by vessel TEU capacity: greater than or equal to the given value. Combine with filter[vessel.teuCapacity][lt] or filter[vessel.teuCapacity][lte] to filter a range.

Example: filter[vessel.teuCapacity][gte]=1400
filter[vessel.teuCapacity][lt]
integer [ 0 .. 100000 ]

Filter by vessel TEU capacity: less than the given value. Combine with filter[vessel.teuCapacity][gt] or filter[vessel.teuCapacity][gte] to filter a range.

Example: filter[vessel.teuCapacity][lt]=1400
filter[vessel.teuCapacity][lte]
integer [ 0 .. 100000 ]

Filter by vessel TEU capacity: less than or equal to the given value. Combine with filter[vessel.teuCapacity][gt] or filter[vessel.teuCapacity][gte] to filter a range.

Example: filter[vessel.teuCapacity][lte]=1400
filter[terminal.id]
integer [ 1 .. 999999999 ]

Filter by terminal MT ID, exact match.

Example: filter[terminal.id]=216
filter[terminal.id][]
Array of integers <= 5 items

Filter by terminal MT IDs (max 5 values, no leading zeros), exact match only.

Example: filter[terminal.id][]=215&filter[terminal.id][]=216&filter[terminal.id][]=217
filter[terminal.name]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by terminal name. Exact match only, case-sensitive.

Example: filter[terminal.name]=HHLA Container Terminal Burchardkai
filter[terminal.name][ne]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by terminal name: not equal to the given value. Case-sensitive.

Example: filter[terminal.name][ne]=HHLA Container Terminal Burchardkai
filter[terminal.name][contains]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by terminal name: partial match (contains the given value). Case-insensitive.

Example: filter[terminal.name][contains]=Burchardkai
filter[terminal.name][]
Array of strings <= 5 items

Filter by terminal name (max 5 values, exact match only, case-sensitive).

Example: filter[terminal.name][]=HHLA Container Terminal Burchardkai&filter[terminal.name][]=Eurogate Container Terminal Hamburg
filter[terminal.smdgCode]
string [ 3 .. 6 ] characters ^[A-Za-z0-9]+$

Filter by terminal SMDG code. Exact match only.

Example: filter[terminal.smdgCode]=CTB
filter[terminal.smdgCode][ne]
string [ 3 .. 6 ] characters ^[A-Za-z0-9]+$

Filter by terminal SMDG code: not equal to the given value.

Example: filter[terminal.smdgCode][ne]=CTB
filter[terminal.smdgCode][]
Array of strings <= 5 items

Filter by terminal SMDG code (exact match only, max 5 values).

Example: filter[terminal.smdgCode][]=CTB&filter[terminal.smdgCode][]=EGH
filter[port.id]
integer [ 1 .. 999999999 ]

Filter by port MT ID.

Example: filter[port.id]=172
filter[port.id][]
Array of integers <= 5 items

Filter by port MT IDs (max 5 values, no leading zeros)

Example: filter[port.id][]=172&filter[port.id][]=117&filter[port.id][]=2037
filter[port.name]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by port name. Exact match only, case-sensitive. Port names are uppercase, e.g. HAMBURG.

Example: filter[port.name]=HAMBURG
filter[port.name][ne]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by port name: not equal to the given value. Case-sensitive. Port names are uppercase, e.g. HAMBURG.

Example: filter[port.name][ne]=HAMBURG
filter[port.name][contains]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by port name: partial match (contains the given value). Case-insensitive.

Example: filter[port.name][contains]=HAMBURG
filter[port.name][]
Array of strings <= 5 items

Filter by port name (max 5 values, exact match only, case-sensitive). Port names are uppercase, e.g. HAMBURG.

Example: filter[port.name][]=HAMBURG&filter[port.name][]=ROTTERDAM MAASVLAKTE
filter[port.unlocode]
string = 5 characters ^[A-Z0-9]+$

Filter by port UN/LOCODE. Exact match only.

Example: filter[port.unlocode]=DEHAM
filter[port.unlocode][ne]
string = 5 characters ^[A-Z0-9]+$

Filter by port UN/LOCODE: not equal to the given value.

Example: filter[port.unlocode][ne]=DEHAM
filter[port.unlocode][]
Array of strings <= 5 items

Filter by port UN/LOCODE (exact match only, max 5 values)

Example: filter[port.unlocode][]=DEHAM&filter[port.unlocode][]=BEANR
filter[berth.id]
integer [ 1 .. 999999999 ]

Filter by berth MT ID, exact match.

Example: filter[berth.id]=677
filter[berth.id][]
Array of integers <= 5 items

Filter by berth MT IDs (max 5 values, no leading zeros), exact match only.

Example: filter[berth.id][]=677&filter[berth.id][]=678&filter[berth.id][]=679
filter[berth.name]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by berth name. Exact match only, case-sensitive.

Example: filter[berth.name]=CTB 1
filter[berth.name][ne]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by berth name: not equal to the given value. Case-sensitive.

Example: filter[berth.name][ne]=CTB 1
filter[berth.name][contains]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by berth name: partial match (contains the given value). Case-insensitive.

Example: filter[berth.name][contains]=CTB
filter[berth.name][]
Array of strings <= 5 items

Filter by berth name (max 5 values, exact match only, case-sensitive).

Example: filter[berth.name][]=CTB 1&filter[berth.name][]=CTB 2
filter[carriers.scac]
string [ 2 .. 4 ] characters ^[A-Z0-9]+$

Filter calls where any associated carrier (any role) has this SCAC code. Exact match only. SCAC length is 2 to 4 alphanumeric characters (same validation as other carrier SCAC filters in this API).

Example: filter[carriers.scac]=MAEU
filter[carriers.scac][ne]
string [ 2 .. 4 ] characters ^[A-Z0-9]+$

Filter by the SCAC code of any associated carrier (any role): not equal to the given value.

Example: filter[carriers.scac][ne]=MAEU
filter[carriers.scac][contains]
string [ 2 .. 4 ] characters ^[A-Z0-9]+$

Filter by the SCAC code of any associated carrier (any role): partial match (contains the given value).

Example: filter[carriers.scac][contains]=MAEU
filter[carriers.scac][]
Array of strings <= 5 items

Filter calls where any associated carrier (any role) has one of these SCAC codes (max 5 values, exact match only).

Example: filter[carriers.scac][]=MAEU&filter[carriers.scac][]=MSCU
filter[carriers.name]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter calls where any associated carrier (any role) has this display name from core.carriers.display_name. Exact match only, case-sensitive. Name length is 2 to 50 characters (letters, digits, spaces, hyphens).

Example: filter[carriers.name]=Maersk
filter[carriers.name][ne]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by the display name of any associated carrier (any role): not equal to the given value. Case-sensitive.

Example: filter[carriers.name][ne]=Maersk
filter[carriers.name][contains]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by the display name of any associated carrier (any role): partial match (contains the given value). Case-insensitive.

Example: filter[carriers.name][contains]=Maersk
filter[carriers.name][]
Array of strings <= 5 items

Filter calls where any associated carrier (any role) has one of these display names (max 5 values, exact match only, case-sensitive).

Example: filter[carriers.name][]=Maersk&filter[carriers.name][]=MSC
filter[commercialOperator.scac]
string [ 2 .. 4 ] characters ^[A-Z0-9]+$

Filter calls where the commercial operator has this SCAC code. Exact match only. SCAC length is 2 to 4 alphanumeric characters (same validation as other carrier SCAC filters in this API).

Example: filter[commercialOperator.scac]=MAEU
filter[commercialOperator.scac][ne]
string [ 2 .. 4 ] characters ^[A-Z0-9]+$

Filter by the commercial operator's SCAC code: not equal to the given value.

Example: filter[commercialOperator.scac][ne]=MAEU
filter[commercialOperator.scac][contains]
string [ 2 .. 4 ] characters ^[A-Z0-9]+$

Filter by the commercial operator's SCAC code: partial match (contains the given value).

Example: filter[commercialOperator.scac][contains]=MAEU
filter[commercialOperator.scac][]
Array of strings <= 5 items

Filter calls where the commercial operator has one of these SCAC codes (max 5 values, exact match only).

Example: filter[commercialOperator.scac][]=MAEU&filter[commercialOperator.scac][]=HLCU
filter[commercialOperator.name]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter calls where the commercial operator at call arrival has this display name from core.carriers.display_name. Exact match only, case-sensitive. Name length is 2 to 50 characters (letters, digits, spaces, hyphens).

Example: filter[commercialOperator.name]=Maersk
filter[commercialOperator.name][ne]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by the commercial operator's display name: not equal to the given value. Case-sensitive.

Example: filter[commercialOperator.name][ne]=Maersk
filter[commercialOperator.name][contains]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by the commercial operator's display name: partial match (contains the given value). Case-insensitive.

Example: filter[commercialOperator.name][contains]=Maersk
filter[commercialOperator.name][]
Array of strings <= 5 items

Filter calls where the commercial operator has one of these display names (max 5 values, exact match only, case-sensitive).

Example: filter[commercialOperator.name][]=Maersk&filter[commercialOperator.name][]=Hapag-Lloyd
filter[commercialOperatorGroup.name]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter calls where the commercial operator's carrier group (resolved at the call's arrival time) has this display name. Exact match only, case-sensitive. Name length is 2 to 50 characters (letters, digits, spaces, hyphens).

Example: filter[commercialOperatorGroup.name]=Maersk Group
filter[commercialOperatorGroup.name][ne]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by the display name of the commercial operator's carrier group: not equal to the given value. Case-sensitive.

Example: filter[commercialOperatorGroup.name][ne]=Maersk Group
filter[commercialOperatorGroup.name][contains]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by the display name of the commercial operator's carrier group: partial match (contains the given value). Case-insensitive.

Example: filter[commercialOperatorGroup.name][contains]=Maersk
filter[commercialOperatorGroup.name][]
Array of strings <= 5 items

Filter calls where the commercial operator's carrier group has one of these display names (max 5 values, exact match only, case-sensitive).

Example: filter[commercialOperatorGroup.name][]=Maersk Group&filter[commercialOperatorGroup.name][]=MSC Group
filter[commercialOperatorGroup.country]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter calls where the commercial operator's carrier group is registered in this country. Uses the country display name, not the ISO code. Exact match only, case-sensitive. Name length is 2 to 50 characters (letters, digits, spaces, hyphens).

Example: filter[commercialOperatorGroup.country]=Denmark
filter[commercialOperatorGroup.country][ne]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by the country name of the commercial operator's carrier group: not equal to the given value. Case-sensitive.

Example: filter[commercialOperatorGroup.country][ne]=Denmark
filter[commercialOperatorGroup.country][contains]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by the country name of the commercial operator's carrier group: partial match (contains the given value). Case-insensitive.

Example: filter[commercialOperatorGroup.country][contains]=Denmark
filter[commercialOperatorGroup.country][]
Array of strings <= 5 items

Filter calls where the commercial operator's carrier group is registered in one of these countries (country display names, max 5 values, exact match only, case-sensitive).

Example: filter[commercialOperatorGroup.country][]=Denmark&filter[commercialOperatorGroup.country][]=Switzerland
filter[commercialOperatorAlliance.name]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter calls where the alliance the commercial operator's carrier group participated in (at the call's arrival time) has this display name. Exact match only, case-sensitive. Name length is 2 to 50 characters (letters, digits, spaces, hyphens).

Example: filter[commercialOperatorAlliance.name]=Gemini Cooperation
filter[commercialOperatorAlliance.name][ne]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by the display name of the commercial operator's alliance: not equal to the given value. Case-sensitive.

Example: filter[commercialOperatorAlliance.name][ne]=Gemini Cooperation
filter[commercialOperatorAlliance.name][contains]
string [ 2 .. 50 ] characters ^[A-Za-z0-9\s\-]+$

Filter by the display name of the commercial operator's alliance: partial match (contains the given value). Case-insensitive.

Example: filter[commercialOperatorAlliance.name][contains]=Gemini
filter[commercialOperatorAlliance.name][]
Array of strings <= 5 items

Filter calls where the commercial operator's alliance has one of these display names (max 5 values, exact match only, case-sensitive).

Example: filter[commercialOperatorAlliance.name][]=Gemini Cooperation&filter[commercialOperatorAlliance.name][]=THE Alliance
filter[arrival.services.carrierScac]
string [ 2 .. 4 ] characters ^[A-Z0-9]+$

Filter by carrier SCAC code on arrival. Exact match only.

Example: filter[arrival.services.carrierScac]=MSCU
filter[arrival.services.carrierScac][ne]
string [ 2 .. 4 ] characters ^[A-Z0-9]+$

Filter by carrier SCAC code on arrival: not equal to the given value.

Example: filter[arrival.services.carrierScac][ne]=MSCU
filter[arrival.services.carrierScac][contains]
string [ 2 .. 4 ] characters ^[A-Z0-9]+$

Filter by carrier SCAC code on arrival: partial match (contains the given value).

Example: filter[arrival.services.carrierScac][contains]=MSCU
filter[arrival.services.carrierScac][]
Array of strings <= 5 items

Filter by carrier SCAC code on arrival (max 5 values, exact match only).

Example: filter[arrival.services.carrierScac][]=MSCU&filter[arrival.services.carrierScac][]=MAEU
filter[arrival.services.code]
string [ 2 .. 30 ] characters ^[A-Z0-9][A-Z0-9\s\-)(]*[A-Z0-9)]$

Filter by service code on arrival. Exact match only.

Example: filter[arrival.services.code]=LYNX
filter[arrival.services.code][ne]
string [ 2 .. 30 ] characters ^[A-Z0-9][A-Z0-9\s\-)(]*[A-Z0-9)]$

Filter by service code on arrival: not equal to the given value.

Example: filter[arrival.services.code][ne]=LYNX
filter[arrival.services.code][contains]
string [ 2 .. 30 ] characters ^[A-Z0-9][A-Z0-9\s\-)(]*[A-Z0-9)]$

Filter by service code on arrival: partial match (contains the given value).

Example: filter[arrival.services.code][contains]=LYNX
filter[arrival.services.code][]
Array of strings <= 5 items

Filter by service code on arrival (max 5 values, exact match only).

Example: filter[arrival.services.code][]=LYNX&filter[arrival.services.code][]=ALBATROS
filter[departure.services.carrierScac]
string [ 2 .. 4 ] characters ^[A-Z0-9]+$

Filter by carrier SCAC code on departure. Exact match only.

Example: filter[departure.services.carrierScac]=MSCU
filter[departure.services.carrierScac][ne]
string [ 2 .. 4 ] characters ^[A-Z0-9]+$

Filter by carrier SCAC code on departure: not equal to the given value.

Example: filter[departure.services.carrierScac][ne]=MSCU
filter[departure.services.carrierScac][contains]
string [ 2 .. 4 ] characters ^[A-Z0-9]+$

Filter by carrier SCAC code on departure: partial match (contains the given value).

Example: filter[departure.services.carrierScac][contains]=MSCU
filter[departure.services.carrierScac][]
Array of strings <= 5 items

Filter by carrier SCAC code on departure (max 5 values, exact match only).

Example: filter[departure.services.carrierScac][]=MSCU&filter[departure.services.carrierScac][]=MAEU
filter[departure.services.code]
string [ 2 .. 30 ] characters ^[A-Z0-9][A-Z0-9\s\-)(]*[A-Z0-9)]$

Filter by service code on departure. Exact match only.

Example: filter[departure.services.code]=LYNX
filter[departure.services.code][ne]
string [ 2 .. 30 ] characters ^[A-Z0-9][A-Z0-9\s\-)(]*[A-Z0-9)]$

Filter by service code on departure: not equal to the given value.

Example: filter[departure.services.code][ne]=LYNX
filter[departure.services.code][contains]
string [ 2 .. 30 ] characters ^[A-Z0-9][A-Z0-9\s\-)(]*[A-Z0-9)]$

Filter by service code on departure: partial match (contains the given value).

Example: filter[departure.services.code][contains]=LYNX
filter[departure.services.code][]
Array of strings <= 5 items

Filter by service code on departure (max 5 values, exact match only).

Example: filter[departure.services.code][]=LYNX&filter[departure.services.code][]=ALBATROS
filter[lastUpdatedAt]
string <date-time> ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

Filter by last update timestamp in UTC, formatted exactly as YYYY-MM-DDThh:mm:ssZ.

Example: filter[lastUpdatedAt]=2025-01-01T00:00:00Z
filter[lastUpdatedAt][gt]
string <date-time> ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

Filter by last update timestamp in UTC, formatted exactly as YYYY-MM-DDThh:mm:ssZ: greater than the given value. Combine with filter[lastUpdatedAt][lt] or filter[lastUpdatedAt][lte] to filter a range.

Example: filter[lastUpdatedAt][gt]=2025-01-01T00:00:00Z
filter[lastUpdatedAt][gte]
string <date-time> ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

Filter by last update timestamp in UTC, formatted exactly as YYYY-MM-DDThh:mm:ssZ: greater than or equal to the given value. Combine with filter[lastUpdatedAt][lt] or filter[lastUpdatedAt][lte] to filter a range.

Example: filter[lastUpdatedAt][gte]=2025-01-01T00:00:00Z
filter[lastUpdatedAt][lt]
string <date-time> ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

Filter by last update timestamp in UTC, formatted exactly as YYYY-MM-DDThh:mm:ssZ: less than the given value. Combine with filter[lastUpdatedAt][gt] or filter[lastUpdatedAt][gte] to filter a range.

Example: filter[lastUpdatedAt][lt]=2025-01-01T00:00:00Z
filter[lastUpdatedAt][lte]
string <date-time> ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

Filter by last update timestamp in UTC, formatted exactly as YYYY-MM-DDThh:mm:ssZ: less than or equal to the given value. Combine with filter[lastUpdatedAt][gt] or filter[lastUpdatedAt][gte] to filter a range.

Example: filter[lastUpdatedAt][lte]=2025-01-01T00:00:00Z
include
string^(vessels|terminals|ports|berths|carriers|com...

Comma-separated list of related resources to include in the response. Any subset of the supported values can be combined by joining them with a , — for example include=vessels,ports,commercialOperatorGroup.

Supported values:

  • vessels — sideloads the vessel resource for each call.
  • terminals — sideloads the terminal resource for each call.
  • ports — sideloads the port resource for each call.
  • berths — sideloads the berth resource for each call. Only calls that expose a berth (ongoing / past) contribute a berth resource.
  • carriers — sideloads every service carrier resource declared for the call's vessel.
  • commercialOperator — sideloads the carrier acting as the vessel's commercial operator for the call.
  • carrierGroups — sideloads every carrier group resolved from the call's service carriers (deduplicated).
  • alliances — sideloads every alliance resolved from the call's service carrier groups (deduplicated).
  • commercialOperatorGroup — sideloads the carrier group the commercial operator belonged to at the call's arrival time.
  • commercialOperatorAlliance — sideloads the alliance the commercial operator's group participated in at the call's arrival time.
Example: include=vessels,terminals,ports,carrierGroups,alliances,commercialOperatorGroup,commercialOperatorAlliance
page
integer >= 1
Default: 1

Page number for pagination

Example: page=1
header Parameters
Accept
string

Specify the desired response format.

  • For JSON responses (JsonAPI standard), use application/vnd.api+json, application/json or */*.
  • For CSV responses, use text/csv.

If not specified, the response will be in application/vnd.api+json format.

Enum: "*/*" "application/vnd.api+json" "application/json" "text/csv"
Example: application/vnd.api+json
Responses
200

A list of shipping call data

422

Validation error

500

Internal Server Error

get/shipping/calls
Request samples
const axios = require('axios');

const API_KEY = 'API_KEY';

const params = {
  'filter[status]': 'ongoing',
  'filter[metrics.waitingTime][gte]': 10,
  'filter[metrics.stayTime][lte]': 50,
  'filter[vessel.name][contains]': 'EMPIRE',
  'filter[port.unlocode]': ['DEHAM', 'BEANR'],
  include: 'vessels,ports,terminals'
};

axios.get('https://api.kpler.com/v1/logistics/containers/shipping/calls', {
  headers: {
    'Accept': 'application/vnd.api+json',
    'X-Container-API-Key': API_KEY
  },
  params
})
.then(response => {
  console.dir(response.data, {depth:null});
})
.catch(error => {
  if (error.response) {
    console.dir(error.response.data, {depth:null});
  } else {
    console.error('Request failed:', error.message);
  }
});
Response samples
{
  • "data": [
    ],
  • "included": [
    ]
}

Tracking requests

Introduction

Create tracking requests to start your container tracking experience.

Supported Shipping Lines / Freight Forwarders & SCAC List

Please contact your sales representative or account manager to get the up to date list of supported shipping lines and freight forwarders.

Create tracking requests

Create tracking requests to start your container tracking experience.
Up to 100 tracking requests can be created in the same call.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
required
Array of objects (CreateTrackingRequestBody)
Responses
200

Successful operation

400

Bad request

422

Unable to process request

500

Internal Server Error

post/tracking-requests
Request samples
application/json
{
  • "data": [
    ]
}
Response samples
application/json
{}

List tracking requests

Retrieve a list of the tracking requests created.
The list can be filtered by reference number, tags and more.
The list is divided into pages of 50 entries each.
Pagination links are provided for easy navigation.

SecurityApiKeyAuth
Request
query Parameters
object

Structure that can be used as payload when calling the Tracking Request list endpoint.
When the filters contain values that return no results, an empty response will be sent.
Filters can be applied to reference Number, reference number types, scac and tags.

page
integer >= 1
Default: 1

Page number for pagination. Each page contains 50 entries; use links.next in the response to follow pagination.

Responses
200

successful operation

500

Internal Server Error

get/tracking-requests
Request samples
const request = require('request');

const options = {
    method: 'GET',
    url: 'https://api.kpler.com/v1/logistics/containers/tracking-requests',
    qs: {filter: { scac: ['TXZJ', 'LMCU'] }},
    headers: {'X-Container-API-Key': 'REPLACE_KEY_VALUE'}
};

request(options, function (error, response, body) {
    if (error) throw new Error(error);

    console.log(body);
});
Response samples
application/json
{}

Get tracking request details

Retrieve a specific tracking request and all associated information.

SecurityApiKeyAuth
Request
path Parameters
trackingRequestId
required
string

Id of Tracking Request to return

Responses
200

successful operation

404

Tracking request not found

500

Internal Server Error

get/tracking-requests/{trackingRequestId}
Request samples
const request = require('request');

const options = {
  method: 'GET',
  url: 'https://api.kpler.com/v1/logistics/containers/tracking-requests/%7BtrackingRequestId%7D',
  headers: {'X-Container-API-Key': 'REPLACE_KEY_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
Response samples
application/json
{}

(Un)Archive tracking requests

(Un)Archive tracking requests and their related shipment.

SecurityApiKeyAuth
Request
path Parameters
operation
required
string

The operation that will be executed.

Enum: "add" "remove"
Request Body schema: application/json
required

(Un)Archive the Tracking Requests id list.

object (ArchiveTrackingRequestsRequestBody)
Responses
204

successful operation

400

Bad request

422

Unable to process request

500

Internal Server Error

post/tracking-requests/archive/{operation}
Request samples
application/json
{
  • "data": {
    }
}
Response samples
application/json
{
  • "errors": [
    ]
}

Shipments

Access and manage your container tracking data.

List shipments

Retrieve a list of your shipments.
The list can be filtered by reference number, scac, tags, departure and arrival date range, origin and destination port.

SecurityApiKeyAuth
Request
query Parameters
object

Structure that can be used as payload when calling the Shipment list endpoint.
When the filters contain values that return no results, an empty response will be sent.
Filters can be applied to reference Number, reference number types, scac, tags date ranged for arrival and departure, as well as origin and destination of a shipment.

page
integer >= 1
Default: 1

Page number for pagination. Each page contains 50 entries; use links.next in the response to follow pagination.

Responses
200

successful operation

500

Internal Server Error

get/shipments
Request samples
const request = require('request');

const options = {
    method: 'GET',
    url: 'https://api.kpler.com/v1/logistics/containers/shipments',
    qs: {filter: { scac: ['TXZJ', 'LMCU'] }},
    headers: {'X-Container-API-Key': 'REPLACE_KEY_VALUE'}
};

request(options, function (error, response, body) {
    if (error) throw new Error(error);

    console.log(body);
});
Response samples
application/json
{}

Get shipment summary

Retrieve a specific shipment and a comprehensive summary of all associated information.

SecurityApiKeyAuth
Request
path Parameters
shipmentId
required
string

Id of Shipment to return

Responses
200

successful operation

400

Bad request

404

Shipment not found

422

Unable to process request

500

Internal Server Error

get/shipments/{shipmentId}
Request samples
const request = require('request');

const options = {
  method: 'GET',
  url: 'https://api.kpler.com/v1/logistics/containers/shipments/%7BshipmentId%7D',
  headers: {'X-Container-API-Key': 'REPLACE_KEY_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
Response samples
application/json
{
  • "data": {
    },
}

Get shipment detailed milestones

Retrieve all milestones, locations and vessels associated with a specific shipment.

SecurityApiKeyAuth
Request
path Parameters
shipmentId
required
string

ID of Shipment to return the associated transportation timeline

Responses
200

successful operation

400

Bad request

404

Shipment not found

422

Unable to process request

500

Internal Server Error

get/shipments/{shipmentId}/transportation-timeline
Request samples
const request = require('request');

const options = {
  method: 'GET',
  url: 'https://api.kpler.com/v1/logistics/containers/shipments/%7BshipmentId%7D/transportation-timeline',
  headers: {'X-Container-API-Key': 'REPLACE_KEY_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
Response samples
application/json
{
  • "data": {
    },
}

Replace all shipment tags

SecurityApiKeyAuth
Request
path Parameters
shipmentId
required
string

ID of Shipment to update the associated tags

Request Body schema: application/json
required

Replace all the existing tags with a new list of tags.

required
Array of objects (ShipmentTagsRequestBody)
Responses
200

successful operation

400

Bad request

404

Shipment not found

422

Unable to process request

500

Internal Server Error

post/shipments/{shipmentId}/sync-tags
Request samples
application/json
{
  • "data": [
    ]
}
Response samples
application/json
{
  • "data": {
    }
}

Add tags to a shipment

SecurityApiKeyAuth
Request
path Parameters
shipmentId
required
string

ID of Shipment to add tags to.

Request Body schema: application/json
required

Add listed tags to the shipment.

Array of objects (ShipmentTagsRequestBody)
Responses
200

successful operation

400

Bad request

404

Shipment not found

422

Unable to process request

500

Internal Server Error

post/shipments/{shipmentId}/add-tags
Request samples
application/json
{
  • "data": [
    ]
}
Response samples
application/json
{
  • "data": {
    }
}

Remove tags from a shipment

SecurityApiKeyAuth
Request
path Parameters
shipmentId
required
string

ID of Shipment to remove tags from.

Request Body schema: application/json
required

Remove listed tags from the shipment.

Array of objects (ShipmentTagsRequestBody)
Responses
200

successful operation

400

Bad request

404

Shipment not found

422

Unable to process request

500

Internal Server Error

post/shipments/{shipmentId}/remove-tags
Request samples
application/json
{
  • "data": [
    ]
}
Response samples
application/json
{
  • "data": {
    }
}

Webhook events

Introduction

The Webhook API enables your system to subscribe to specific container tracking events and receive realtime updates about them. The current version supports the following events:

  • shipment_updated: Triggered when one of your shipment has been updated.
  • tracking_request_succeeded: Triggered when your tracking request has been successfully processed and the underlying shipment successfully created.
  • tracking_request_failed: Triggered when your tracking request has faild. To start receiving webhook events, reach out to get a webhook URL that will receive the event updates.

Getting Started

To begin using the Webhook API, follow these steps:

  1. Register for the service: Contact your account manager to register for the Webhook service.
  2. Webhook URL Setup: You should provide us the URL where you'd like to receive our webhook events and payloads.

Important: Only one URL is supported per user in the current version, and all events will be pushed to this URL.

Webhook Security

IP Whitelisting: To ensure that the events you receive are from the Webhook API and not from unauthorized sources, webhooks will only be dispatched from the following IP address(es): 3.251.15.122, 52.215.44.244, 54.195.123.104.

Error Handling

In the event that your system cannot process a webhook request, ensure your endpoint responds with a 500 HTTP status code. The system will attempt a limited number of retries in case of failures.

shipment_updatedWebhook

The event is triggered when the shipment has been updated.
The webhook includes the new version of the shipment.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
object
required
Array of objects (Shipment)
Responses
200

Return a 200 status to indicate that the data was received successfully.

500

Return a 500 status to indicate that the data was not received successfully.

Request samples
application/json
{
  • "data": {},
  • "included": [
    ]
}

tracking_requested_succeededWebhook

The event is triggered when your tracking request has been successfully processed and the underlying shipment has been successfully created.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
object
required
object (TrackingRequest)

Contains all information associated with a specific tracking request.

Responses
200

Return a 200 status to indicate that the data was received successfully.

500

Return a 500 status to indicate that the data was not received successfully.

Request samples
application/json
{}

tracking_requested_failedWebhook

The event is triggered when your tracking request has failed. It contains details about the failing reason.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
object
required
object (TrackingRequest)

Contains all information associated with a specific tracking request.

Responses
200

Return a 200 status to indicate that the data was received successfully.

500

Return a 500 status to indicate that the data was not received successfully.

Request samples
application/json
{}

2026-11-12 (1.7.0)

DEVELOPER NOTICE | CODEGEN IMPACT
This documentation update may impact generated client libraries.
Please regenerate your SDKs to ensure compatibility.

This release only updates the documentation. The API behavior is unchanged; the specification now matches the actual requests and responses.

DOCUMENTATION UPDATE: Container Intelligence API | Filters

For /terminal-congestions and /shipping/calls:

  • Each filter operator is now documented as its own query parameter, replacing the generic [operator] placeholder: [gt], [gte], [lt], [lte] for numeric and timestamp filters, and [ne], [contains] for text filters. For example: filter[liveMetrics.congestionIndex][gte]=5.
  • Timestamp filters must be formatted exactly as YYYY-MM-DDThh:mm:ssZ.
  • Exact match filters (eq, ne and list filters) are case-sensitive, while contains is case-insensitive. Port and vessel names are uppercase, e.g. HAMBURG.
  • filter[terminal.id], filter[port.id], filter[vessel.id], filter[berth.id] and their list variants are documented as integers.
  • The include parameter accepts any comma-separated combination of the supported values, in any order.
  • Parameter examples now use real terminals, ports, vessels and services.

DOCUMENTATION UPDATE: Container Tracking API | Requests

  • The page query parameter is documented on GET /tracking-requests and GET /shipments.
  • Filter limits are documented: referenceNumber must be 4 to 20 characters; referenceNumberList, scac and tagLabels accept up to 10 values; trackingRequestStatusNames accepts up to 4 values; departurePortNames and arrivalPortNames accept up to 10 values (previously documented as 30) of up to 30 characters each.
  • filter[tagContains] is a single string, not an array.

DOCUMENTATION UPDATE: Container Tracking API | Responses

  • Dates are returned in UTC as YYYY-MM-DD hh:mm:ss, without the T separator or a timezone designator (previously documented as 2024-01-01T00:00:00.000Z). This applies to the Date object (created, eventDateTime, detectedAt, arrival and departure timestamp), to insights.initialCarrierEta and to the webhook createdAt.
  • The shipment updated attribute is returned in UTC, ISO 8601 format with microseconds (YYYY-MM-DDThh:mm:ss.ssssssZ), and can be null.
  • Port lat and lon, and transportation timeline location lat and lon, are strings.
  • Container size.height is a string, e.g. "9.6".
  • Transportation timeline location type values are port_of_loading and transhipment_port (previously documented as port_of_Loading and transhipment_Port).
  • The transportation timeline type is transportation_timeline (previously documented as transportation-timeline).
  • Equipment event equipmentReference is a single container ID, not an array.
  • The following attributes can be null: insights.arrivalDelayDays, currentVessel, currentVessel.latestPosition, and the transport event locationId, vesselId and eventOrder.

DOCUMENTATION UPDATE: Webhook Events

  • For tracking_request_succeeded and tracking_request_failed, included is a single tracking request object, not an array. shipment_updated is unchanged.

DOCUMENTATION UPDATE: Supported Carriers

  • The list of supported shipping lines and freight forwarders is now provided on request by your sales representative or account manager.

2026-07-28 (1.6.0)

DEVELOPER NOTICE | CODEGEN IMPACT
Changes in this release may impact generated client libraries.
Please regenerate your SDKs to ensure full compatibility and benefit from the new features.

NEW FEATURE: Shipping Calls | Berth

Berth information is now exposed on the /shipping/calls endpoint. The berth a vessel occupies or occupied is surfaced once the call has reached the berth — that is, for ongoing (in-berth) and past (completed) calls. Earlier stages (future) hide the berth.

New relationship on the Call resource:

  • relationships.berth: to-one JSON:API relationship pointing to the berth resource for the call. data is null for future calls and when no berth is known.

New include value:

  • berths can be passed via the include query parameter (alone or combined with the existing include values) to sideload berth resources in the included array.

New included resource type:

  • berth: id is the MarineTraffic berth ID. attributes is name (berth name, or an empty string when unknown).

New filters:

  • filter[berth.id] - Filter by berth MT ID. Exact match only.
  • filter[berth.id][] - Filter by a list of berth MT IDs (max 5 values, exact match only).
  • filter[berth.name] - Filter by berth name. Supported operators: eq, contains, ne.
  • filter[berth.name][] - Filter by a list of berth names (max 5 values, exact match only).

CSV response update

  • A Berth MT Id column is now always present in the CSV response (empty for calls that do not expose a berth).
  • A Berth Name column is added when include=berths is requested.

2026-07-27 (1.5.0)

DEVELOPER NOTICE | CODEGEN IMPACT
Changes in this release may impact generated client libraries.
Please regenerate your SDKs to ensure full compatibility and benefit from the new features.

NEW FEATURE: Shipping Calls | Carrier Groups and Alliances

Carrier group and alliance information is now exposed on the /shipping/calls endpoint. For each call, the vessel's commercial operator resolves to the group it belonged to and the alliance that group participated in at the arrival timestamp, and the same resolution is applied to every service carrier declared for the vessel.

New relationships on the Call resource:

  • relationships.commercialOperatorGroup: to-one JSON:API relationship pointing to the carrier group the commercial operator belonged to at the call's arrival time. data is null when no group was resolved.
  • relationships.commercialOperatorAlliance: to-one JSON:API relationship pointing to the alliance that group participated in at the call's arrival time. data is null when no alliance was resolved.
  • relationships.carrierGroups: to-many JSON:API relationship listing every carrier group resolved from the call's service carriers (deduplicated).
  • relationships.alliances: to-many JSON:API relationship listing every alliance resolved from the call's service carrier groups (deduplicated).

New include values:

  • commercialOperatorGroup sideloads the commercial operator's carrier group resource in the included array.
  • commercialOperatorAlliance sideloads the commercial operator's alliance resource in the included array.
  • carrierGroups sideloads every unique service-carrier group resource in the included array.
  • alliances sideloads every unique service-carrier alliance resource in the included array.

All four values can be combined with the existing include values (vessels, terminals, ports, carriers, commercialOperator) via a comma-separated list.

New included resource types:

  • carrier-group: id is a 26-character ULID. attributes are name and country (country display name, or null when the group has no registered country).
  • alliance: id is a 26-character ULID. attributes is name.

New filters:

  • filter[commercialOperatorGroup.name] - Filter by commercial operator's group display name. Supported operators: eq, contains, ne.
  • filter[commercialOperatorGroup.name][] - Filter by a list of group display names (max 5 values, exact match only).
  • filter[commercialOperatorGroup.country] - Filter by the country name (not ISO code) the commercial operator's group is registered in. Supported operators: eq, contains, ne.
  • filter[commercialOperatorGroup.country][] - Filter by a list of country names (max 5 values, exact match only).
  • filter[commercialOperatorAlliance.name] - Filter by commercial operator's alliance display name. Supported operators: eq, contains, ne.
  • filter[commercialOperatorAlliance.name][] - Filter by a list of alliance display names (max 5 values, exact match only).

CSV response update

The CSV response of /shipping/calls now emits optional columns only when the matching include value is requested, keeping the CSV width predictable. Additional columns available when the corresponding include is passed:

  • Commercial Operator Group, Commercial Operator Group Country (via include=commercialOperatorGroup).
  • Commercial Operator Alliance (via include=commercialOperatorAlliance).
  • Carrier Groups — comma-separated display names of the service carrier groups (via include=carrierGroups).
  • Alliances — comma-separated display names of the service carrier alliances (via include=alliances).

The existing Carriers and Commercial Operator columns are likewise now gated behind their respective includes (include=carriers / include=commercialOperator) for consistency.

2026-06-17 (1.4.0)

DEVELOPER NOTICE | CODEGEN IMPACT
Changes in this release may impact generated client libraries.
Please regenerate your SDKs to ensure full compatibility and benefit from the new features.

NEW FEATURE: Shipping Calls | Vessel Commercial Operator and Carriers

The vessel's commercial operator and carrier information is now exposed on the /shipping/calls endpoint for each call.

New relationship on the Call resource:

  • relationships.commercialOperator: to-one JSON:API relationship pointing to the carrier acting as the vessel's commercial operator for the call.
  • relationships.carriers: to-many JSON:API relationship listing all carriers associated with the call (any role).

New include value:

  • commercialOperator can now be passed via the include query parameter (alone or combined with vessels, terminals, ports, carriers) to sideload the commercial operator carrier resource in the included array.
  • carriers can now be passed via the include query parameter (alone or combined with vessels, terminals, ports, commercialOperator) to sideload carrier resources in the included array.

New filters:

  • filter[commercialOperator.scac] - Filter by commercial operator SCAC code. Supported operators: eq, contains, ne.
  • filter[commercialOperator.scac][] - Filter by a list of SCAC codes (max 5 values, exact match only).
  • filter[commercialOperator.name] - Filter by commercial operator display name. Supported operators: eq, contains, ne.
  • filter[commercialOperator.name][] - Filter by a list of display names (max 5 values, exact match only).
  • filter[carriers.scac] - Filter by carrier SCAC code. Supported operators: eq, contains, ne.
  • filter[carriers.scac][] - Filter by a list of SCAC codes (max 5 values, exact match only).
  • filter[carriers.name] - Filter by carrier display name. Supported operators: eq, contains, ne.
  • filter[carriers.name][] - Filter by a list of display names (max 5 values, exact match only).

CSV response update Three new columns have been added to the CSV response of /shipping/calls:

  • Carriers - Display names of all carriers associated with the call (any role).
  • Commercial Operator Name - Display name of the vessel's commercial operator for the call.

2026-02-24 (1.3.0)

DEVELOPER NOTICE | CODEGEN IMPACT
Changes in this release may impact generated client libraries.
Please regenerate your SDKs to ensure full compatibility and benefit from the new features.

NEW FEATURE: New Filter Operators

The ne (not equals) operator has been added to following filters:

For /shipping/calls:

  • filter[status], filter[vessel.name], filter[terminal.name], filter[terminal.smdgCode], filter[port.name], filter[port.unlocode]

For /terminal-congestions:

  • filter[terminal.name], filter[terminal.smdgCode], filter[port.name], filter[port.unlocode]

The gt (greater than) and lt (less than) operators have been added to all the filters that support the gte and lte operators.

NEW FEATURE: Shipping Calls | Service Filters

New filters have been added to the /shipping/calls endpoint to filter by vessel services:

  • filter[arrival.services.carrierScac] - Filter by carrier SCAC code on arrival. Supported operators: eq, contains, ne.
  • filter[arrival.services.code] - Filter by service code on arrival. Supported operators: eq, contains, ne.
  • filter[departure.services.carrierScac] - Filter by carrier SCAC code on departure. Supported operators: eq, contains, ne.
  • filter[departure.services.code] - Filter by service code on departure. Supported operators: eq, contains, ne.
  • filter[lastUpdatedAt] - Filter by last update timestamp. Supported operators: eq, gt, gte, lt, lte.

NEW FEATURE: Terminal Congestion | Live Metrics

New attributes have been added to the /terminal-congestions endpoint

  • liveMetrics.vesselsWaitingAvgTime: the live average waiting time (in hours) of all vessels that are currently waiting to enter the terminal.
  • liveMetrics.vesselsStayAvgTime: the live average stay time (in hours) of all vessels that are currently staying at the terminal.
  • liveMetrics.vesselsStay: number of vessels currently staying at the terminal.

NEW FEATURE: Vessel course

New attribute course has been added to the ContainerIntelligenceVesselPosition object.

DOCUMENTATION UPDATE

  • Corrected rate limit documentation from 200 to 500 requests per minute.
  • Update the example of the TerminalCongestionsCsvResponse object to reflect the actual CSV response.
  • Reflect that heading, speed, geographicalArea, lastUpdatedAt attributes of the ContainerIntelligenceVesselPosition object can be null.

2025-11-26 (1.2.2)

DOCUMENTATION UPDATE:

  • Added the whitelisted webhook IPs to the Webhook section; previously, they were only listed in the API Introduction section.

2025-11-05 (1.2.1)

API CHANGES:

  • ShippingCallsCsvResponse now includes two new service columns: Arrival Services and Departure Services. Therefore, the previous single Services column has been removed.

DOCUMENTATION CHANGES:

DEVELOPER NOTICE | CODEGEN IMPACT
This documentation fix may impact generated client libraries.
Please regenerate your SDKs to ensure compatibility.

  • ShippingCallsCsvResponse example changed to reflect the API changes.

2025-10-23 (1.2.0)

NEW FEATURE: Container Intelligence API | Shipping Calls

  • New endpoint GET /shipping/calls to get insights about container vessel calls.
  • This new endpoint replaces /shipping/schedule-events - it will remain in operation for a while, but going forward using /shipping/calls is advised.
  • Added the latest position object in the vessel resource

DOCUMENTATION FIX

DEVELOPER NOTICE | CODEGEN IMPACT
This documentation fix may impact generated client libraries.
Please regenerate your SDKs to ensure compatibility.

  • Fixed the schema of the VesselResource object.
  • Removed error code invalid_date from the TerminalCongestionsValidationErrorResponse object.
  • Added error code utc_date_time_format_invalid to the TerminalCongestionsValidationErrorResponse object.
  • Added filter[terminal.name] to the /terminal-congestions endpoint.

2025-09-17 (1.1.0)

NEW FEATURE: Container Intelligence API | Terminal Congestion

  • New endpoint GET /terminal-congestions to get insights on terminal congestion.
  • Reorganized documentation to include a new "Container Intelligence API" section and product description.

DOCUMENTATION FIX

DEVELOPER NOTICE | CODEGEN IMPACT
This documentation update may impact generated client libraries.
Please regenerate your SDKs to ensure compatibility.

  • Fixed the schema of Port and Terminal in the shipping/schedule-events endpoint.

2025-08-22 (1.0.3)

DOCUMENTATION FIX

DEVELOPER NOTICE | CODEGEN IMPACT
This documentation fix may impact generated client libraries.
Please regenerate your SDKs to ensure compatibility.

  • Added 5 values missing from API documentation for the equipmentEventTypeName enum: customs_released, customs_selected_for_inspection, customs_selected_for_scan, inspected, received.

2025-07-16 (1.0.2)

DOCUMENTATION UPDATE

  • Added a relevant filter[unlocode] example for the shipping/schedule-events endpoint.

2025-07-02 (1.0.1)

DOCUMENTATION FIX

DEVELOPER NOTICE | CODEGEN IMPACT
This documentation fix may impact generated client libraries.
Please regenerate your SDKs to ensure compatibility.

  • Added terminal in the shipping/schedule-events endpoint.
  • Fixed the schema of the included attribute in the shipping/schedule-events endpoint.

2025-06-17 (1.0.0)

DOCUMENTATION UPDATE

Reset documentation version to 1.0.0 to align with the API version (/v1/). No change in functionality.

2025-06-10

DOCUMENTATION FIX

DEVELOPER NOTICE | CODEGEN IMPACT
This documentation fix may impact generated client libraries.
Please regenerate your SDKs to ensure compatibility.

  • Updated the attribute name from portOfTranshipment to portsOfTransshipment in the GET /shipments/{shipmentId} endpoint to match the actual API response.

DOCUMENTATION UPDATE

2025-05-26

NEW FEATURE

DEPRECATED

The following items are deprecated.

IMPORTANT | MIRATION ACTION REQUIRED We encourage you to migrate to the new server URL and API key header defined above as soon as possible. The old server URL and API key header remain functional. We have not set a removal date yet.

DOCUMENTATION UPDATE

  • Changelog introduction
  • Global reorganization with the introduction of the Shipping schedules endpoint.