List Vessels

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

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

Which vessels have loaded bauxite in Guinea in the past month?

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


base_client = APIClient("<token>")
df = VesselStates(base_client).get(
    imo=[9586801],
    start_date=da
)

Returns:

Arguments

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

Vessels

dwt

min,max on the dwt columns

Type: Sequence[float]

eta

before,after on the eta columns

Type: Sequence[str]

segment

included segments

Type: Sequence[str]

sub_segment

included sub segments

Type: Sequence[str]

load_region

included load regions

Type: Sequence[str]

load_country

included load countries

Type: Sequence[str]

load_port

included load ports

Type: Sequence[str]

destination_region

included discharge regions

Type: Sequence[str]

destination_country

included discharge countries

Type: Sequence[str]

destination_port

included discharge ports

Type: Sequence[str]

destination_unlocode

included discharge ports

Type: Sequence[str]

cargo_status

included cargo states

Type: Sequence[str]

laden_status

included laden states

Type: Sequence[str]

laden_status_draught

included laden states

Type: Sequence[str]

speed

min,max on the speed column

Type: Sequence[float]

draught

min,max on the draught column

Type: Sequence[float]

exclude_unknown_destination

include rows where destination_country is blank

Type: bool

group

group by filter parameter

Type: str

range_

range value for timeseries request (ex: month/monthly, week/weekly)

Type: str

flow_date

flow date (of load/discharge) for timeseries request

Type: str

commodity

included commodity values

Type: Sequence[str]

commodity_group

included commodity values

Type: Sequence[str]

zone_id

included zone ids

Type: Sequence[int]

port_id

included port ids

Type: Sequence[int]

anchorage_id

included anchorage ids

Type: Sequence[int]

berth_id

included berth ids

Type: Sequence[int]

shipyard_id

included shipyard ids

Type: Sequence[int]

direction

included diretions

Type: Sequence[str]

imo

included diretions

Type: Sequence[int]

port_status

Type: Sequence[str]

exclude_mpv

Type: bool

limit

Type: int

hours_since_last

parameter for aisquality request

Type: int

format_

response format (default is json, supported csv)

Type: str

Response

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

vessels

Type: Sequence[oceanbolt.com.vessels_v3.types.Vessel]

csv

Type: str

xlsx

Type: str

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

Entities

vessel_name

Type: str

imo

Type: int

mmsi

Type: int

last_position_received

Type: str

last_static_received

Type: str

dwt

Type: float

segment

Type: str

sub_segment

Type: str

zone_id

Type: int

zone_name

Type: str

port_id

Type: int

port_name

Type: str

anchorage_id

Type: int

anchorage_name

Type: str

berth_id

Type: int

berth_name

Type: str

shipyard_id

Type: int

shipyard_name

Type: str

related_port_id

Type: int

related_port_name

Type: str

cargo_status

Type: str

laden_status

Type: str

laden_status_draught

Type: str

destination

Type: str

destination_port_name

Type: str

destination_region

Type: str

destination_country_code

Type: str

eta

Type: str

navigational_status

Type: int

last_port_name

Type: str

last_country_code

Type: str

last_region

Type: str

port_call_status

Type: str

commodity_group

Type: str

commodity_name

Type: str

direction

Type: str

speed

Type: float