List Vessels

Retrieve list of vessels in the Oceanbolt DatabasePlatform while filering on various criteria.

Example questions that can be answered with this endpoint:

• Which vessels are currently carrying fertilizer?

• Which vessels are classified as supramaxes?

class oceanbolt.sdk.data.vessels.Vessels(client: APIClient)

The Vessels returns a list of vessels.

get(**kwargs)

Retrieves vessels 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.vessels import Vessels
from datetime import date,timedelta


base_client = APIClient("<token>")
df = Vessels(base_client).get(
    segment=['supramax'],
)

Returns:

vesselName	imo	lastPositionReceived	lastStaticReceived	dwt	segment	subSegment	zoneId	cargoStatus	ladenStatus	ladenStatusDraught	destination	destinationRegion	destinationCountryCode	eta	navigationalStatus	lastPortName	lastCountryCode	lastRegion	portCallStatus	commodityGroup	commodityName	direction	zoneName	portId	portName	berthId	berthName	relatedPortId	relatedPortName	speed	destinationPortName
ABDUL HAMID	9329837	2021-09-14T10:05:30Z	2021-08-16T07:34:12Z	56011	Supramax	Supramax (50-60k)	40	L	L	B	TG PEMANCINGAN	NWAFRICA	TG	2021-07-15T02:00:00Z	1	Muara Satui Loading Anchorage	ID	SEA	in_berth	Coal	Coal (unclassified)	SSE	South East Asia	1643	Muara Satui Loading Anchorage	2874	Muara Satui Coal Loading Anchorage	1643	Muara Satui Loading Anchorage
ABDULLAH	9132923	2021-09-14T13:56:47Z	2021-09-08T06:33:28Z	45653	Supramax	Handymax (43-50k)	22	D	L	L	CHATTOGRAM			2021-09-05T16:00:00Z	1	Chittagong	BD	ECINDIA	in_berth	Cement and Clinker	Cement	WSW	Bay of Bengal	154	Chittagong	15437	Chittagon Multibulk Loading Anchorage 1	154	Chittagong	0.1
ABDUL M	9144055	2021-09-14T09:41:16Z	2021-09-12T14:59:09Z	46570	Supramax	Handymax (43-50k)	9	B	B	B	BR SSZ	ECSA	BR	2021-09-24T12:00:00Z	2	Monrovia	LR	NWAFRICA	not_in_port			ENE	East Atlantic Ocean (Africa)							1.9	Santos
ABILITY	9908281	2021-09-14T13:40:00Z	2021-09-07T16:17:47Z	63800	Supramax	Ultramax (60-68k)	40	D	L	L	US LOG PH MNL	SEA	PH	2021-09-02T20:00:00Z	1	Manila	PH	SEA	in_berth	Grains	Wheat	WNW	South East Asia			15891	Manila Loading Anchorage	2030	Manila

Arguments

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

Vessels

dwt

min,max on the dwt columns

Type

MutableSequence[float]

eta

before,after on the eta columns

Type

MutableSequence[str]

segment

included segments

Type

MutableSequence[str]

sub_segment

included sub segments

Type

MutableSequence[str]

load_region

included load regions

Type

MutableSequence[str]

load_country

included load countries

Type

MutableSequence[str]

load_port

included load ports

Type

MutableSequence[str]

destination_region

included discharge regions

Type

MutableSequence[str]

destination_country

included discharge countries

Type

MutableSequence[str]

destination_port

included discharge ports

Type

MutableSequence[str]

destination_unlocode

included discharge port unlocodes

Type

MutableSequence[str]

cargo_status

included cargo states

Type

MutableSequence[str]

laden_status

included laden states

Type

MutableSequence[str]

laden_status_draught

included laden states

Type

MutableSequence[str]

speed

min,max on the speed column

Type

MutableSequence[float]

draught

min,max on the draught column

Type

MutableSequence[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

MutableSequence[str]

commodity_group

included commodity values

Type

MutableSequence[str]

zone_id

included zone ids

Type

MutableSequence[int]

port_id

included port ids

Type

MutableSequence[int]

anchorage_id

included anchorage ids

Type

MutableSequence[int]

berth_id

included berth ids

Type

MutableSequence[int]

shipyard_id

included shipyard ids

Type

MutableSequence[int]

direction

included diretions

Type

MutableSequence[str]

imo

included diretions

Type

MutableSequence[int]

port_status

Type

MutableSequence[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)

vessels

Type

MutableSequence[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)

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