Fleet Speed

Find aggregated average fleet speed for various vessels segments, various laden status, various directions or various zones.

Example questions that can be answered with this endpoint:

  • How many ballast ultramax or supramax vessels are currently in the Indian Ocean?

  • How many panamaxes are currently in the atlantic vs the pacific and how has this changed over time?

class oceanbolt.sdk.data.tonnage.FleetSpeedTimeseries(client: oceanbolt.sdk.client.APIClient)[source]

The FleetSpeedTimeseries returns timeseries on fleet speed.

get(**kwargs)[source]

Retrieves timeseries data as a pandas.DataFrame

Example

What is the average speed of all ballast panamaxes and capesizes currently in the Indian Ocean?

from oceanbolt.sdk.client import APIClient
from oceanbolt.sdk.data.tonnage import FleetSpeedTimeseries
from datetime import date


base_client = APIClient("<token>")
df = FleetSpeedTimeseries(base_client).get(
    segment=['panamax','capesize'],
    laden_status=["ballast"],
    zone_id=[22, 13, 97, 96, 8], #Zone Ids can be obtained from the zone selector map in the Oceanbolt App or from the entities/zones endpoint.

)

Returns:

date

avg_speed

2021-02-01

11.820454597473145

2021-02-02

11.539999961853027

2021-02-03

11.881817817687988

2021-02-04

11.872941017150879

2021-02-05

11.676087379455566

2021-02-06

11.892473220825195

2021-02-07

11.985262870788574

2021-02-08

11.77934741973877

2021-02-09

11.592308044433594

2021-02-10

12.045000076293945

2021-02-11

11.79594612121582

2021-02-12

11.716666221618652

2021-02-13

11.979220390319824

2021-02-14

12.097015380859375

2021-02-15

11.929333686828613

2021-02-16

11.353408813476562

2021-02-17

11.669511795043945

2021-02-18

11.818181991577148

2021-02-19

11.818181991577148

Arguments

class oceanbolt.com.tonnage_v3.types.GetTonnageDataRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Request object for getting tonnage zone data and fleet speed data.

zone_id

List of zones ids to filter on. Allowed values can be obtained from the /entities/zones endpoint.

Type

Sequence[int]

segment

List of vessel segments to filter on. Allowed values can be obtained from the /entities/segments endpoint. Cannot be supplied alongside subSegment.

Type

Sequence[str]

sub_segment

List of vessel sub segments to filter on. Allowed values can be obtained from the /entities/segments endpoint. Cannot be supplied alongside segment.

Type

Sequence[str]

direction

The list of directions to get tonnage data for. The following directions are allowed: [“NNE”,”ENE”,”ESE”,”SSE”,”SSW”,”WSW”,”WNW”,”NNW”]. Directions can also be obtained from the interactive direction selector found at app.oceanbolt.com.

Type

Sequence[str]

laden_status

The laden status to get tonnage data for. The following values are allowed: [“laden”,”ballast”].

Type

Sequence[str]

port_status

The port status to get tonnage data for. The following values are allowed: [“in_port”,”at_sea”].

Type

Sequence[str]

group_by

Not Implemented Yet //TODO

Type

str

exclude_mpv

Flag to specify whether or not MPV vessels should be included/excluded. Default is to include.

Type

bool

start_date

The UTC start date of the date filter.

Type

str

end_date

The UTC end date of the date filter.

Type

str

last_n_days

Short hand parameter for quickly getting data for the last N days.

Type

int

format_

The return format of the data [“csv”,”json”, “xlsx”]. Default is “json”.

Type

str

sort

Specifies whether results should be sorted in ascending or descing order. Allowed values: [“asc”,”desc”].

Type

str

Response

class oceanbolt.com.tonnage_v3.types.GetFleetSpeedResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Response object for FleetSpeed

timeseries

Timeseries data groups.

Type

Sequence[oceanbolt.com.tonnage_v3.types.TonnageTimeseriesGroup]

csv

Link to download csv file, if format was specified to be “csv”.

Type

str

xlsx

Link to download excel file, if format was specified to be “xlsx”.

Type

str

class oceanbolt.com.tonnage_v3.types.TonnageTimeseriesGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Tonnage zone/fleet speed timeseries group

group

Name of the group. This will be “default”, if no grouping was specified in the query.

Type

str

rows

Rows of timeseries data.

Type

Sequence[oceanbolt.com.tonnage_v3.types.TonnageTimeseriesRow]

class oceanbolt.com.tonnage_v3.types.TonnageTimeseriesRow(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Tonnage zone/fleet speed timeseries row.

date

UTC date timestamp of the timeseries row.

Type

str

vessel_count

The number of vessels for the timeseries row.

Type

google.protobuf.wrappers_pb2.Int32Value

vessel_dwt

The sum of dwt for the timeseries row.

Type

google.protobuf.wrappers_pb2.DoubleValue

avg_speed

The average speed in knots for the timeseries row.

Type

google.protobuf.wrappers_pb2.DoubleValue