Commodities

Retrieve list of commodities

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

The Commodities returns a list commodities.

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

Example

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

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

Returns:

tbd

Arguments

None

Response

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

commodities

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

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

commodity

Type:: str

commodity_id

Type:: int

commodity_value

Type:: str

commodity_group

Type:: str

platform

Type:: str