Get Vessel States

Retrieve list of vessel states for a given combination of IMO numbers and dates.

class oceanbolt.sdk.data.vessel_states.VesselStates(client: oceanbolt.sdk.client.APIClient)[source]

The VesselStates returns a list for VesselStates for the given dates and imo numbers requested.

get(**kwargs)[source]

Retrieves trade flow data as a pandas.DataFrame

Example

Retrive vessel states for Lowlands Tenacity and Lowlands Rise for 2021.

from oceanbolt.sdk.client import APIClient
from oceanbolt.sdk.data.vessel_states import VesselStates
from datetime import date

base_client = APIClient("<token>")
df = VesselStates(base_client).get(
    imo=[9583706,9659828],
    start_date=date(2020, 1, 1),
    end_date=date(2020, 12, 31),
)

Returns:

Arguments

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

Request message for VesselStateService.GetVesselStates

imo

included vessel imos

Type

Sequence[int]

start_date
Type

str

end_date
Type

str

Response

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

Request message for VesselStateService.GetVesselStates and VesselStateService.GetVesselStatesForDate.

vessel_states

A collection of VesselState objects that is returned by the API.

Type

Sequence[oceanbolt.com.vesselstates_v3.types.VesselState]

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

VesselState object

vessel_name

Name of the vessel.

Type

str

imo

IMO number of the vessel.

Type

int

mmsi

MMSI number of the vessel.

Type

int

timestamp

UTC timestamp for the VesselState.

Type

str

dwt

DWT of the vessel.

Type

float

segment

Segment of the vessel.

Type

str

sub_segment

Sub segment of the vessel.

Type

str

vessel_type

The vessel type.

Type

str

zone_id

Database identifier of the zone

Type

int

zone_name

Name of the zone

Type

str

port_id

Database identifier of the port

Type

int

port_name

Name of the port

Type

str

anchorage_id

Database identifier of the anchorage

Type

int

anchorage_name

Name of the anchorage

Type

str

berth_id

Database identifier of the berth

Type

int

berth_name

Name of the berth

Type

str

shipyard_id

Database identifier of the shipyard

Type

int

shipyard_name

Name of the shipyard

Type

str

related_port_id

Port id of the parent port (for vessels that are in anchorage/berth/shipyard)

Type

int

related_port_name

Name of the parent port (for vessels that are in anchorage/berth/shipyard)

Type

str

vessel_status

Status of the vessel

Type

str

laden_status_model

The laden status of the vessel as determined from the the Oceanbolt Algorithms, taking into account prior berth visits, prior draught changes etc.

Type

str

laden_status_draught

The laden status according to the current draught as reported by the Master.

Type

str

destination

Destination as reported by the crew

Type

str

destination_port_id

Parsed destination port id

Type

int

destination_port_name

Parsed destination port name

Type

str

destination_region

Parsed destination region

Type

str

destination_country_code

Parsed destination country code

Type

str

destination_score

Destination score for parsed destination result

Type

float

predicted_destination_port_id

Predicted destination port id

Type

int

predicted_destination_port_name

Predicted destination port name

Type

str

predicted_destination_region

Predicted destination region

Type

str

predicted_destination_country_code

Predicted destination country code

Type

str

predicted_destination_score

Destination score for predicted destination result

Type

float

eta
Type

str

navigational_status

Navigational status of the vessel

Type

str

navigational_status_code

Navigational status code of the vessel

Type

int

port_call_status
Type

str

commodity_id

Commodity id of the commodity carried

Type

int

commodity_group

Name of the commodity group carried

Type

str

commodity_name

Name of the commodity carried

Type

str

direction

The direction of the vessel

Type

str

speed_status

Indicating the speed of vessel

Type

str

last_visited_port_id

Database identifier of the last port visited (regardless of what operation happened in the port)

Type

int

last_visited_port_name

Name of the last port visited (regardless of what operation happened in the port)

Type

str

last_ops_port_id

Database identifier of the last port where load or discharge operation occurred

Type

int

last_ops_port_name

Name of the last port where load or discharge operation occurred

Type

str

volume_on_board

The estimated amount of volume onboard the vessel

Type

float

hours_carried_forward

A indicator describing if the given VesselState was recorded directly from AIS, or if it was backfilled and carried forward from the last received observation. The value is zero for observations that are derived directly from a received AIS position, for observations that are carried forward the value will indicate the number of hours the current observations has been carried forward.

Type

int