Ports¶

Retrieve list of ports

class oceanbolt.sdk.data.entities.Ports(client: oceanbolt.sdk.client.APIClient)[source]¶

The Ports returns a list ports.

get()[source]¶: Retrieves list of ports as a pandas.DataFrame

Example¶

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

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

Arguments¶

None

Response¶

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

List Ports

ports¶

Type: Sequence[oceanbolt.com.entities_v3.types.Port]

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

port_id¶

Type: int

port_name¶

Type: str

country_code¶

Type: str

region¶

Type: str

unlocode¶

Type: str

unlocode_alias¶

Type: Sequence[str]

port_name_alias¶

Type: Sequence[str]