Searching for Vessels/Polygons

Allows for searching for vessels/polygons in the Oceanbolt Data Platform.

class oceanbolt.sdk.data.entities.Search(client: APIClient)[source]

The Search instance allows for searching polygons and vessels.

search_polygons(q)[source]

Searches for polygons (ports/terminals) in the Oceanbolt Database

Parameters:: q (str) – The search query

search_vessels(q)[source]

Searches for vessels in the Oceanbolt Database

Parameters:: q (str) – The search query

Example

from oceanbolt.sdk.client import APIClient
from oceanbolt.sdk.data.entities import Search

base_client = APIClient("<token>")
vessels_result = Search(base_client).search_vessels("tenacity")

base_client = APIClient("<token>")
vessels_result = Search(base_client).search_vessels("tenacity")

Arguments

class oceanbolt.sdk.data.entities.Search.search_vessels

Searches for vessels in the Oceanbolt Database

Parameters:: q (str) – The search query

class oceanbolt.sdk.data.entities.Search.search_polygons

Searches for polygons (ports/terminals) in the Oceanbolt Database

Parameters:: q (str) – The search query

Response

Vessels search:

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

imo

Type:: int

highlevel_type

Type:: str

segment

Type:: str

sub_segment

Type:: str

dwt

Type:: float

max_draught

Type:: float

name

Type:: str

ex_name

Type:: str

built

Type:: int

type_

Type:: str

mpv

Type:: bool

loa

Type:: float

beam

Type:: float

holds_total

Type:: float

Polygons search:

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

berth_id

Type:: int

port_id

Type:: int

port_name

Type:: str

berth_name

Type:: str

country_code

Type:: str

unlocode

Type:: str

entity_type

Type:: str

alias

string geom_point = 8; double mbc_radius = 9;

Type:: str