Back to App

Help Center

Get started and find answers to common questions

Quick Start Guide

1

Get Your API Key

Sign up at datadocked.com and get your API key from the dashboard. Enter it in the API Key field and click "Save Key".

2

Enter a Port UNLOCODE

Enter the 5-character UN/LOCODE for any port. Examples: NLRTM (Rotterdam), SGSIN (Singapore), USNYC (New York), CNSHA (Shanghai).

3

View Your Results

Click "Check Congestion" to see the port's congestion score, vessel counts, and detailed breakdowns. Expand sections to see individual vessel information.

Frequently Asked Questions

What is a UNLOCODE?

UN/LOCODE (United Nations Code for Trade and Transport Locations) is a 5-character code used to identify ports and other locations worldwide. It consists of a 2-letter country code followed by a 3-character location code.

  • NLRTM = NL (Netherlands) + RTM (Rotterdam)
  • SGSIN = SG (Singapore) + SIN (Singapore)
  • USNYC = US (United States) + NYC (New York City)

How is the congestion score calculated?

The congestion score (0-100) is calculated using a weighted algorithm that considers:

  • Waiting Vessels (30%) - Vessels near the port with speed <2 knots (likely anchored/waiting)
  • Vessels in Port (25%) - Current number of vessels at berth or in port area
  • Expected Arrivals (20%) - Scheduled incoming vessels
  • Throughput Factor (15%) - Ratio of departures to arrivals indicating port efficiency
  • Average Speed (10%) - Mean vessel speed in port area (lower = more congestion)

How many API credits does each query use?

Each congestion check uses approximately 160 credits:

  • Port calls (in_port, arrival, departure, expected): 50 credits each = 200 credits
  • Vessels by area search: 10 credits

The exact credit usage is displayed after each query. Check your credit balance at datadocked.com/dashboard.

What does each congestion level mean?

Congestion levels are determined by the score:

  • LOW 0-25: Port is operating smoothly with minimal waiting times
  • MODERATE 26-50: Normal activity levels, some waiting may occur
  • HIGH 51-75: Significant congestion, expect delays
  • CRITICAL 76-100: Severe congestion, consider alternative ports or timing

How often is the data updated?

The congestion data is fetched in real-time from the DataDocked API each time you make a query. The underlying AIS data is typically updated every few minutes, depending on vessel transmission frequency and satellite coverage.

What is the "Trend" indicator?

The trend indicator shows the direction of congestion change:

  • Increasing ↑ - More vessels expected than departing, congestion likely to worsen
  • Stable → - Balanced arrivals and departures, congestion likely steady
  • Decreasing ↓ - More departures than arrivals, congestion likely to improve

I can't find my port. What should I do?

Make sure you're using the correct 5-character UN/LOCODE. You can find official codes at the UNECE website. Our database covers over 7,400 ports worldwide. If a port is missing, please contact support.

Need More Help?