Port Particulars Data

Retrieve port particulars data for a given port/terminal based on physical characteristics of the vessels that have actually visited the port/terminal.

Example questions that can be answered with this endpoint:

  • What is the maximum draught, loa and beam of the vessels that visited the Port of Narvik in the past 6 months?

class oceanbolt.sdk.data.port_calls.PortParticulars(client: oceanbolt.sdk.client.APIClient)[source]

The PortParticulars returns data about port particulars (max beam, max loa, max draught etc) based on the physical characteristics of the most recent port calls.

get_raw(**kwargs)[source]

Retrieves port particular data as a python class

Example

  • What is the maximum draught, loa and beam of the vessels that visited the Port of Narvik in the past 6 months?

from oceanbolt.sdk.client import APIClient
from oceanbolt.sdk.data.port_calls import PortParticulars
from datetime import date,timedelta


base_client = APIClient("<token>")
df = PortParticulars(base_client).get_raw(
    unlocode="NONVK"
    start_date=date.today() - timedelta(days=180),
)

Returns:

{
  "loa": {
    "min": 17309,
    "max": 211153,
    "percentile10": 17309,
    "percentile50": 82000,
    "percentile90": 205236,
    "percentile95": 207392.5,
    "mean": 117732.08571428571,
    "percentile99": 210950
  },
  "beam": {
    "min": 24,
    "max": 50,
    "percentile10": 24,
    "percentile50": 32.26,
    "percentile90": 49,
    "percentile95": 50,
    "mean": 38.199160000000028,
    "percentile99": 50
  },
  "maxDraught": {
    "min": 6.9,
    "max": 18.6,
    "percentile10": 8.42,
    "percentile50": 14.5,
    "percentile90": 18.37,
    "percentile95": 18.4,
    "mean": 14.919417473876365,
    "percentile99": 18.6
  },
  "reportedDraught": {
    "min": 6.6,
    "max": 18.7,
    "percentile10": 8.7,
    "percentile50": 14.4,
    "percentile90": 18.3,
    "percentile95": 18.45,
    "mean": 13.921904761904758,
    "percentile99": 18.55
  },
  "dwt": {
    "min": 17309,
    "max": 211153,
    "percentile10": 17309,
    "percentile50": 82000,
    "percentile90": 205236,
    "percentile95": 207392.5,
    "mean": 117732.08571428571,
    "percentile99": 210950
  },
  "numberOfPortCalls": 105
}

Arguments

class oceanbolt.com.portcalls_v3.types.GetPortParticularsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Request object for GetPortParticulars

start_date

The UTC start date of the date filter.

Type

str

end_date

The UTC end date of the date filter.

Type

str

port_id

Oceanbolt port identifier to filter on.

Type

int

berth_id

Oceanbolt berth identifier to filter on.

Type

int

unlocode

Unlocode port identifier to filter on.

Type

str

last_n_days

Alternative way of specifying date filter. If specified, then data will only be based on port calls in last X days.

Type

int

Response

class oceanbolt.com.portcalls_v3.types.GetPortParticularsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Response object for GetPortParticulars

number_of_port_calls

Number of port calls which forms the basis of the statistical aggregates.

Type

int

loa

Summary statistics for LOA.

Type

oceanbolt.com.portcalls_v3.types.Statistic

beam

Summary statistics for Beam.

Type

oceanbolt.com.portcalls_v3.types.Statistic

max_draught

Summary statistics for Maximum Design Draught.

Type

oceanbolt.com.portcalls_v3.types.Statistic

reported_draught

Summary statistics for Vessel Reported Draught.

Type

oceanbolt.com.portcalls_v3.types.Statistic

dwt

Summary statistics for DWT.

Type

oceanbolt.com.portcalls_v3.types.Statistic

air_draught

Summary statistics for Air Draught (if available).

Type

oceanbolt.com.portcalls_v3.types.Statistic

class oceanbolt.com.portcalls_v3.types.Statistic(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]
min_

Minimum observed value.

Type

float

max_

Maximum observed value.

Type

float

percentile_10

10th percentile of observed values.

Type

float

percentile_50

50th percentile of observed values (same as median).

Type

float

percentile_90

90th percentile of observed values.

Type

float

percentile_95

95th percentile of observed values.

Type

float

percentile_99

99th percentile of observed values.

Type

float

mean

mean of observed values.

Type

float