Chinese Waters
Track how many Chinese flagged vessels that are currently trading in cabotage in coastal waters vs how many Chinese flagged vessels are currently trading in international waters.
Example questions that can be answered with this endpoint:
How many Chinese flagged Panamax vessels are currently trading outside of China?
Whats the percentage of the Chinese flagged fleet that is currently trading internationally and how has this changed over time?
- class oceanbolt.sdk.data.tonnage.ChineseWatersTimeseries(client: APIClient)[source]
The
ChineseWatersTimeseries
returns timeseries on how many Chinese flagged vessels are trading inside/outside China respectively.
Example
How many ballast ultramax or supramax vessels are currently in the Indian Ocean?
from oceanbolt.sdk.client import APIClient
from oceanbolt.sdk.data.tonnage import ChineseWatersTimeseries
from datetime import date
base_client = APIClient("<token>")
df = ChineseWatersTimeseries(base_client).get(
sub_segment=['ultramax','supramax'],
group_by="segment",
)
Returns:
group |
date |
inside_chinese_waters_count |
inside_chinese_waters_dwt |
outside_chinese_waters_count |
outside_chinese_waters_dwt |
---|---|---|---|---|---|
Supramax |
2017-01-01 |
126 |
6690636.0 |
65 |
3411383.0 |
Supramax |
2017-01-02 |
129 |
6841846.0 |
62 |
3260173.0 |
Supramax |
2017-01-03 |
125 |
6621076.0 |
66 |
3480943.0 |
Supramax |
2017-01-04 |
125 |
6621076.0 |
66 |
3480943.0 |
Supramax |
2017-01-05 |
125 |
6630355.0 |
66 |
3471664.0 |
Supramax |
2017-01-06 |
125 |
6630153.0 |
66 |
3471866.0 |
Supramax |
2017-01-07 |
126 |
6690125.0 |
65 |
3411894.0 |
Supramax |
2017-01-08 |
125 |
6628425.0 |
66 |
3473594.0 |
Supramax |
2017-01-09 |
125 |
6619114.0 |
66 |
3482905.0 |
Arguments
- class oceanbolt.com.tonnage_v3.types.TonnageChineseWatersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]
Request object for TonnageChineseWaters
- start_date
The UTC start date of the date filter.
- Type:
- end_date
The UTC end date of the date filter.
- Type:
- segment
List of vessel segments to filter on. Allowed values can be obtained from the /entities/segments endpoint. Cannot be supplied alongside subSegment.
- Type:
MutableSequence[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:
MutableSequence[str]
- group_by
Determines the grouping of the timeseries data.
- Type:
- sort
Specifies whether results should be sorted in ascending or descing order. Allowed values: [“asc”,”desc”].
- Type:
- format_
The return format of the data [“csv”,”json”, “xlsx”]. Default is “json”.
- Type:
Response
- class oceanbolt.com.tonnage_v3.types.TonnageChineseWatersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]
Response object for TonnageChineseWaters
- timeseries
Timeseries data groups.
- Type:
MutableSequence[oceanbolt.com.tonnage_v3.types.ChineseWatersTimeseriesGroup]
- class oceanbolt.com.tonnage_v3.types.ChineseWatersTimeseriesGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]
- group
Name of the group. This will be “default”, if no grouping was specified in the query.
- Type:
- rows
Rows of timeseries data.
- Type:
MutableSequence[oceanbolt.com.tonnage_v3.types.ChineseWatersTimeseriesRow]
- class oceanbolt.com.tonnage_v3.types.ChineseWatersTimeseriesRow(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]
- date
UTC date timestamp of the timeseries row.
- Type:
- inside_chinese_waters_count
Number of Chinese flagged vessels inside Chinese waters.
- inside_chinese_waters_dwt
Sum of DWT of Chinese flagged vessels inside Chinese waters.
- outside_chinese_waters_count
Number of Chinese flagged vessels outside Chinese waters.
- outside_chinese_waters_dwt
Sum of DWT of Chinese flagged vessels outside Chinese waters.