Regions

Retrieve list of regions

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

The Regions returns a list regions.

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

Example

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

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

Arguments

None

Response

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

regions

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

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

region_id

Type:: str

region_name

Type:: str