Segments

Retrieve list of vessel segments

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

The Segments returns a list segments.

get()[source]: Retrieves list of segments as a pandas.DataFrame

Example

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

base_client = APIClient("<token>")
df = Segments(base_client).get()

Arguments

None

Response

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

segments

Type:: MutableSequence[oceanbolt.com.entities_v3.types.Segment]

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

segment

Type:: str

segment_key

Type:: str

sub_segment

Type:: str

segment_int

Type:: int

sub_segment_int

Type:: int

sub_segment_key

Type:: str

cutoff_low_dwt

Type:: float

cutoff_high_dwt

Type:: float

cutoff_low_cbm

Type:: float

cutoff_high_cbm

Type:: float

platform

Type:: str

highlevel_type

Type:: str