List Stoppage Events

Retrieve list of stoppage events for vessels. Stoppage Events are defined as events where vessels have longer period under 8 knots. See methodology for more details. Currently this API only supports filtering by IMO numbers.

Example questions that can be answered with this endpoint:

  • Have vesel XYZ have any prolonged periods of slow speed?

  • When was the last time vessel XYZ stopped?

class oceanbolt.sdk.data.vessels.StoppageEvents(client: oceanbolt.sdk.client.APIClient)[source]

The StoppageEvents returns list of historical stoppage events.

get(**kwargs)[source]

Retrieves timeseries data as a pandas.DataFrame

Example

List the most recent stoppage events for vessel CHARMEY (9583706)?

from oceanbolt.sdk.client import APIClient
from oceanbolt.sdk.data.vessels import StoppageEvents
from datetime import date,timedelta


base_client = APIClient("<token>")
df = StoppageEvents(base_client).get(
    imo=[9583706],
)

Returns:

imo

startedAt

endedAt

portId

portName

zoneId

zoneName

minSpeedObserved

durationHours

lat

lon

classification

9583706

2021-03-25T10:26:15Z

2021-03-25T16:51:33Z

5264

Mindelo

9

East Atlantic Ocean (Africa)

0

6.42166666666667

16.89492

-25.01568

PORT_STAY

9583706

2021-04-02T07:31:55Z

2021-04-12T21:36:00Z

802

La Pallice

46

Bay of Biscay

0

254.068055555556

46.15896

-1.23298

PORT_STAY

9583706

2021-04-13T01:45:33Z

2021-04-14T12:30:35Z

46

Bay of Biscay

1.1

34.7502944444444

46.41442

-2.75874

AT_SEA

9583706

2021-04-15T19:48:11Z

2021-04-16T10:55:00Z

24

North Atlantic Ocean (Continent)

5.4

15.1136111111111

50.52954

1.02962

AT_SEA

9583706

2021-04-16T17:55:05Z

2021-04-30T03:50:00Z

156

Antwerp

24

North Atlantic Ocean (Continent)

0

321.915277777778

51.32929

4.30511

PORT_STAY

Arguments

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

VesselStoppageEvents

imo

included vessel imos

Type

Sequence[int]

startDate
Type

str

endDate
Type

str

format_

response format (default is json, supported: csv, xlsx)

Type

str

Response

class oceanbolt.com.vessels_v3.types.ListStoppageEventsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]
stoppage_events
Type

Sequence[oceanbolt.com.vessels_v3.types.StoppageEvent]

csv
Type

str

xlsx
Type

str

class oceanbolt.com.vessels_v3.types.StoppageEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]
imo
Type

int

started_at
Type

str

ended_at
Type

str

port_id
Type

int

port_name
Type

str

zone_id
Type

int

zone_name
Type

str

min_speed_observed
Type

google.protobuf.wrappers_pb2.DoubleValue

duration_hours
Type

google.protobuf.wrappers_pb2.DoubleValue

lat
Type

float

lon
Type

float

classification
Type

str