Berth Details
Production
https://api.polestar-production.com
Production
https://api.polestar-production.com
GET
https://api.polestar-production.com
1.
berth_details: static berth specifications, plus average and mediandwell times that depend on the filters.
2.
dwell_time_series: dwell-time chart points, daily when the date rangeis 30 days or less and weekly when it is longer.
3.
occupancy.visits: individual vessel visits, paginated, for a Ganttchart, with the idle
occupancy.gaps between them.4.
occupancy.top_vessels: the top N vessels by total dwell time, for atable.
query.view_mode (gantt or table) to decide which occupancy view toshow:
gantt when the date range is 90 days or less, otherwise table. Usequery.dwell_series_granularity (daily or weekly) to interpretdwell_time_series.Path parameter: id_type
| Value | Meaning |
|---|---|
id | Internal port UUID |
unlocode | UN/LOCODE (e.g. NLRTM) |
Error codes
| Code | HTTP | Condition |
|---|---|---|
| ERROR_300 | 400 | date_start is after date_end |
| ERROR_301 | 400 | id_type is not id or unlocode |
| ERROR_302 | 404 | No port found for the given identifier |
| ERROR_303 | 400 | Date range exceeds 2 years |
| ERROR_304 | 400 | date_start is before 2025-01-01 (historical data start) |
| ERROR_305 | 404 | No berth found for the given berth_id |
Request
Path Params
Query Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.polestar-production.com/maritime-analytics/v1/analytics/ports/unlocode/PABLB/berths/bb90f1f3-3590-4061-a40e-bda4d68bb449?date_start=2026-02-22&date_end=2026-03-23&vessel_flag=CYP&page=undefined&page_size=undefined&top_n=undefined' \
--header 'api-key: <api-key>'Response Response Example
200 - One Rotterdam berth, September 2026
{
"meta": {
"request_id": "9f18ded3-8e6d-458d-9cd9-fba9e9a8e937",
"request_timestamp": "2026-09-30T10:30:06Z"
},
"query": {
"date_start": "2026-09-01",
"date_end": "2026-09-28",
"vessel_flags": [],
"page": 1,
"page_size": 14,
"top_n": 10,
"view_mode": "gantt",
"dwell_series_granularity": "daily"
},
"berth_details": {
"berth_id": "d8bca3f5-5daa-4e77-bf37-ee046257713f",
"berth_name": "1S",
"berth_status": "Active",
"terminal_operator": "Beatrix Terminal",
"terminal_type": "Quay",
"berth_facility": "Both",
"length_m": 350,
"max_loa_m": 230,
"max_dwt": 81000,
"depth_lw_m": 11.65,
"avg_dwell_time": 3.33,
"median_dwell_time": 3.33
},
"dwell_time_series": [
{
"period_start": "2026-09-14"
},
{
"period_start": "2026-09-15"
}
],
"occupancy": {
"display_date_start": "2026-09-01",
"display_date_end": "2026-09-14",
"gap_time_total": 232.99,
"gap_time_avg": 232.99,
"pagination": {
"total_days": 28,
"page": 1,
"page_size": 14,
"day_start": 1,
"day_end": 14
},
"visits": [],
"gaps": [],
"top_vessels": [
{
"imo_number": "9677911",
"vessel_name": "HYDROVAC 12",
"ship_type_level_3": "Oil tanker",
"visit_count": 1,
"total_dwell_time": 6.26,
"avg_dwell_time": 6.26
},
{
"imo_number": "8354732",
"vessel_name": "INVOTIS VII",
"ship_type_level_3": "General cargo",
"visit_count": 1,
"total_dwell_time": 0.39,
"avg_dwell_time": 0.39
}
]
}
}Modified at 2026-10-21 13:57:11