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: APIClient)
VesselStatesreturns a list for VesselStates for the given dates and imo numbers requested.
Retrieves trade flow data as a pandas.DataFrame
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), )
- class oceanbolt.com.vesselstates_v3.types.VesselStatesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for VesselStateService.GetVesselStates and VesselStateService.GetVesselStatesForDate.
A collection of VesselState objects that is returned by the API.
- class oceanbolt.com.vesselstates_v3.types.VesselState(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Name of the vessel.
IMO number of the vessel.
MMSI number of the vessel.
UTC timestamp for the VesselState.
DWT of the vessel.
Segment of the vessel.
Sub segment of the vessel.
The vessel type.
Database identifier of the zone
Name of the zone
Database identifier of the port
Name of the port
Database identifier of the anchorage
Name of the anchorage
Database identifier of the berth
Name of the berth
Database identifier of the shipyard
Name of the shipyard
Port id of the parent port (for vessels that are in anchorage/berth/shipyard)
Name of the parent port (for vessels that are in anchorage/berth/shipyard)
Status of the vessel
The laden status of the vessel as determined from the the Oceanbolt Algorithms, taking into account prior berth visits, prior draught changes etc.
The laden status according to the current draught as reported by the Master.
Destination as reported by the crew
Parsed destination port id
Parsed destination port unlocode
Parsed destination port name
Parsed destination region
Parsed destination country code
Destination score for parsed destination result
Predicted destination port id
Predicted destination port unlocode
Predicted destination port name
Predicted destination region
Predicted destination country code
Destination score for predicted destination result
description of how the prediction destination was determined
the predicted arrival to the predicted destination port
Navigational status of the vessel
Navigational status code of the vessel
Commodity id of the commodity carried
Name of the commodity group carried
Name of the commodity carried
The direction of the vessel
Indicating the speed of vessel
Database identifier of the last port visited (regardless of what operation happened in the port)
Name of the last port visited (regardless of what operation happened in the port)
Database identifier of the last port where load or discharge operation occurred
Name of the last port where load or discharge operation occurred
The estimated amount of volume onboard the vessel
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.