Package Documentation¶
Tonnage List API Package.
Area
dataclass
¶
A geographical area.
Attributes:
Name | Type | Description |
---|---|---|
id |
int
|
The area's id. |
name |
str
|
The area's name. |
location_taxonomy |
str
|
The area's location taxonomy. See the
|
taxonomy_id |
int
|
Location taxonomy id |
Source code in signal_ocean/tonnage_list/models.py
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
|
Column
¶
Contains constants for data frame column names.
Source code in signal_ocean/tonnage_list/data_frame.py
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 |
|
AVAILABILITY_DATE_TYPE = _category(_pit_col('availability_date_type'))
class-attribute
instance-attribute
¶
Prediction source of the vessel's open date at the tonnage lists' point
in time. See the SourceType
class for possible values.
AVAILABILITY_PORT_TYPE = _category(_pit_col('availability_port_type'))
class-attribute
instance-attribute
¶
Prediction source of the vessel's open port at the tonnage lists' point
in time. See the SourceType
class for possible values.
BREADTH_EXTREME = 'breadth_extreme'
class-attribute
instance-attribute
¶
The vessel's breadth extreme.
COMMERCIAL_OPERATOR = _category(_pit_col('commercial_operator'))
class-attribute
instance-attribute
¶
The vessel's commercial operator at the tonnage lists' point in time.
COMMERCIAL_OPERATOR_ID = _category(_pit_col('commercial_operator_id'))
class-attribute
instance-attribute
¶
The vessel's commercial operator id at the tonnage lists' point in time.
COMMERCIAL_STATUS = _category(_pit_col('commercial_status'))
class-attribute
instance-attribute
¶
Commercial status of the vessel at the tonnage lists' point in time. See
the CommercialStatus
class for available values.
CURRENT_VESSEL_SUB_TYPE = _category(_pit_col('current_vessel_sub_type'))
class-attribute
instance-attribute
¶
One of: -1: Unknown, 1: Dirty, 2: Clean
CURRENT_VESSEL_SUB_TYPE_ID = _category(_pit_col('current_vessel_sub_type_id'))
class-attribute
instance-attribute
¶
Current vessel sub type Id
DEADWEIGHT = 'deadweight'
class-attribute
instance-attribute
¶
The vessel's deadweight.
ETA = _pit_col('eta')
class-attribute
instance-attribute
¶
Estimated time of arrival at the tonnage lists' point in time.
FIXTURE_TYPE = _category(_pit_col('fixture_type'))
class-attribute
instance-attribute
¶
Fixture type. One of Scraped, Manual, Implied
ICE_CLASS = _category('ice_class')
class-attribute
instance-attribute
¶
The vessel's ice class.
LATEST_AIS = _pit_col('latest_ais')
class-attribute
instance-attribute
¶
Timestamp of the vessel's latest AIS information at the tonnage lists' point in time.
LENGTH_OVERALL = 'length_overall'
class-attribute
instance-attribute
¶
The vessel's length overall.
MARKET_DEPLOYMENT = _category(_pit_col('market_deployment'))
class-attribute
instance-attribute
¶
Market deployment of the vessel at the tonnage lists' point in time. See
the MarketDeployment
class for available values.
NAME = 'name'
class-attribute
instance-attribute
¶
The vessel's name.
OPEN_COUNTRY = _category(_pit_col('open_country'))
class-attribute
instance-attribute
¶
The country at which the vessel opens.
OPEN_DATE = _pit_col('open_date')
class-attribute
instance-attribute
¶
The vessel's open date at the tonnage lists' point in time.
OPEN_NARROW_AREA = _category(_pit_col('open_narrow_area'))
class-attribute
instance-attribute
¶
The narrow geographical area at which the vessel opens.
OPEN_PORT = _category(_pit_col('open_port'))
class-attribute
instance-attribute
¶
The vessel's open port name at the tonnage lists' point in time.
OPEN_PORT_ID = _category(_pit_col('open_port_id'))
class-attribute
instance-attribute
¶
The vessel's open port id at the tonnage lists' point in time.
OPEN_PREDICTION_ACCURACY = _category(_pit_col('open_prediction_accuracy'))
class-attribute
instance-attribute
¶
How accurate, in terms of location taxonomy, is the vessel's open
prediction at the tonnage lists' point in time. See the LocationTaxonomy
class for available values.
OPEN_WIDE_AREA = _category(_pit_col('open_wide_area'))
class-attribute
instance-attribute
¶
The wide geographical area at which the vessel opens.
OPERATIONAL_STATUS = _category(_pit_col('operational_status'))
class-attribute
instance-attribute
¶
Operational status of the vessel at the tonnage lists' point in time.
See the OperationalStatus
class for available values.
PUSH_TYPE = _category(_pit_col('push_type'))
class-attribute
instance-attribute
¶
Push type of the vessel at the tonnage lists' point in time. See the
PushType
class for available values.
SUBCLASS = _category('subclass')
class-attribute
instance-attribute
¶
The vessel's subclass. See the VesselSubclass
class for available
values.
VESSEL_CLASS = _category('vessel_class')
class-attribute
instance-attribute
¶
Name of the vessel class the vessel is categorized as.
WILLING_TO_SWITCH_CURRENT_VESSEL_SUB_TYPE = _pit_col('willing_to_switch_current_vessel_sub_type')
class-attribute
instance-attribute
¶
If the vessel is willing to compete on a different vessel subclass category or not
YEAR_BUILT = 'year_built'
class-attribute
instance-attribute
¶
The year the vessel has been built.
CommercialStatus
¶
Contains constants for available commercial statuses.
Source code in signal_ocean/tonnage_list/models.py
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 |
|
AVAILABLE = 'Available'
class-attribute
instance-attribute
¶
The vessel is available for a new voyage after its open date.
CANCELLED = 'Cancelled'
class-attribute
instance-attribute
¶
The last fixture has been cancelled for this vessel.
FAILED = 'Failed'
class-attribute
instance-attribute
¶
The last fixture failed for this vessel.
ON_SUBS = 'On Subs'
class-attribute
instance-attribute
¶
The vessel is "on subs" for a new fixture.
POTENTIALLY_FIXED = 'Poss Fixed'
class-attribute
instance-attribute
¶
The vessel is assumed to be fixed for a new voyage based on available AIS information.
DateRange
¶
A range of dates between a start and end date.
Source code in signal_ocean/tonnage_list/models.py
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 |
|
__init__(start, end)
¶
Creates the date range.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
start |
Optional[date]
|
The start date of the range (inclusive). |
required |
end |
Optional[date]
|
The end date of the range (inclusive). |
required |
Source code in signal_ocean/tonnage_list/models.py
561 562 563 564 565 566 567 568 569 570 571 572 |
|
FixtureType
¶
Contains constants for available fixture types.
Source code in signal_ocean/tonnage_list/models.py
545 546 547 548 549 550 551 552 553 554 555 |
|
HistoricalTonnageList
¶
Bases: Sequence[TonnageList]
A historical tonnage list.
A historical tonnage list consists of a collection of tonnage lists, one for every day between the start and end date specified when querying the Historical Tonnage List API.
Source code in signal_ocean/tonnage_list/models.py
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 |
|
__init__(tonnage_lists)
¶
Initializes the HistoricalTonnageList
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
tonnage_lists |
Iterable[TonnageList]
|
Tonnage lists per each day in the historical date range. |
required |
Source code in signal_ocean/tonnage_list/models.py
699 700 701 702 703 704 705 706 |
|
to_data_frame()
¶
Converts the Historical Tonnage List to a pandas data frame.
Source code in signal_ocean/tonnage_list/models.py
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 |
|
IndexLevel
¶
Contains constants for available data frame index levels.
Source code in signal_ocean/tonnage_list/data_frame.py
229 230 231 232 233 234 235 236 |
|
LocationTaxonomy
¶
Contains constants for available location taxonomies.
Source code in signal_ocean/tonnage_list/models.py
27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
|
COUNTRY = 'Country'
class-attribute
instance-attribute
¶
A country.
NARROW_AREA = 'Narrow Area'
class-attribute
instance-attribute
¶
A narrow geographical Area.
PORT = 'Port'
class-attribute
instance-attribute
¶
A port.
WIDE_AREA = 'Wide Area'
class-attribute
instance-attribute
¶
A wide geographical area.
MarketDeployment
¶
Available market deployments.
Source code in signal_ocean/tonnage_list/models.py
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 |
|
CONTRACT = 'Contract'
class-attribute
instance-attribute
¶
Vessels controlled by commercial operators that do not participate in the spot market and are typically carrying system cargoes with repetitive trading patterns.
PROGRAM = 'Program'
class-attribute
instance-attribute
¶
Vessels that are controlled by charterers that do not participate in the spot market and are either not advertised through tonnage lists or tonnage lists report the fact that they participate in the program market.
RELET = 'Relet'
class-attribute
instance-attribute
¶
Vessels controlled by charterers that participate in the spot market and are advertised through tonnage lists and reported fixtures.
SPOT = 'Spot'
class-attribute
instance-attribute
¶
Vessels controlled by commercial operators that participate in the spot market and are advertised through tonnage lists and reported fixtures.
OperationalStatus
¶
Contains constants for available operational statuses.
Source code in signal_ocean/tonnage_list/models.py
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 |
|
ACTIVE_STORAGE = 'Active Storage'
class-attribute
instance-attribute
¶
The vessel is in active storage.
This means the vessel acts as short-term storage (in comparison to storage vessels).
BALLAST_FIXED = 'Ballast Fixed'
class-attribute
instance-attribute
¶
The vessel is currently without cargo but fixed.
BALLAST_FIXED_IMPLIED = 'Ballast Fixed (implied)'
class-attribute
instance-attribute
¶
The vessel is currently without cargo and its AIS destination implies that it's fixed.
BALLAST_UNFIXED = 'Ballast Unfixed'
class-attribute
instance-attribute
¶
The vessel is currently without cargo and is not fixed (is prompt).
DISCHARGING = 'Discharging'
class-attribute
instance-attribute
¶
The vessel is discharging.
This means the vessel has entered a jetty or is performing a ship-to-ship operation.
LADEN = 'Laden'
class-attribute
instance-attribute
¶
The vesel has loaded.
LOADING = 'Loading'
class-attribute
instance-attribute
¶
The vessel is loading.
This means the vessel has entered a jetty or is performing a ship-to-ship operation.
REPAIRS = 'Repairs'
class-attribute
instance-attribute
¶
The vessel is undergoing repairs or is in dry dock.
WAITING_TO_DISCHARGE = 'Waiting to Discharge'
class-attribute
instance-attribute
¶
The vessel is waiting to Discharge.
WAITING_TO_LOAD = 'Waiting to Load'
class-attribute
instance-attribute
¶
The vessel is waiting to load.
Port
dataclass
¶
A maritime facility where vessels can dock.
Attributes:
Name | Type | Description |
---|---|---|
id |
int
|
The ID of the port. |
name |
str
|
The name of the port. |
Source code in signal_ocean/tonnage_list/models.py
309 310 311 312 313 314 315 316 317 318 319 |
|
PortFilter
dataclass
¶
A filter used to find specific ports.
Attributes:
Name | Type | Description |
---|---|---|
name_like |
Optional[str]
|
Used to find ports by name. When specified, ports whose names partially match (contain) the attribute's value will be returned. Matching is case-insensitive. |
Source code in signal_ocean/tonnage_list/models.py
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 |
|
PushType
¶
Available push types.
Source code in signal_ocean/tonnage_list/models.py
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 |
|
NOT_PUSHED = 'Not Pushed'
class-attribute
instance-attribute
¶
Vessels that are not pushed anymore.
PUSHED = 'Pushed'
class-attribute
instance-attribute
¶
Vessels actively pushed in the market through tonnage or position lists.
PUSHED_POSS = 'Pushed POSS'
class-attribute
instance-attribute
¶
Vessels actively pushed in the market with notification "Poss".
"Poss" stands for "Possibly", meaning that vessels marked with this type are a broker projection.
SourceType
¶
Contains constants for available prediction source types.
Source code in signal_ocean/tonnage_list/models.py
299 300 301 302 303 304 305 306 |
|
TonnageList
¶
Bases: Sequence[Vessel]
A tonnage list as it occurred at a certain point in time.
Attributes:
Name | Type | Description |
---|---|---|
vessels |
Vessels present in the tonnage list at the time it was
captured. For more details see the |
|
date |
The date and time at which the tonnage list was captured. |
Source code in signal_ocean/tonnage_list/models.py
642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 |
|
__init__(vessels, date)
¶
Initializes the tonnage list.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
vessels |
Iterable[Vessel]
|
Vessels present in the tonnage list at the time it was
captured. For more details see the |
required |
date |
datetime
|
The date and time at which the tonnage list was captured. |
required |
Source code in signal_ocean/tonnage_list/models.py
651 652 653 654 655 656 657 658 659 660 |
|
to_data_frame()
¶
Converts the tonnage list to a pandas data frame.
Source code in signal_ocean/tonnage_list/models.py
682 683 684 685 686 687 688 |
|
TonnageListAPI
¶
Handles communication with Signal's Tonnage List API.
Source code in signal_ocean/tonnage_list/api.py
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 |
|
__init__(connection=None)
¶
Initializes TonnageListAPI
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
connection |
Optional[Connection]
|
API connection configuration. If not provided, the default connection method is used. |
None
|
Source code in signal_ocean/tonnage_list/api.py
25 26 27 28 29 30 31 32 |
|
get_historical_tonnage_list(loading_port, vessel_class, laycan_end_in_days=None, date_range=None, vessel_filter=None)
¶
Retrieves a historical tonnage list.
If no input dates are provided, the last 10 days will be fetched (including today).
To get a tonnage list for a specific day, set both date parameters to the desired date.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
loading_port |
Port
|
A loading port from which ETA will be calculated. |
required |
vessel_class |
VesselClass
|
The vessel class of vessels in the tonnage list. |
required |
laycan_end_in_days |
Optional[int]
|
The maximum ETA expressed as a number of days after the end date. |
None
|
date_range |
Optional[DateRange]
|
A range of dates for which to get historical tonnage lists. |
None
|
vessel_filter |
Optional[VesselFilter]
|
A filter defining which vessels should be included
in the response. See |
None
|
Returns:
Type | Description |
---|---|
HistoricalTonnageList
|
Given a time-range, returns a |
HistoricalTonnageList
|
|
Source code in signal_ocean/tonnage_list/api.py
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
|
get_ports(port_filter=None)
¶
Retrieves available ports.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
port_filter |
Optional[PortFilter]
|
A filter used to find specific ports. If not specified, returns all available ports. |
None
|
Returns:
Type | Description |
---|---|
Tuple[Port, ...]
|
A tuple of available ports that match the filter. |
Source code in signal_ocean/tonnage_list/api.py
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
|
get_tonnage_list(loading_port, vessel_class, laycan_end_in_days=None, vessel_filter=None)
¶
Retrieves a tonnage list.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
loading_port |
Port
|
A loading port from which ETA will be calculated. |
required |
vessel_class |
VesselClass
|
The vessel class of vessels in the tonnage list. |
required |
laycan_end_in_days |
Optional[int]
|
The maximum ETA expressed as a number of days from now. |
None
|
vessel_filter |
Optional[VesselFilter]
|
A filter defining which vessels should be included
in the response. See the |
None
|
Returns:
Type | Description |
---|---|
TonnageList
|
Returns a |
TonnageList
|
criteria. |
Source code in signal_ocean/tonnage_list/api.py
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
|
get_vessel_classes(class_filter=None)
¶
Retrieves available vessel classes.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
class_filter |
Optional[VesselClassFilter]
|
A filter used to find specific vessel classes. If not specified, returns all available vessel classes. |
None
|
Returns:
Type | Description |
---|---|
Tuple[VesselClass, ...]
|
A tuple of available vessel classes that match the filter. |
Source code in signal_ocean/tonnage_list/api.py
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 |
|
Vessel
dataclass
¶
Holds information for a vessel that's present in a TonnageList
.
Contains both static and point-in-time vessel data. When converted to a
data frame, all point-in-time data is suffixed with _point_in_time
. See
the Column
class for the available data frame column names.
Attributes:
Name | Type | Description |
---|---|---|
imo |
int
|
The vessel's IMO number. |
name |
str
|
The vessel's name. |
vessel_class |
str
|
Name of the vessel class the vessel is categorized as. |
ice_class |
Optional[str]
|
The vessel's ice class. |
year_built |
int
|
The year the vessel has been built. |
deadweight |
int
|
The vessel's deadweight. |
length_overall |
float
|
The vessel's length overall. |
breadth_extreme |
int
|
The vessel's breadth extreme. |
market_deployment |
str
|
Market deployment of the vessel at the tonnage
lists' point in time. See the |
push_type |
str
|
Push type of the vessel at the tonnage lists' point in time.
See the |
open_port_id |
int
|
The vessel's open port id at the tonnage lists' point in time. |
open_port |
str
|
The vessel's open port name at the tonnage lists' point in time. |
open_date |
Optional[datetime]
|
The vessel's open date at the tonnage lists' point in time. |
operational_status |
str
|
Operational status of the vessel at the tonnage
lists' point in time. See the |
commercial_operator_id |
int
|
The vessel's commercial operator id at the tonnage lists' point in time. |
commercial_operator |
str
|
The vessel's commercial operator at the tonnage lists' point in time. |
commercial_status |
str
|
Commercial status of the vessel at the tonnage
lists' point in time. See the |
eta |
Optional[datetime]
|
Estimated time of arrival at the tonnage lists' point in time. |
latest_ais |
Optional[datetime]
|
Timestamp of the vessel's latest AIS information at the tonnage lists' point in time. |
subclass |
str
|
The vessel's subclass. See the |
willing_to_switch_subclass |
bool
|
When |
open_prediction_accuracy |
str
|
How accurate, in terms of location taxonomy,
is the vessel's open prediction at the tonnage lists' point in
time. See the |
open_areas |
Tuple[Area, ...]
|
A hierarchical collection of areas the vessel opens at at the tonnage lists' point in time. If a vessel opens at a specific port, this attribute will contain areas containing the port. For example, the continent, wide/narrow areas, country, etc. |
availability_port_type |
str
|
Prediction source of the vessel's open port at
the tonnage lists' point in time. See the |
availability_date_type |
str
|
Prediction source of the vessel's open date at
the tonnage lists' point in time. See the |
fixture_type |
str
|
Fixture type. One of Scraped, Manual, Implied |
current_vessel_sub_type_id |
int
|
Current vessel sub type Id |
current_vessel_sub_type |
str
|
One of: -1: Unknown, 1: Dirty, 2: Clean |
willing_to_switch_current_vessel_sub_type |
bool
|
bool nullable. If the vessel is willing to compete on a different vessel subclass category or not. |
Source code in signal_ocean/tonnage_list/models.py
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 |
|
open_country: Optional[str]
property
¶
The vessel's open country name.
Returns:
Type | Description |
---|---|
Optional[str]
|
The name of the open country or |
Optional[str]
|
|
open_narrow_area: Optional[str]
property
¶
The vessel's narrow open area name.
Returns:
Type | Description |
---|---|
Optional[str]
|
The name of the narrow open area or |
Optional[str]
|
|
open_wide_area: Optional[str]
property
¶
The vessel's wide open area name.
Returns:
Type | Description |
---|---|
Optional[str]
|
The name of the wide open area or |
Optional[str]
|
|
VesselClass
dataclass
¶
A group of vessels of similar characteristics, i.e. Aframax, Panamax, etc.
Attributes:
Name | Type | Description |
---|---|---|
id |
int
|
The vessel class ID. |
name |
str
|
The vessel class name. |
Source code in signal_ocean/tonnage_list/models.py
322 323 324 325 326 327 328 329 330 331 332 |
|
VesselClassFilter
dataclass
¶
A filter used to find specific vessel classes.
Attributes:
Name | Type | Description |
---|---|---|
name_like |
Optional[str]
|
Used to find vessel classes by name. When specified, vessel classes whose names partially match (contain) the attribute's value will be returned. Matching is case-insensitive. |
Source code in signal_ocean/tonnage_list/models.py
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 |
|
VesselFilter
dataclass
¶
Used to filter vessels when retrieving tonnage lists.
All attributes in this class are optional, i.e. no filtering will be performed on attributes whose value is None.
Attributes that accept a list of values are used to perform an OR comparison. In other words, when a non-empty list of values is used, the tonnage lists will contain vessels that match on any of the specified values. Using an empty list will result in no filtering being performed.
VesselFilter
is mutable in order to allow making adjustments to existing
instances if query results are unsatisfactory.
Attributes:
Name | Type | Description |
---|---|---|
push_types |
Optional[List[str]]
|
Return vessels with the specified push types. Use constants
defined in the |
market_deployments |
Optional[List[str]]
|
Return vessels with the specified market deployment
types. Use constants defined in the |
commercial_statuses |
Optional[List[str]]
|
Return vessels with the specified
commercial statuses. Use constants defined in the
|
vessel_subclass |
Optional[str]
|
Return vessels of the specified subclass.
Use constants defined in the |
add_willing_to_switch_subclass |
Optional[bool]
|
When True, returns vessels that do not match the subclass but are willing to switch to it. |
latest_ais_since |
Optional[int]
|
The maximum age, in days, of the vessel's AIS information at the time the tonnage list was captured. |
operational_statuses |
Optional[List[str]]
|
Return vessels with the specified
operational statuses. Use constants defined in the
|
min_liquid_capacity |
Optional[int]
|
The minimum liquid capacity, in cubic meters, the vessel should be able to hold. |
max_liquid_capacity |
Optional[int]
|
The maximum liquid capacity, in cubic meters, the vessel should be able to hold. |
fixture_types |
Optional[List[str]]
|
Return vessels with the specified
fixture types. Use constants defined in the |
last_cargo_types |
Optional[List[str]]
|
Return vessels with the specified last cargo type IDs. |
past_port_visits |
Optional[List[int]]
|
Return vessels with the specified past port visits. |
open_port_ids |
Optional[List[int]]
|
Return vessels with the specified open port ids. |
canakkale_cancelling |
Optional[date]
|
Return vessels with the specified Canakkale cancelling date. |
open_date |
Optional[date]
|
Return vessels with the specified open date. |
ice_classes |
Optional[List[str]]
|
Return vessels with the specified ice classes. |
min_cranes_ton_capacity |
Optional[int]
|
Return vessels with the specified minimum cranes ton capacity. |
max_cranes_ton_capacity |
Optional[int]
|
Return vessels with the specified maximum cranes ton capacity. |
min_length_overall |
Optional[int]
|
Return vessels with the specified minimum length overall. |
max_length_overall |
Optional[int]
|
Return vessels with the specified maximum length overall. |
min_breadth_extreme |
Optional[int]
|
Return vessels with the specified minimum breadth extreme. |
max_breadth_extreme |
Optional[int]
|
Return vessels with the specified maximum breadth extreme. |
openAreas |
Optional[int]
|
Return vessels with the specified open area ids. |
openCountries |
Optional[int]
|
Return vessels with the specified open country ids. |
Source code in signal_ocean/tonnage_list/models.py
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 |
|
VesselSubclass
¶
Available vessel subclasses.
Source code in signal_ocean/tonnage_list/models.py
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 |
|
ALL = None
class-attribute
instance-attribute
¶
All vessel subclasses.
Refers to all vessels without any classification regarding the cargo type they car carry.
CLEAN = 'Clean'
class-attribute
instance-attribute
¶
Vessels carrying clean oil.
Refers to all vessels that classify as carriers of clean types of oil. Applies only to tankers.
DIRTY = 'Dirty'
class-attribute
instance-attribute
¶
Vessels carrying dirty types of oil.
Refers to all vessels that classify as carriers of dirty types of oil. Applies only to tankers.