Supply¶
The Supply API tells you which vessels are available for a market segment, and how many. It has daily history since 2014 and a live view of today. You can filter on more than 150 fields: vessel class or size, open location and date, commercial status, voyage state, AIS position, custom ETAs to a port, and vessel particulars.
You need your own API key with access to the Supply API. Your subscription also sets the vessel classes that you can query. A request for a vessel class that your key cannot access fails with an error (HTTP 403).
Methods¶
| Method | Use it for | Dates |
|---|---|---|
get_supply_trend |
Vessel counts per day, for trends and charts | A start date and an end date |
get_historical_supply |
The list of vessels on one past day | One day |
get_live_supply |
The list of vessels now | Always now |
All three methods take the same filters (SupplyFilter), a Baltic route
template, or both. Each filter needs a vessel class (vessel_class), or a
size band (vessel_type, defining_size and size together).
Examples¶
Supply trend with filters¶
from datetime import date
from signal_ocean import Connection
from signal_ocean.supply import (
CommercialAvailabilityFilter,
FromToRange,
GeoLocation,
IncludeExcludeFilter,
LocationTaxonomy,
SupplyAPI,
SupplyFilter,
VesselClass,
)
api = SupplyAPI(Connection("YOUR_API_KEY"))
# Aframax tankers that open in Houston (port 3853) within 20 days,
# with commercial data updated in the last 5 days.
filters = SupplyFilter(
vessel_class=VesselClass.AFRAMAX,
commercial_availability=CommercialAvailabilityFilter(
open_location=IncludeExcludeFilter(
values=[GeoLocation(geo_id=3853, location_taxonomy=LocationTaxonomy.PORT)]
),
open_date_relative_offset=FromToRange(from_=-5, to=20),
latest_updated_date_relative_offset=FromToRange(from_=-5, to=0),
),
)
trend = api.get_supply_trend(date(2026, 10, 1), date(2026, 10, 31), filters=filters)
trend.to_data_frame() # index: date, column: supply
A Baltic route template with one change¶
from signal_ocean.supply import MinMaxRange, VesselParticularsFilter
# TD3C, but with vessels up to 20 years old instead of 15.
# All other TD3C filters stay as they are.
trend = api.get_supply_trend(
date(2026, 10, 1),
date(2026, 10, 31),
template="TD3C",
filters=SupplyFilter(
vessel_particulars=VesselParticularsFilter(vessel_age=MinMaxRange(max=20))
),
)
Live supply as a data frame¶
live = api.get_live_supply(template="TD25")
frame = live.to_data_frame() # one row per vessel
frame[["imo", "open_location", "open_date_to", "eta_TD25"]]
The Column class lists the column names. Each ETA configuration adds
columns named after its id, for example eta_TD25 and
eta_distance_TD25.
How filters and templates combine¶
- A filter field that you set replaces the template's value for that field
as a whole. All other template filters stay. For example,
vessel_age=MinMaxRange(min=5)replaces the template's age range, so the template's maximum age no longer applies. In the same way,open_location=IncludeExcludeFilter(values=[...])also removes the template's excluded locations. - A list that you set replaces the template's list. It is not added to it.
- Set a field to
Noneto remove that template filter.Nonechanges no other field. vessel_classreplaces the template's size band (vessel_type,defining_sizeandsize), and a size band replaces the template'svessel_class.- An absolute date range, for example
open_date, replaces the template's relative window for the same field.
Baltic route templates¶
Pass a route code as template. Codes are not case sensitive. Call
api.get_supply_templates() to get the full definition of each template.
| Code | Template |
|---|---|
| TD1 | VLCC US Gulf Supply 30 Days (TD1) |
| TD3C | VLCC Arabian Gulf Supply 18 Days (TD3C) |
| TD15 | VLCC West Africa Supply 20 Days (TD15) |
| TD23 | Suezmax US Gulf Supply 20 Days (TD23) |
| TD20 | Suezmax West Africa Supply 20 Days (TD20) |
| TD6 | Suezmax Black Sea Supply 20 Days (TD6) |
| TD25 | Aframax US Gulf Supply 10 Days (TD25) |
| TD19 | Aframax Mediterranean Supply 10 Days (TD19) |
| TD7 | Aframax Continent Supply 10 Days (TD7) |
| TD8 | Aframax Arabian Gulf Supply 15 Days (TD8) |
| TC14 | MR2 US Gulf Supply 7 Days (TC14) |
| TC2 | MR2 Continent Supply 10 Days (TC2) |
| TC12 | MR2 Far East Supply 10 Days (TC12) |
| TC6 | MR1 Mediterranean Supply 10 Days (TC6) |
| TC1 | LR2 Arabian Gulf Supply Next 30 Days |
| TC5 | LR1 Arabian Gulf Supply Next 30 Days |
| C3 | Capesize Brazil 40 days ballasters (C3) |
| C5 | Capesize W Australia 15 days ballasters (C5) |
| C7 | Capesize Atlantic ballasters (C7) |
| P6 | Panamax ECSA 40 days ballasters (P6) |
| P1 | Panamax Atlantic ballasters (P1) |
| P3 | Panamax WCNA 20 days ballasters (P3) |
| P5 | Panamax Marketed SE Asia open 7 days (P5) |
| S5 | Supramax Marketed ECSA ETA 20days (S5) |
| S2 | Supramax Marketed Far East open 10days (S2) |
| S10 | Supramax Marketed South China open 10days (S10) |
| HS4 | Handy Marketed USG open 20 days (HS4) |
| HS5 | Handy Marketed SE Asia open 10 days (HS5) |
TC1 and TC5 are the Baltic routes that the LR2 and LR1 Arabian Gulf templates match.
Good to know¶
- Relative windows. A
*_relative_offsetrange andeta_relative_offsetcount days from each snapshot day onget_supply_trendandget_historical_supply, and from today onget_live_supply. The templates use relative windows, so a template means the same on all three methods. - Commercial data history. Commercial availability history starts on 29 January 2026. For earlier days, the commercial filters and the ETA calculations use Signal's system-calculated values. Results before and after that day can look different.
- Your organisation's data. From your account's start date, results show your organisation's own positions and commercial data. Before that date, results come from Signal's baseline data.
- Hub ports on the trend.
get_supply_trendalways calculates ETAs to hub ports. An ETA basis port that is not a hub port is replaced by the hub port of its region, and the result'snotessay so. So a trend count for an ETA template can differ a little from the live list of the same template.get_historical_supplyuses the ports as given, unless you setuse_only_hub_ports=True. - Daily limit on historical supply. Each API key can call
get_historical_supply5 times per day. For counts over a date range, useget_supply_trend. - HS4. Its name says 20 days, but its open window is 10 days. The SDK keeps the 10-day window of the template.
- Errors. When the API refuses a request, the SDK raises
requests.HTTPError. The error message includes the API's explanation, for example which filter is not valid.
Package Documentation¶
Supply API: vessel supply trend, historical supply and live supply.
Classes:
| Name | Description |
|---|---|
SupplyAPI |
Retrieves vessel supply. |
SupplyFilter |
Filters for all three supply methods. |
LiveSupplyFilter |
Filters for live supply, with routing restrictions. |
SupplyTemplate |
A Baltic route template. |
SupplyTrend |
Daily supply counts. |
SupplySnapshot |
Vessel records of one day. |
AisTracking
¶
Bases: SupplyResponseModel
AIS position, movement and destination of a vessel.
Attributes:
| Name | Type | Description |
|---|---|---|
last_movement_date_time_utc |
Optional[datetime]
|
Last time the system detected a movement of the vessel, in UTC. Shows if the vessel is stationary or underway. |
days_since_latest_ais |
Optional[float]
|
Days since the last AIS message of the vessel. More than 7 days can mean that the AIS is off or out of coverage. |
ais_latitude_average |
Optional[float]
|
Average latitude of the day. |
ais_longitude_average |
Optional[float]
|
Average longitude of the day. |
ais_draught_average |
Optional[float]
|
Average draught of the day, in metres. |
ais_heading_average |
Optional[float]
|
Average heading of the day, in degrees. |
ais_speed_average |
Optional[float]
|
Average speed of the day in knots. Includes the time steaming and the time stationary. |
ais_seagoing_speed_average |
Optional[float]
|
Average steaming speed of the day in knots. Speeds below 5 knots are not included. |
ais_current_area |
Optional[str]
|
Name of the standard area of the AIS position, for example US Gulf. |
ais_current_area_id |
Optional[int]
|
Id of the standard area of the AIS position. |
ais_closest_location |
Optional[str]
|
Name of the location nearest to the AIS position. |
ais_closest_location_id |
Optional[int]
|
Id of the location nearest to the AIS position. |
ais_destination |
Optional[str]
|
Name of the destination that the vessel reports on AIS. |
ais_destination_taxonomy |
Optional[str]
|
Precision level of the AIS destination,
for example |
ais_destination_geo_id |
Optional[int]
|
Geo id of the AIS destination. The crew enters this destination. |
ais_destination_taxonomy_id |
Optional[int]
|
Precision level id of the AIS
destination. See |
eta_to_ais_destination |
Optional[datetime]
|
ETA to the AIS destination, calculated by the system. It is not the ETA that the crew reports. |
miles_to_ais_destination |
Optional[float]
|
Distance to the AIS destination in nautical miles. |
delays_to_ais_destination |
Optional[float]
|
Estimated delays to the AIS destination, in hours. |
Source code in signal_ocean/supply/models.py
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 | |
AisTrackingFilter
¶
Bases: SupplyRequestModel
Filters on AIS position, movement and destination.
ais_current_area takes area ids as integers. ais_closest_location
and ais_destination take GeoLocation values.
Attributes:
| Name | Type | Description |
|---|---|---|
days_since_latest_ais |
Optional[int]
|
Maximum number of days since the last AIS message of the vessel. More than 7 days can mean that the AIS is off or out of coverage. |
ais_draught |
Optional[MinMaxRange]
|
Current AIS draught in metres. A deep draught usually means laden, a shallow draught usually means ballast. |
ais_heading |
Optional[List[HeadingRange]]
|
Compass headings in degrees, 0 to 360. |
ais_speed |
Optional[FromToRange]
|
Current AIS speed over ground in knots. |
ais_current_area |
Optional[IncludeExcludeFilter]
|
Area ids of the current AIS position. |
ais_closest_location |
Optional[IncludeExcludeFilter]
|
The named location nearest to the AIS position. |
ais_destination |
Optional[IncludeExcludeFilter]
|
The destination that the vessel reports on AIS. |
eta_to_ais_destination |
Optional[FromToRange]
|
ETA to the AIS destination, calculated by the system. |
Source code in signal_ocean/supply/filters.py
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 | |
AvailabilityState
¶
Commercial availability states, for availability_state.
Source code in signal_ocean/supply/constants.py
64 65 66 67 68 69 70 71 72 | |
Coating
¶
Tank coating types, for coating.
Source code in signal_ocean/supply/constants.py
149 150 151 152 153 154 155 156 157 158 | |
Column
¶
Column names of SupplySnapshot.to_data_frame().
After these columns come four columns per ETA configuration:
eta_<id>, eta_distance_<id>, eta_basis_port_id_<id> and
eta_canals_<id>. <id> is the configuration's id, or its position
(0, 1, ...) when it has no id.
Source code in signal_ocean/supply/data_frame.py
13 14 15 16 17 18 19 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 183 184 185 186 187 188 189 190 191 | |
AIS_CLOSEST_LOCATION = 'ais_closest_location'
class-attribute
instance-attribute
¶
Name of the closest location.
AIS_CLOSEST_LOCATION_ID = 'ais_closest_location_id'
class-attribute
instance-attribute
¶
Id of the closest location.
AIS_CURRENT_AREA = 'ais_current_area'
class-attribute
instance-attribute
¶
Name of the area the vessel is in.
AIS_CURRENT_AREA_ID = 'ais_current_area_id'
class-attribute
instance-attribute
¶
Id of the area the vessel is in.
AIS_DESTINATION = 'ais_destination'
class-attribute
instance-attribute
¶
Name of the destination the crew reported in AIS.
AIS_DESTINATION_GEO_ID = 'ais_destination_geo_id'
class-attribute
instance-attribute
¶
Geo id of the AIS destination.
AIS_DESTINATION_TAXONOMY = 'ais_destination_taxonomy'
class-attribute
instance-attribute
¶
Level of the AIS destination, for example Port.
AIS_DESTINATION_TAXONOMY_ID = 'ais_destination_taxonomy_id'
class-attribute
instance-attribute
¶
Level id of the AIS destination.
AIS_DRAUGHT_AVERAGE = 'ais_draught_average'
class-attribute
instance-attribute
¶
Average draught of the day.
AIS_HEADING_AVERAGE = 'ais_heading_average'
class-attribute
instance-attribute
¶
Average heading of the day.
AIS_LATITUDE_AVERAGE = 'ais_latitude_average'
class-attribute
instance-attribute
¶
Average latitude of the day.
AIS_LONGITUDE_AVERAGE = 'ais_longitude_average'
class-attribute
instance-attribute
¶
Average longitude of the day.
AIS_SEAGOING_SPEED_AVERAGE = 'ais_seagoing_speed_average'
class-attribute
instance-attribute
¶
Average speed of the day when steaming (5 knots or more).
AIS_SPEED_AVERAGE = 'ais_speed_average'
class-attribute
instance-attribute
¶
Average speed of the day, stationary time included.
AVAILABILITY_STATE = 'availability_state'
class-attribute
instance-attribute
¶
Commercial availability state, for example Available.
AVAILABILITY_STATE_ID = 'availability_state_id'
class-attribute
instance-attribute
¶
Id of the availability state.
CARGO_QUANTITY = 'cargo_quantity'
class-attribute
instance-attribute
¶
Cargo quantity in metric tons.
CARGO_TYPE = 'cargo_type'
class-attribute
instance-attribute
¶
Name of the current or last cargo type.
CARGO_TYPE_ID = 'cargo_type_id'
class-attribute
instance-attribute
¶
Id of the current or last cargo type.
CHARTERER = 'charterer'
class-attribute
instance-attribute
¶
Charterer name.
CHARTERER_ID = 'charterer_id'
class-attribute
instance-attribute
¶
Charterer company id.
DAY = 'day'
class-attribute
instance-attribute
¶
The snapshot day.
DAYS_SINCE_LATEST_AIS = 'days_since_latest_ais'
class-attribute
instance-attribute
¶
Days since the last AIS message.
DELAYS_TO_AIS_DESTINATION = 'delays_to_ais_destination'
class-attribute
instance-attribute
¶
Estimated delay to the AIS destination in hours.
ETA_TO_AIS_DESTINATION = 'eta_to_ais_destination'
class-attribute
instance-attribute
¶
Calculated ETA to the AIS destination.
FORECASTED_DESTINATION_PORT = 'forecasted_destination_port'
class-attribute
instance-attribute
¶
Name of the forecasted next port.
FORECASTED_DESTINATION_PORT_ID = 'forecasted_destination_port_id'
class-attribute
instance-attribute
¶
Id of the forecasted next port.
IMO = 'imo'
class-attribute
instance-attribute
¶
The vessel's IMO number.
LAST_CARGO_TYPES = 'last_cargo_types'
class-attribute
instance-attribute
¶
Last cargo type names, as a list.
LAST_CARGO_TYPE_IDS = 'last_cargo_type_ids'
class-attribute
instance-attribute
¶
Last cargo type ids, as a list.
LAST_MARKETED_DATE = 'last_marketed_date'
class-attribute
instance-attribute
¶
Last date the vessel was pushed to the market.
LAST_MOVEMENT_DATE_TIME_UTC = 'last_movement_date_time_utc'
class-attribute
instance-attribute
¶
Last time the vessel moved.
LAST_VOYAGE_CARGO_TYPES = 'last_voyage_cargo_types'
class-attribute
instance-attribute
¶
Cargo type names of the previous voyage, as a list.
LAST_VOYAGE_CARGO_TYPE_IDS = 'last_voyage_cargo_type_ids'
class-attribute
instance-attribute
¶
Cargo type ids of the previous voyage, as a list.
LATEST_UPDATED_DATE = 'latest_updated_date'
class-attribute
instance-attribute
¶
Last update of the vessel's commercial data.
MARKET_DEPLOYMENT = 'market_deployment'
class-attribute
instance-attribute
¶
Market deployment, for example Spot.
MARKET_DEPLOYMENT_ID = 'market_deployment_id'
class-attribute
instance-attribute
¶
Id of the market deployment.
MARKET_STATUS = 'market_status'
class-attribute
instance-attribute
¶
Market push state, for example Pushed.
MARKET_STATUS_ID = 'market_status_id'
class-attribute
instance-attribute
¶
Id of the market status.
MILES_TO_AIS_DESTINATION = 'miles_to_ais_destination'
class-attribute
instance-attribute
¶
Distance to the AIS destination in nautical miles.
NOTES = 'notes'
class-attribute
instance-attribute
¶
Your company's notes; only when live supply includes details.
OPEN_DATE_FROM = 'open_date_from'
class-attribute
instance-attribute
¶
Start of the open period.
OPEN_DATE_TO = 'open_date_to'
class-attribute
instance-attribute
¶
End of the open period.
OPEN_LOCATION = 'open_location'
class-attribute
instance-attribute
¶
Name of the location where the vessel opens.
OPEN_LOCATION_GEO_ID = 'open_location_geo_id'
class-attribute
instance-attribute
¶
Geo id of the open location.
OPEN_LOCATION_TAXONOMY = 'open_location_taxonomy'
class-attribute
instance-attribute
¶
Level of the open location, for example Port.
OPEN_LOCATION_TAXONOMY_ID = 'open_location_taxonomy_id'
class-attribute
instance-attribute
¶
Level id of the open location.
POSITION_SOURCE_ORIGIN = 'position_source_origin'
class-attribute
instance-attribute
¶
Origin of the position data, for example Manual.
POSITION_SOURCE_ORIGIN_ID = 'position_source_origin_id'
class-attribute
instance-attribute
¶
Id of the position source origin.
POSITION_SOURCE_TYPE = 'position_source_type'
class-attribute
instance-attribute
¶
Type of the position source, for example Email.
POSITION_SOURCE_TYPE_ID = 'position_source_type_id'
class-attribute
instance-attribute
¶
Id of the position source type.
START_PORT = 'start_port'
class-attribute
instance-attribute
¶
Name of the voyage leg's start port.
START_PORT_ID = 'start_port_id'
class-attribute
instance-attribute
¶
Id of the voyage leg's start port.
VESSEL_CLASS = 'vessel_class'
class-attribute
instance-attribute
¶
The vessel class name.
VESSEL_CLASS_ID = 'vessel_class_id'
class-attribute
instance-attribute
¶
The vessel class.
VOYAGE_STATE = 'voyage_state'
class-attribute
instance-attribute
¶
Operational voyage state, for example Laden.
VOYAGE_STATE_ID = 'voyage_state_id'
class-attribute
instance-attribute
¶
Id of the voyage state.
CommercialAvailability
¶
Bases: SupplyResponseModel
Open location, open dates and commercial status of a vessel.
Attributes:
| Name | Type | Description |
|---|---|---|
open_location |
Optional[str]
|
Name of the location where the vessel becomes available. |
open_location_taxonomy |
Optional[str]
|
Precision level of the open location, for
example |
open_location_geo_id |
Optional[int]
|
Geo id of the open location. |
open_location_taxonomy_id |
Optional[int]
|
Precision level id of the open location.
See |
open_date_from |
Optional[datetime]
|
Start of the open period: the first day of the lay range. |
open_date_to |
Optional[datetime]
|
End of the open period: the last day of the lay range. |
availability_state |
Optional[str]
|
Charter market status: open for new business,
under negotiation, or committed. Shows if the vessel is in the
live tonnage pool. See |
availability_state_id |
Optional[int]
|
Id of the availability state. |
market_status |
Optional[str]
|
Whether the commercial operator markets the vessel:
pushed (listed), possibly pushed, or not pushed (no evidence).
See |
market_status_id |
Optional[int]
|
Id of the market status. |
market_deployment |
Optional[str]
|
How the vessel is deployed: spot (voyage by
voyage), program (semi-contractual), contract (long term) or
relet (sub-chartered). See |
market_deployment_id |
Optional[int]
|
Id of the market deployment. |
position_source_origin |
Optional[str]
|
How the position was found: entered by a
user, from AIS, or calculated by the system. See
|
position_source_origin_id |
Optional[int]
|
Id of the position source origin. |
position_source_type |
Optional[str]
|
The channel that reported the position, for
example email, a chat application (Slack, Teams, WhatsApp) or a
model prediction. See |
position_source_type_id |
Optional[int]
|
Id of the position source type. |
last_marketed_date |
Optional[datetime]
|
When the operator last marketed the vessel. The number of days since this date helps to estimate if the vessel is committed or under negotiation. |
latest_updated_date |
Optional[datetime]
|
When the commercial data of the vessel was last updated. Shows how recent the data is. |
forecasted_destination_port |
Optional[str]
|
Name of the destination port that the system predicts. |
forecasted_destination_port_id |
Optional[int]
|
Id of the next port that the system predicts from the patterns of the vessel. |
Source code in signal_ocean/supply/models.py
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 | |
CommercialAvailabilityFilter
¶
Bases: SupplyRequestModel
Filters on open location, open date and commercial status.
Location filters take GeoLocation values. A *_relative_offset
range counts days from each snapshot day, or from today on live supply.
An absolute date and its relative offset cannot be combined.
Attributes:
| Name | Type | Description |
|---|---|---|
open_location |
Optional[IncludeExcludeFilter]
|
Where the vessel becomes available, from AIS and
commercial data. Takes |
open_date |
Optional[FromToRange]
|
When the vessel becomes available for its next charter. |
open_date_relative_offset |
Optional[FromToRange]
|
Open date in days from the snapshot day. A negative value is in the past. |
availability_state |
Optional[List[str]]
|
Charter market status: open for new business,
under negotiation, or committed. See |
market_status |
Optional[IncludeExcludeFilter]
|
Whether the commercial operator markets the vessel:
pushed, possibly pushed or not pushed. See |
market_deployment |
Optional[List[str]]
|
How the vessel is deployed: spot, program,
contract or relet. See |
position_source_origin |
Optional[IncludeExcludeFilter]
|
How the position was found: entered by a
user, from AIS, or calculated by the system. See
|
position_source_type |
Optional[IncludeExcludeFilter]
|
The channel that reported the position, for
example email or a model prediction. See |
last_marketed_date |
Optional[FromToRange]
|
When the operator last marketed the vessel. |
last_marketed_date_relative_offset |
Optional[FromToRange]
|
Last marketed date in days from the snapshot day. |
latest_updated_date |
Optional[FromToRange]
|
When the commercial data of the vessel was last updated. Shows how recent the position is. |
latest_updated_date_relative_offset |
Optional[FromToRange]
|
Latest update in days from the snapshot day. |
forecasted_destination |
Optional[IncludeExcludeFilter]
|
The destination that the system predicts.
Takes |
Source code in signal_ocean/supply/filters.py
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 | |
DailySupply
¶
Bases: SupplyResponseModel
The supply count of one day.
Attributes:
| Name | Type | Description |
|---|---|---|
date |
datetime
|
The snapshot day. |
supply |
int
|
Number of vessels that match the filters on that day. |
Source code in signal_ocean/supply/models.py
23 24 25 26 27 28 29 30 31 32 | |
DefiningSize
¶
Size units, for defining_size.
Source code in signal_ocean/supply/constants.py
43 44 45 46 47 | |
EtaCalculationBasis
¶
Start position and date of an ETA calculation.
Source code in signal_ocean/supply/constants.py
128 129 130 131 132 133 134 | |
EtaConfiguration
¶
Bases: _EtaConfigurationFields
A custom ETA calculation, for supply trend and historical supply.
Attributes:
| Name | Type | Description |
|---|---|---|
basis_port_id |
int
|
The port to calculate the ETA to. |
speed |
Optional[float]
|
Speed in knots. The API uses 12 when not set. |
sea_margin |
Optional[float]
|
Extra time in percent, for example 10 for 10%. |
eta_calculation_basis |
Optional[str]
|
See |
eta |
Optional[MinMaxRange]
|
Absolute ETA range. Cannot be combined with
|
eta_relative_offset |
Optional[MinMaxRange]
|
ETA range in days from the snapshot day. |
id |
Optional[str]
|
Identifier returned in each vessel's |
Source code in signal_ocean/supply/filters.py
359 360 361 362 363 364 365 366 367 368 369 370 371 | |
EtaConfigurationWithRestrictions
¶
Bases: _EtaConfigurationFields
A custom ETA calculation with routing restrictions, for live supply.
Attributes:
| Name | Type | Description |
|---|---|---|
restrictions |
Optional[str]
|
See |
Source code in signal_ocean/supply/filters.py
374 375 376 377 378 379 380 381 382 | |
FromToRange
¶
Bases: SupplyRequestModel
Inclusive range with from and to bounds.
Attributes:
| Name | Type | Description |
|---|---|---|
from_ |
Any
|
Lower bound, sent as |
to |
Any
|
Upper bound. A number, a date or a datetime. |
Source code in signal_ocean/supply/filters.py
14 15 16 17 18 19 20 21 22 23 24 25 26 | |
GeoLocation
¶
Bases: SupplyRequestModel
A location for the location filters.
Attributes:
| Name | Type | Description |
|---|---|---|
geo_id |
int
|
The Signal geo identifier. |
location_taxonomy |
int
|
The location level. See |
Source code in signal_ocean/supply/filters.py
65 66 67 68 69 70 71 72 73 74 | |
HeadingRange
¶
Bases: SupplyRequestModel
Compass heading range in degrees, with start <= end.
Attributes:
| Name | Type | Description |
|---|---|---|
start |
float
|
First heading, 0 to 360. |
end |
float
|
Last heading, 0 to 360. |
Source code in signal_ocean/supply/filters.py
53 54 55 56 57 58 59 60 61 62 | |
ImoType
¶
IMO ship types, for imo_type.
Source code in signal_ocean/supply/constants.py
161 162 163 164 165 166 167 168 | |
IncludeExcludeFilter
¶
Bases: SupplyRequestModel
Values to include and values to exclude.
Attributes:
| Name | Type | Description |
|---|---|---|
values |
Optional[List[Any]]
|
Values to include. |
excluded |
Optional[List[Any]]
|
Values to exclude. A value cannot be in both lists. |
Source code in signal_ocean/supply/filters.py
41 42 43 44 45 46 47 48 49 50 | |
LiveSupplyFilter
¶
Bases: _SupplyFilterFields
Filters for live supply, where ETA calculations take restrictions.
The attributes are the same as in SupplyFilter, except that
eta_configuration also accepts EtaConfigurationWithRestrictions.
Source code in signal_ocean/supply/filters.py
426 427 428 429 430 431 432 433 434 435 | |
LocationTaxonomy
¶
Location levels, for GeoLocation.location_taxonomy.
Source code in signal_ocean/supply/constants.py
171 172 173 174 175 176 177 178 | |
MarketDeployment
¶
Market deployment types, for market_deployment.
Source code in signal_ocean/supply/constants.py
83 84 85 86 87 88 89 | |
MarketStatus
¶
Market push states, for market_status.
Source code in signal_ocean/supply/constants.py
75 76 77 78 79 80 | |
MinMaxRange
¶
Bases: SupplyRequestModel
Inclusive range with min and max bounds.
Attributes:
| Name | Type | Description |
|---|---|---|
min |
Any
|
Lower bound. A number, a date or a datetime. |
max |
Any
|
Upper bound. A number, a date or a datetime. |
Source code in signal_ocean/supply/filters.py
29 30 31 32 33 34 35 36 37 38 | |
PositionSourceOrigin
¶
Position data origins, for position_source_origin.
Source code in signal_ocean/supply/constants.py
92 93 94 95 96 97 98 | |
PositionSourceType
¶
Position data origin types, for position_source_type.
Source code in signal_ocean/supply/constants.py
101 102 103 104 105 106 107 108 109 110 | |
Restrictions
¶
Routing restrictions of a live ETA calculation.
Source code in signal_ocean/supply/constants.py
137 138 139 140 141 142 143 144 145 146 | |
SupplyAPI
¶
Retrieves vessel supply: daily counts, one day's vessels, live.
Source code in signal_ocean/supply/api.py
18 19 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 | |
__init__(connection=None)
¶
Initializes the Supply API.
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/supply/api.py
23 24 25 26 27 28 29 30 | |
get_historical_supply(day, template=None, filters=None, use_only_hub_ports=None)
¶
Get the vessels that matched the filters on one past day.
Each subscription key can make a limited number of these calls per day.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
day
|
date
|
The snapshot day. |
required |
template
|
Optional[str]
|
A Baltic route code, for example |
None
|
filters
|
Optional[SupplyFilter]
|
Filters. A field set here replaces the template's value for that field. |
None
|
use_only_hub_ports
|
Optional[bool]
|
True remaps each ETA basis port that is not a hub port to the hub port of its region. False uses the ports as given. None sends nothing, so the API default (False) applies. |
None
|
Returns:
| Type | Description |
|---|---|
SupplySnapshot
|
One record per vessel. |
Source code in signal_ocean/supply/api.py
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 | |
get_live_supply(template=None, filters=None, include_details=False)
¶
Get the vessels that match the filters now.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
template
|
Optional[str]
|
A Baltic route code, for example |
None
|
filters
|
Optional[Union[SupplyFilter, LiveSupplyFilter]]
|
Filters. Use |
None
|
include_details
|
bool
|
True adds your company's notes to each record. |
False
|
Returns:
| Type | Description |
|---|---|
SupplySnapshot
|
One record per vessel. |
Source code in signal_ocean/supply/api.py
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 | |
get_supply_templates()
¶
Get the Baltic route templates.
Returns:
| Type | Description |
|---|---|
Tuple[SupplyTemplate, ...]
|
The templates. Pass a template's |
Source code in signal_ocean/supply/api.py
120 121 122 123 124 125 126 | |
get_supply_trend(start_date, end_date, template=None, filters=None)
¶
Count the vessels that match the filters on each day of a range.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
start_date
|
date
|
First day of the range. |
required |
end_date
|
date
|
Last day of the range. |
required |
template
|
Optional[str]
|
A Baltic route code, for example |
None
|
filters
|
Optional[SupplyFilter]
|
Filters. A field set here replaces the template's value for that field. |
None
|
Returns:
| Type | Description |
|---|---|
SupplyTrend
|
One count per day, and the API's notes. |
Source code in signal_ocean/supply/api.py
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 | |
SupplyEta
¶
Bases: SupplyResponseModel
The result of one custom ETA calculation for a vessel.
Attributes:
| Name | Type | Description |
|---|---|---|
basis_port_id |
Optional[int]
|
The port of the ETA calculation. |
eta |
Optional[datetime]
|
The estimated time of arrival. |
distance |
Optional[float]
|
Distance to the port in nautical miles. |
id |
Optional[str]
|
The |
canals |
Optional[Tuple[str, ...]]
|
Canals on the route. |
Source code in signal_ocean/supply/models.py
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 | |
SupplyFilter
¶
Bases: _SupplyFilterFields
Filters for supply trend, historical supply and live supply.
Give either vessel_class, or all of vessel_type, defining_size
and size. The API refuses a request with neither, or with both.
Attributes:
| Name | Type | Description |
|---|---|---|
vessel_class |
Optional[Union[int, str]]
|
Class name (see |
vessel_type |
Optional[Union[int, str]]
|
Type name (see |
size |
Optional[FromToRange]
|
Size range, in the unit of |
defining_size |
Optional[str]
|
See |
vessel_subclass |
Optional[List[str]]
|
See |
add_willing_to_switch_subclass |
Optional[bool]
|
Also include vessels willing to
switch into |
imo |
Optional[List[int]]
|
IMO numbers. |
search_text |
Optional[str]
|
Text to find in vessel or company names. |
commercial_availability |
Optional[CommercialAvailabilityFilter]
|
See |
voyage_details |
Optional[VoyageDetailsFilter]
|
See |
ais_tracking |
Optional[AisTrackingFilter]
|
See |
vessel_particulars |
Optional[VesselParticularsFilter]
|
See |
eta_configuration |
Optional[List[EtaConfiguration]]
|
Custom ETA calculations. |
Source code in signal_ocean/supply/filters.py
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 | |
SupplyRecord
¶
Bases: SupplyResponseModel
The state of one vessel on one day.
Attributes:
| Name | Type | Description |
|---|---|---|
day |
Optional[datetime]
|
The snapshot day. |
imo |
Optional[int]
|
The vessel's IMO number. |
vessel_class_id |
Optional[Union[int, str]]
|
The vessel class. |
vessel_class |
Optional[str]
|
The vessel class name. |
commercial_availability |
Optional[CommercialAvailability]
|
Open location, dates and status. |
voyage_details |
Optional[VoyageDetails]
|
Voyage state and cargo. |
ais_tracking |
Optional[AisTracking]
|
AIS position and destination. |
eta_details |
Annotated[Tuple[SupplyEta, ...], _EMPTY_IF_NULL]
|
One entry per ETA configuration in the request. |
details |
Optional[VesselDetails]
|
Extra details, only when live supply includes details. |
Source code in signal_ocean/supply/models.py
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 | |
SupplySnapshot
¶
Bases: SupplyResponseModel
Vessel records of one day, from historical or live supply.
Attributes:
| Name | Type | Description |
|---|---|---|
data |
Annotated[Tuple[SupplyRecord, ...], _EMPTY_IF_NULL]
|
One record per vessel. |
include_details |
bool
|
True when the live request asked for details. |
Source code in signal_ocean/supply/models.py
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 | |
to_data_frame()
¶
Return the records as a data frame with one row per vessel.
Returns:
| Type | Description |
|---|---|
DataFrame
|
A data frame. See |
Source code in signal_ocean/supply/models.py
293 294 295 296 297 298 299 | |
SupplyTemplate
¶
Bases: SupplyResponseModel
A Baltic route template.
Attributes:
| Name | Type | Description |
|---|---|---|
code |
str
|
The route code, for example |
name |
str
|
The template name. |
description |
str
|
What the template selects. |
segment |
str
|
|
list_type |
str
|
The kind of list the template was designed for. |
filters |
SupplyFilter
|
The filters the template sends. |
Source code in signal_ocean/supply/templates.py
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 | |
SupplyTrend
¶
Bases: SupplyResponseModel
The result of a supply trend request.
Attributes:
| Name | Type | Description |
|---|---|---|
supply_per_day |
Annotated[Tuple[DailySupply, ...], _EMPTY_IF_NULL]
|
One count per day of the requested range. |
notes |
Annotated[Tuple[str, ...], _EMPTY_IF_NULL]
|
Messages from the API, for example about ETA basis ports that were remapped to hub ports. |
Source code in signal_ocean/supply/models.py
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 | |
to_data_frame()
¶
Return the counts as a data frame.
Returns:
| Type | Description |
|---|---|
DataFrame
|
A data frame indexed by |
DataFrame
|
column |
Source code in signal_ocean/supply/models.py
49 50 51 52 53 54 55 56 | |
VesselClass
¶
Vessel classes, for vessel_class.
Source code in signal_ocean/supply/constants.py
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 | |
VesselDetails
¶
Bases: SupplyResponseModel
Extra vessel details, returned when live supply includes details.
Attributes:
| Name | Type | Description |
|---|---|---|
notes |
Optional[str]
|
Your company's notes on the vessel. |
Source code in signal_ocean/supply/models.py
246 247 248 249 250 251 252 253 | |
VesselParticularsFilter
¶
Bases: SupplyRequestModel
Filters on vessel characteristics, ownership and sanctions.
Attributes:
| Name | Type | Description |
|---|---|---|
commercial_operator |
Optional[IncludeExcludeFilter]
|
Company ids of the commercial operator, the company that decides the employment of the vessel. |
liquid_capacity |
Optional[MinMaxRange]
|
Liquid capacity in cubic metres. |
ice_class |
Optional[List[str]]
|
Ice class names. |
cranes_ton_capacity |
Optional[MinMaxRange]
|
Crane capacity in tonnes. |
length_overall |
Optional[MinMaxRange]
|
Length overall (LOA) in metres. |
breadth_extreme |
Optional[MinMaxRange]
|
Breadth in metres. |
air_draught |
Optional[MinMaxRange]
|
Air draught in metres. |
ballast_parallel_body_length |
Optional[MinMaxRange]
|
Parallel body length in ballast, in metres. |
bow_to_center_manifold |
Optional[MinMaxRange]
|
Bow to center manifold, in metres. |
class_renewal_date |
Optional[MinMaxRange]
|
Class renewal date. |
built_country_code |
Optional[IncludeExcludeFilter]
|
ISO codes of the build country. |
built_country_name |
Optional[IncludeExcludeFilter]
|
Names of the build country. |
crude_oil_washing |
Optional[bool]
|
Crude oil washing system. |
delivery_date |
Optional[MinMaxRange]
|
Delivery date. |
flag_code |
Optional[IncludeExcludeFilter]
|
ISO codes of the flag state. |
heating_coils_fitted |
Optional[bool]
|
Heating coils fitted. |
inert_gas_system |
Optional[bool]
|
Inert gas system. |
lightship_tonnes |
Optional[MinMaxRange]
|
Lightship weight in tonnes. |
main_engine_manufacturer_id |
Optional[IncludeExcludeFilter]
|
Main engine manufacturer ids. |
main_engine_manufacturer |
Optional[List[str]]
|
Main engine manufacturer names. |
main_engine_kw |
Optional[MinMaxRange]
|
Main engine power in kW. |
main_engine_rpm |
Optional[MinMaxRange]
|
Main engine RPM. |
moulded_depth |
Optional[MinMaxRange]
|
Moulded depth in metres. |
parallel_body_length |
Optional[MinMaxRange]
|
Parallel body length in metres. |
reduced_gross_tonnage |
Optional[MinMaxRange]
|
Reduced gross tonnage. |
shipyard_built_id |
Optional[IncludeExcludeFilter]
|
Ids of the shipyard that built the vessel. |
stern_line |
Optional[bool]
|
Stern line fitted. |
water_line_to_manifold |
Optional[MinMaxRange]
|
Waterline to manifold, in metres. |
built_for_trade_ids |
Optional[List[int]]
|
Ids of the trades that the vessel was built for. |
bale_capacity |
Optional[MinMaxRange]
|
Bale capacity in cubic metres. |
co2_fitted |
Optional[bool]
|
CO2 system fitted. |
grain_capacity |
Optional[MinMaxRange]
|
Grain capacity in cubic metres. |
neo_panama_locks |
Optional[bool]
|
Fits the Neo-Panamax locks. |
number_of_holds |
Optional[MinMaxRange]
|
Number of holds. |
australian_ladder |
Optional[bool]
|
Australian ladder fitted. |
log_fitted |
Optional[bool]
|
Log fitted. |
open_hatch |
Optional[bool]
|
Open hatch design. |
a60_bulkhead |
Optional[bool]
|
A60 bulkhead. |
gross_registered_tonnage |
Optional[MinMaxRange]
|
Gross registered tonnage (GRT). |
net_registered_tonnage |
Optional[MinMaxRange]
|
Net registered tonnage (NRT). |
head_owner_id |
Optional[IncludeExcludeFilter]
|
Company ids of the head owner, the owner at the top of the ownership structure. |
ballast_water_treatment |
Optional[bool]
|
Ballast water treatment system. |
draught |
Optional[MinMaxRange]
|
Draught in metres. |
geared |
Optional[bool]
|
Has cranes or other cargo gear. A geared vessel can load and discharge without port cranes. |
classification_register_id |
Optional[IncludeExcludeFilter]
|
Classification society ids. |
vessel_age |
Optional[MinMaxRange]
|
Vessel age in years. An alternative to |
coating |
Optional[str]
|
Tank coating. See |
imo_type |
Optional[str]
|
IMO ship type. See |
crane_max_out_reach |
Optional[MinMaxRange]
|
Maximum crane outreach in metres. |
crane_lifting_capacity |
Optional[MinMaxRange]
|
Crane lifting capacity in tonnes. |
number_of_cranes |
Optional[MinMaxRange]
|
Number of cranes. |
box_shaped_holds |
Optional[bool]
|
Box-shaped holds. |
hold_length |
Optional[MinMaxRange]
|
Hold length in metres. |
hold_height |
Optional[MinMaxRange]
|
Hold height in metres. |
hold_breadth |
Optional[MinMaxRange]
|
Hold breadth in metres. |
number_of_hatches |
Optional[MinMaxRange]
|
Number of hatches. |
has_hatches |
Optional[bool]
|
Has hatches. |
hatch_length |
Optional[MinMaxRange]
|
Hatch length in metres. |
hatch_breadth |
Optional[MinMaxRange]
|
Hatch breadth in metres. |
number_of_grabs |
Optional[MinMaxRange]
|
Number of grabs. |
has_grabs |
Optional[bool]
|
Has grabs. |
grab_lifting_capacity |
Optional[MinMaxRange]
|
Grab lifting capacity in tonnes. |
grab_max_lifting_weight |
Optional[MinMaxRange]
|
Maximum grab lifting weight in tonnes. |
scrubbers |
Optional[bool]
|
Exhaust gas scrubbers fitted. A vessel with scrubbers can burn high-sulphur fuel oil. |
year_built |
Optional[MinMaxRange]
|
Year built. |
number_of_bow_thrusters |
Optional[MinMaxRange]
|
Number of bow thrusters. |
number_of_bow_chain_stoppers |
Optional[MinMaxRange]
|
Number of bow chain stoppers. |
propulsion_type |
Optional[IncludeExcludeFilter]
|
Propulsion type ids. |
gas_containment_type |
Optional[IncludeExcludeFilter]
|
Gas containment type ids, for LNG and LPG vessels. |
summer_tpc |
Optional[MinMaxRange]
|
Summer tonnes per centimetre immersion (TPC). |
design_model |
Optional[IncludeExcludeFilter]
|
Names of the vessel design model. |
sanction_status |
Optional[IncludeExcludeFilter]
|
Sanction status ids. Use it to find or remove sanctioned vessels. |
trade |
Optional[IncludeExcludeFilter]
|
The sub-segment of the vessel within its class. Includes the manual changes of your company. |
Source code in signal_ocean/supply/filters.py
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 231 232 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 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 | |
VesselSubclass
¶
Vessel subclasses, for vessel_subclass.
Source code in signal_ocean/supply/constants.py
50 51 52 53 54 55 56 57 58 59 60 61 | |
VesselType
¶
Vessel types, for vessel_type.
Source code in signal_ocean/supply/constants.py
9 10 11 12 13 14 15 | |
VoyageDetails
¶
Bases: SupplyResponseModel
Voyage state, cargo and recent cargo history of a vessel.
Attributes:
| Name | Type | Description |
|---|---|---|
voyage_state |
Optional[str]
|
The phase of the current voyage, for example ballast
(empty), laden (with cargo), loading or discharging. See
|
voyage_state_id |
Optional[int]
|
Id of the voyage state. |
cargo_type |
Optional[str]
|
Name of the current or last cargo type. |
cargo_type_id |
Optional[int]
|
Id of the current or last cargo type. |
cargo_quantity |
Optional[int]
|
Cargo quantity in metric tonnes. |
charterer |
Optional[str]
|
Charterer company name. |
charterer_id |
Optional[int]
|
Charterer company id. |
start_port |
Optional[str]
|
Name of the start (load) port of the voyage leg. |
start_port_id |
Optional[int]
|
Id of the start (load) port of the voyage leg. |
last_voyage_cargo_types |
Optional[Tuple[str, ...]]
|
Cargo type names of the previous voyage. |
last_voyage_cargo_type_ids |
Optional[Tuple[int, ...]]
|
Cargo type ids of the previous voyage. |
last_cargo_types |
Optional[Tuple[str, ...]]
|
Names of the last cargo types, up to 3. The recent cargo history of the vessel. |
last_cargo_type_ids |
Optional[Tuple[int, ...]]
|
Ids of the last cargo types, up to 3. The recent cargo history of the vessel. |
Source code in signal_ocean/supply/models.py
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 | |
VoyageDetailsFilter
¶
Bases: SupplyRequestModel
Filters on voyage state, cargo, start port and charterer.
start_port takes GeoLocation values; the id filters take integers.
Attributes:
| Name | Type | Description |
|---|---|---|
voyage_state |
Optional[List[str]]
|
The phase of the current voyage, for example ballast,
laden, loading or discharging. See |
reported_last_cargo_type_id |
Optional[IncludeExcludeFilter]
|
Cargo type ids of the last reported cargoes, up to 3. |
cargo_type_id |
Optional[IncludeExcludeFilter]
|
Cargo type id on the current voyage. |
last_voyage_cargo_type_id |
Optional[IncludeExcludeFilter]
|
Cargo type ids of the previous voyage. |
start_port |
Optional[IncludeExcludeFilter]
|
The load port of the voyage leg. |
cargo_quantity |
Optional[FromToRange]
|
Cargo quantity in metric tonnes. |
charterer |
Optional[IncludeExcludeFilter]
|
Charterer company ids. |
Source code in signal_ocean/supply/filters.py
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 | |
VoyageState
¶
Operational voyage states, for voyage_state.
Source code in signal_ocean/supply/constants.py
113 114 115 116 117 118 119 120 121 122 123 124 125 | |