Package Documentation¶
Models instantiated by the voyages api.
Fixture
dataclass
¶
Fixture information.
Attributes:
Name | Type | Description |
---|---|---|
next_page_token |
String. The key that should be used as a parameter of the token to retrieve the next page. |
|
is_matched |
Optional[bool]
|
Boolean. This will be true if the market data item is matched to the corresponding voyage. |
is_load_matched |
Optional[bool]
|
Boolean. This will be true if the load of the market data item is matched to the corresponding voyage. |
is_discharge_matched |
Optional[bool]
|
Boolean. This will be true if the load of the market data item is matched to the corresponding voyage. |
fixture_status_id |
Optional[int]
|
0-> OnSubs, 1-> FullyFixed, 2-> Failed, 3-> Cancelled, 4-> Available, -2-> NotSet, -1-> Unknown |
fixture_status |
Optional[str]
|
String, based on the status of the market data item. Potential values are OnSubs, FullyFixed, Failed, Cancelled, Available |
Source code in signal_ocean/voyages_market_data/models.py
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 |
|
MatchedFixture
dataclass
¶
Contains information about a single fixture.
Attributes:
Name | Type | Description |
---|---|---|
fixture_status_id |
Optional[int]
|
Numeric ID corresponding to the different values of the FixtureStatus field. 0-> OnSubs, 1-> FullyFixed, 2-> Failed, 3-> Cancelled , 4-> Available, 5-> PossFixed, -2-> NotSet, -1-> Unknown. |
fixture_status |
Optional[str]
|
String denoting the commercial status of a fixture if explicitly mentioned, like ffxd for fully fixed or subs for on subs. |
charter_type_id |
Optional[int]
|
Numeric ID corresponding to the different values of the ChartererType field. 0-> Voyage, 1-> Time charter |
charter_type |
Optional[str]
|
String denoting the type of the charter |
charterer_id |
Optional[int]
|
Numeric ID corresponding to the company reported as charterer in at least one of the fixtures. |
charterer |
Optional[str]
|
String, name of the company reported as charterer in at least one of the fixtures. |
laycan_from |
Optional[datetime]
|
Date, format YYYY-MM-DD indicates the earliest reported Laycan From (latest day of cancellation) across all fixtures. |
laycan_to |
Optional[datetime]
|
Date, format YYYY-MM-DD indicates the latest reported Laycan To (latest day of cancellation) across all fixtures. |
load_geo_id |
Optional[int]
|
Numeric ID corresponding to the id of the load geo asset |
load_name |
Optional[str]
|
String, name of the load geo asset |
load_taxonomy_id |
Optional[int]
|
1-> GeoAsset, 2-> Port, 3-> Country, 4-> Level0, 5-> Level1, 6-> Level2, 7-> Level3, -3-> Invalid, -2-> NotSet, -1-> Unknown |
load_taxonomy |
Optional[str]
|
String, the taxonomy of the load geo asset |
load_geo_id2 |
Optional[int]
|
Numeric ID corresponding to the id of the load geo asset |
load_name |
Optional[str]
|
String, name of the load geo asset |
load_name2 |
Optional[str]
|
String, the taxonomy of the second load geo asset |
load_taxonomy_id2 |
Optional[int]
|
1-> GeoAsset, 2-> Port, 3-> Country, 4-> Level0, 5-> Level1, 6-> Level2, 7-> Level3, -3-> Invalid, -2-> NotSet, -1-> Unknown |
load_taxonomy2 |
Optional[str]
|
String, the taxonomy of the load geo asset |
discharge_geo_id |
Optional[int]
|
Numeric ID corresponding to the id of the discharge geo asset |
discharge_name |
Optional[str]
|
String, name of the discharge geo asset |
discharge_taxonomy_id |
Optional[int]
|
1-> GeoAsset, 2-> Port, 3-> Country, 4-> Level0, 5-> Level1, 6-> Level2, 7-> Level3, -3-> Invalid, -2-> NotSet, -1-> Unknown |
discharge_taxonomy |
Optional[str]
|
String, the taxonomy of the discharge geo asset |
discharge_geo_id2 |
Optional[int]
|
Numeric ID corresponding to the id of the discharge geo |
discharge_name2 |
Optional[str]
|
String, name of the discharge geo asset |
discharge_taxonomy_id2 |
Optional[int]
|
1-> GeoAsset, 2-> Port, 3-> Country, 4-> Level0, 5-> Level1, 6-> Level2, 7-> Level3, -3-> Invalid, -2-> NotSet, -1-> Unknown |
discharge_taxonomy2 |
Optional[str]
|
String, the taxonomy of the discharge geo asset |
cargo_type_id |
Optional[int]
|
numeric ID corresponding to the type of cargo the vessel carries in this voyage. For example 19-> Crude Oil, 16->Fueloil, 9-> Naphtha, 135-> Unleaded Motor Spirit, 12-> Gasoil |
cargo_type |
Optional[str]
|
String, it corresponds to the estimated cargo type the vessel carries according to the specific voyage, AIS information, jetty the vessel may have visited or information coming from market reports. |
cargo_group_id |
Optional[int]
|
Numeric ID corresponding to the high-level cargo the vessel carries in this voyage, therefore called cargo group. For example 130000->Dirty, 120000-> Clean |
cargo_group |
Optional[str]
|
String, it corresponds to the estimated high-level cargo the vessel carries in this voyage, according to AIS information and jetties the vessel may have visited or information coming from market reports. |
quantity |
Optional[int]
|
Numeric, measured in kilotonnes [kt]. It is the cargo quantity reported in at least one of the market reports. |
quantity_buffer |
Optional[int]
|
Buffer on the agreed quantity. |
rate |
Optional[int]
|
Numeric, indicates the rate reported in at least one of the fixtures. If lump sum, the rate is reported in USD. |
rate_type |
Optional[str]
|
String, indicates the type of rate reported in at least one of the fixtures. Main types are "WS" for World Scale, "LS" for Lump Sum, "TCE" ($/day) for Time Charter Equivalent. |
ballast_bonus_value |
Optional[int]
|
Numeric, indicates the incentive or compensation paid to the ship owner for delivering the ship to the agreed delivery place. Derived from market info whenever available. |
ballast_bonus_type |
Optional[str]
|
String, indicates the currency of the ballast bonus, "$"(dollars). |
delivery_geo_id |
Optional[int]
|
Numeric ID corresponding to the id of the delivery geo asset |
delivery_name |
Optional[str]
|
String, name of the delivery geo asset |
delivery_taxonomy_id |
Optional[int]
|
1-> GeoAsset, 2-> Port, 3-> Country, 4-> Level0, 5-> Level1, 6-> Level2, 7-> Level3, -3-> Invalid, -2-> NotSet, -1-> Unknown |
delivery_taxonomy |
Optional[str]
|
String, the taxonomy of the delivery geo asset |
delivery_date_from |
Optional[datetime]
|
The start date of the delivery |
delivery_date_to |
Optional[datetime]
|
The end date of the delivery |
redelivery_from_geo_id |
Optional[int]
|
Numeric ID corresponding to the id of the redelivery from geo |
redelivery_from_name |
Optional[str]
|
String, name of the redelivery from geo asset |
redelivery_from_taxonomy_id |
Optional[int]
|
1-> GeoAsset, 2-> Port, 3-> Country, 4-> Level0, 5-> Level1, 6-> Level2, 7-> Level3, -3-> Invalid, -2-> NotSet, -1-> Unknown |
redelivery_from_taxonomy |
Optional[str]
|
String, the taxonomy of the redelivery from geo asset |
redelivery_to_geo_id |
Optional[int]
|
Numeric ID corresponding to the id of the redelivery to geo asset |
redelivery_to_name |
Optional[str]
|
String, name of the redelivery to geo asset |
redelivery_to_taxonomy_id |
Optional[int]
|
1-> GeoAsset, 2-> Port, 3-> Country, 4-> Level0, 5-> Level1, 6-> Level2, 7-> Level3, -3-> Invalid, -2-> NotSet, -1-> Unknown |
redelivery_to_taxonomy |
Optional[str]
|
String, the taxonomy of the redelivery to geo asset |
user_entries |
Optional[int]
|
The number of the user entries for the voyage |
full_fixtures |
Optional[int]
|
The number of full fixtures for the voyage |
partial_fixtures |
Optional[int]
|
The number of partial fixtures for the voyage |
is_coa |
Optional[bool]
|
Boolean. Value is true if "COA" (Contract of Affreightment) is explicitly reported in at least one of the fixtures relative to the specific voyage |
is_owners_option |
Optional[bool]
|
Boolean, indicating if owners option is agreed |
is_hold |
Optional[bool]
|
Boolean. Value is true if "Hold" is explicitly reported in at least one of the fixtures relative to the specific voyage |
is_fio |
Optional[bool]
|
Boolean, is free in and out. If true, charterer pays for loading and unloading |
sources |
Optional[Tuple[str, ...]]
|
A list of the sources |
Source code in signal_ocean/voyages_market_data/models.py
7 8 9 10 11 12 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 |
|
VoyagesMarketData
dataclass
¶
Contains information about a single fixture.
Attributes:
Name | Type | Description |
---|---|---|
id |
Optional[str]
|
String. Uniquely identifies the market data result. |
voyage_id |
Optional[str]
|
String. Uniquely identifies the voyage. |
imo |
Optional[int]
|
A seven-digits number that uniquely identifies a ship and does not change when the ship's owner, country of registry or name of the vessel changes. |
voyage_number |
Optional[int]
|
Numeric, a counter of the voyages for the same IMO. |
vessel_name |
Optional[str]
|
The vessel name corresponding to that IMO at the time of that voyage. |
vessel_type_id |
Optional[int]
|
0-> Empty, 1-> Tanker, 3-> Dry, 4-> Container, 5-> Lng, 6-> Lpg, -2-> NotSet, -1-> Unknown |
vessel_type |
Optional[str]
|
Description of the type of the vessel, based on the carried cargo. Main categories are Tankers, Dry (bulk carriers), Containers, LNG and LPG. |
vessel_class_id |
Optional[int]
|
60-> VLGCLpg, 61-> MidsizeLpg, 62-> HandyLpg, 63-> SmallLpg, 69-> VLOC, 70-> Capesize, 72-> PostPanamaxDry, 74-> PanamaxDry, 75-> Supramax, 76-> Handymax, 77-> Handysize, 78-> ULCV, 79-> NewPanamaxContainer, 80-> PostPanamaxContainer, 81-> PanamaxContainer, 82-> FeedermaxContainer, 83-> FeederContainer, 84-> VLCC, 85-> Suezmax, 86-> Aframax, 87-> PanamaxTanker, 88-> MR2, 89-> MR1, 90-> Small, 91-> LNGLng, 92-> SmallDry, 94-> ULCC, 95-> SmallContainer |
vessel_class |
Optional[str]
|
Name of the vessel class the vessel belongs to. Assignment of a vessel to a certain VesselClass is based on the VesselType and the value of its Deadweight (if Tanker or Dry), its LiquidCap (if LNG/LPG) or its TEU (if Containers). For example, an Aframax is a Tanker vessel with Deadweight within the range 82kt - 125kt, while a Capesize is a Dry vessel with Deadweight within the range 120kt-220kt. LR2 are defined as Aframax, as only Deadweight is used to define vessel classes. |
trade_id |
Optional[int]
|
1-> Crude, 2-> Product, 3-> Chemical, -2-> NotSet, -1-> Unknown |
trade |
Optional[str]
|
Additional attribute used to specify a Tanker vessel with finer granularity. It is derived by the last cargo carried by the vessel at the time of query. For example, an LR2 with fueloil as last cargo has VesselClass=Aframax and Trade=Product. |
commercial_operator_id |
Optional[int]
|
Numeric ID corresponding to the maritime company that manages the vessel commercially. |
commercial_operator |
Optional[str]
|
Name of the maritime company that manages the vessel commercially. |
deadweight |
Optional[int]
|
Numeric, measured in tonnes [t], often shortened as DWT, denotes the total carrying capacity of the vessel including cargo, ballast water, stores, provisions, crew and so on. |
year_built |
Optional[int]
|
Numeric, year format, the year the vessel was built. |
matched_fixture |
Optional[MatchedFixture]
|
Nested object containing additional information on the matched fixture. |
fixtures |
Optional[Tuple[Fixture, ...]]
|
Nested object containing information on fixtures for a given IMO and voyage. |
Source code in signal_ocean/voyages_market_data/models.py
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 |
|
VoyagesMarketDataPagedResponse
dataclass
¶
Paged response in nested format from the VoyagesMarketData API.
Attributes:
Name | Type | Description |
---|---|---|
next_page_token |
Optional[str]
|
String. The key that should be used as a parameter of the token to retrieve the next page. |
next_request_token |
Optional[str]
|
String. Populated on the last page of incremental results and should be used in the next incremental update request. |
data |
Optional[Tuple[VoyagesMarketData, ...]]
|
The structure that contains records retrieve for the current page. |
Source code in signal_ocean/voyages_market_data/models.py
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 |
|