Package Documentation¶
Scraped Cargoes API Package.
Classes:
Name | Description |
---|---|
ScrapedCargoesAPI |
Represents Signal's Scraped Cargoes API. |
ScrapedCargo |
Scraped Cargo. |
ScrapedCargo
dataclass
¶
Detailed information about a scraped cargo.
Attributes:
Name | Type | Description |
---|---|---|
cargo_id |
int
|
Integer. A unique identifier of the cargo line. |
message_id |
Optional[int]
|
Integer. A unique identifier of the message containing the specific cargo. A message can contain more than one cargo. |
external_message_id |
Optional[str]
|
String. It serves as a unique identifier for a message, supplied by any company that has integrated with Signal. |
parsed_part_id |
Optional[int]
|
Integer. A unique identifier for each email part. The email body and each attachment are considered different parsed parts. For an example the email body and its pdf attachment have same MessageID and different ParsedPartID. |
line_from |
Optional[int]
|
Nullable integer. The starting line from which the cargo is extracted. The email subject counts as line 0 and the body content starts from line 1. |
line_to |
Optional[int]
|
Nullable integer. The final line from which the cargo is extracted. For single line cargoes LineFrom is equal to LineTo. For descriptive cargoes that span across multiple lines we have LineTo>LineFrom. These two numbers help the user identify which part of the text has been used to extract the cargo data. |
in_line_order |
Optional[int]
|
Nullable integer. This integer is used to list different cargoes extracted from the same line. It is the case for cargoes with different discharge options. A cargo with a discharge and an option like 'med-ukc' is interpreted in our system as 2 cargoes with same MessageID, same ParsedPartID, same LineNumber, different CargoID and an incremental InLineOrder number. |
source |
Optional[str]
|
String. It describes the source of the information. Our system allows the user to inject data in many different ways, namely through email (Source='Email'), through Slack channels (Source='Slack') or through manual contributions directly from our frontend platform TSOP (Source='User'). |
updated_date |
Optional[datetime]
|
String, format YYYY-MM-DD HH:MM:SS, UTC timezone. Date on which the cargo has been reevaluated for the last time. In case of an email received by a broker one month ago and reprocessed through our engine today, this date will be today's. |
received_date |
Optional[datetime]
|
String, format YYYY-MM-DD HH:MM:SS, UTC timezone. Date on which the cargo has been injected into our system and processed. |
is_deleted |
Optional[bool]
|
Boolean. This value is true if the cargo is marked as Deleted. |
low_confidence |
Optional[bool]
|
Boolean. This value is true when the data extraction process does not return as output some fields that we believe to be more important than others in business terms. These fields are called critical fields. The value is true if at least one of the critical fields is missing.For example missing charterer or laycan. |
scraped_laycan |
Optional[str]
|
String. The laycan (latest day of cancellation) of the cargo as reported in the original text. It if often reported as a date range, e.g. '25-jan 27-jan', '31-1 feb', '11-12 apr'. The string 'dnr' (date not reported) can also be found. |
laycan_from |
Optional[datetime]
|
Date, format YYYY-MM-DD. The mapped date corresponding to the beginning of the laycan date range. |
laycan_to |
Optional[datetime]
|
Date, format YYYY-MM-DD. The mapped date corresponding to the end of the laycan date range. |
scraped_load |
Optional[str]
|
String. The loading location reported in the original text of the cargo. It is very often shortened, very compact and can refer to terminals, ports, countries or wider areas. Examples: 'singgi' for Singgi, 'rt' for Ras Tanura, 'waf' for West Africa. |
load_geo_id |
Optional[int]
|
Integer. It is the internal ID of the mapped loading location reported in the cargo. Our models convert and map a scraped string containing geo information to a specific entity of the Signal's proprietary geofencing structure. Each geo entity is identified by a taxonomy, an ID and a name. Examples: the string 'bonny' is mapped to a geo asset with name 'Bonny', ID 3679 and taxonomy Port (TaxonomyID=2); the string 'nigeria' is mapped to a geoasset with name 'Nigeria', ID 171 and taxonomy Country (TaxonomyID=3); the string 'wafr' is mapped to a geoasset with name 'Africa Atlantic Coast', ID 24772 and taxonomy Level0 (TaxonomyID=4). |
load_name |
Optional[str]
|
String. The name of the Signal geo entity related to the reported loading location of the cargo. Examples: 'Bonny', 'Nigeria', 'Africa Atlantic Coast', 'Arabian Gulf', 'Singapore', 'East Coast Mexico'. |
load_taxonomy_id |
Optional[int]
|
Integer. An internal ID corresponding to each taxonomy, the level of geo details, from 1 to 7. A terminal (geoasset) has the lowest taxonomy (TaxonomyID=1), a port has TaxonomyID=2, while countries and wider areas have higher taxonomy (TaxonomyID>=3). Examples of Level 0 areas (TaxonomyID=4) include 'Arabian Gulf', 'US Gulf' and 'East Mediterranean'. Level 1 areas (TaxonomyID=5) consist of multiple level 0 areas (TaxonomyID=4). For example, level 1 area 'Mediterranean' groups together the level 0 areas 'West Mediterranean', 'Central Mediterranean' and 'East Mediterranean'. Level 2 areas (TaxonomyID=6) consist of multiple level 1 areas (TaxonomyID=4). For example, level 2 area 'Mediterranean/UK Continent' groups together the 'Mediterranean' and 'UK Continent' level 1 areas. Level 3 areas (TaxonomyID=7) are the highest area grouping in our taxonomy and consist of multiple level 2 areas (TaxonomyID=6). Examples of such areas are 'Pacific America' or 'Africa'. These group together level 2 areas. For instance, 'Pacific America' groups together the level 2 areas 'West Coast North America', 'West Coast Mexico', 'West Coast Central America' and 'West Coast South America'. |
load_taxonomy |
Optional[str]
|
String. The extended name identifying the TaxonomyID. Possible values are: GeoAsset-> 1, Port -> 2, Country-> 3, Level0->4, Level1->5, Level2->6, Level3->7. |
scraped_load2 |
Optional[str]
|
String. The second loading location reported in the original text of the cargo. It is very often shortened, very compact and can refer to terminals, ports, countries or wider areas. Examples: 'singgi' for Singgi, 'rt' for Ras Tanura, 'waf' for West Africa. |
load_geo_id2 |
Optional[int]
|
Integer. An internal ID corresponding to the mapped second loading location of the cargo. See LoadGeoID for more details. |
load_name2 |
Optional[str]
|
String. The name of the Signal geo entity related to the reported second loading location of the cargo. Examples: 'Bonny', 'Nigeria', 'Africa Atlantic Coast', 'Arabian Gulf', 'Singapore', 'East Coast Mexico'. |
load_taxonomy_id2 |
Optional[int]
|
Integer. An internal ID corresponding to the taxonomy of the mapped discharging location. See LoadTaxonomyID for more details. |
load_taxonomy2 |
Optional[str]
|
String. The extended name identifying the TaxonomyID. Possible values are: GeoAsset-> 1, Port -> 2, Country-> 3, Level0->4, Level1->5, Level2->6, Level3->7. |
scraped_discharge |
Optional[str]
|
String. The discharging port reported in the original text of the cargo. It is very often shortened, very compact and can refer to terminals, ports, countries or wider areas. For cargoes reporting multiple discharge options, this field contains only the first string. For example in the cargo 'mercuria 75 ulsd n. mangalore ukc-wafr-jpn 14/jan 2.425m-2.375m-ws125' the field ScrapedDischarge contains 'ukc' only. |
scraped_discharge_options |
Optional[str]
|
String. All the discharging options reported in the original text of the cargo. For example in the cargo 'minerva aries subs mercuria 75 ulsd n. mangalore ukc-wafr-jpn 14/jan 2.425m-2.375m-ws125' the field ScrapedDischargeOptions contains 'wafr-jpn'. |
discharge_geo_id |
Optional[int]
|
Integer. An internal ID corresponding to the mapped discharging location of the cargo. See LoadGeoID for more details. |
discharge_name |
Optional[str]
|
String. The name of the Signal geo entity related to the discharging location of the cargo. Examples: 'Indonesia', 'Japan', 'Argentina'. |
discharge_taxonomy_id |
Optional[int]
|
Integer. An internal ID corresponding to the taxonomy of the mapped discharging location. See LoadTaxonomyID for more details. |
discharge_taxonomy |
Optional[str]
|
String. The extended name identifying the taxonomy of the mapped discharging location. Possible values are: GeoAsset-> 1, Port -> 2, Country-> 3, Level0->4, Level1->5, Level2->6, Level3->7. |
scraped_discharge2 |
Optional[str]
|
String. The second discharging port reported in the original text of the cargo. It is very often shortened, very compact and can refer to terminals, ports, countries or wider areas. For example in the cargo 'al agaila 130 gabon+algeria/ feast 14/01 rnr lord energy' the field ScrapedDischarge2 contains 'algeria'. |
discharge_geo_id2 |
Optional[int]
|
Integer. An internal ID corresponding to the mapped second discharging location of the cargo. See LoadGeoID for more details. |
discharge_name2 |
Optional[str]
|
String. The name of the Signal geo entity related to the second discharging location of the cargo. Examples: 'Algeria', 'Greece', 'France'. |
discharge_taxonomy_id2 |
Optional[int]
|
Integer. An internal ID corresponding to the taxonomy of the mapped second discharging location. See LoadTaxonomyID for more details. |
discharge_taxonomy2 |
Optional[str]
|
String. The extended name identifying the TaxonomyID. Possible values are: GeoAsset-> 1, Port -> 2, Country-> 3, Level0->4, Level1->5, Level2->6, Level3->7. |
scraped_charterer |
Optional[str]
|
String. The cargo charterer as reported in the original text. Examples: 'atc', 'unipec', 'enoc', 'ioc', 'pbras' |
charterer_id |
Optional[int]
|
Integer. Numeric ID corresponding to the chartering company that it is reported in the line. We use an internal mapper to find the correspondence between the reported string and our database. |
charterer |
Optional[str]
|
String. The company name corresponding to the ChartererID field. Provided to better specify the company involved in the business. Source: our internal Company Database. |
scraped_cargo_type |
Optional[str]
|
String. The cargo type of the cargo as reported in the original text, often shortened. Examples: 'nhc', 'ulsd', 'ums', 'nap', 'go'. |
cargo_type_id |
Optional[int]
|
Integer. It is an internal ID corresponding to the mapped cargo type of the cargo. A proprietary model is responsible to match the reported cargo string to a specific cargo type in our hierarchy. Examples: 19-> Crude Oil, 16->Fueloil, 9-> Naphtha, 135-> Unleaded Motor Spirit, 12-> Gasoil, 60-> 'Ultra Low Sulphur Diesel (ULSD 10ppm)'. |
cargo_type |
Optional[str]
|
String. The extended name corresponding to the CargoTypeID field. Source: our internal CargoTypes database. |
cargo_type_group_id |
Optional[int]
|
Integer. Numeric ID corresponding to the high-level cargo type of the reported cargo type. It is provided to group cargoes and facilitate analytics. Examples: 130000->Dirty, 120000-> Clean, 110000->IMO. |
cargo_type_group |
Optional[str]
|
String. The extended name corresponding to the CargoGroupID field. Source: our internal CargoTypes database. |
scraped_quantity |
Optional[str]
|
String. The cargo quantity as reported in the original text, including ranges and buffer. Also, it's common to report the required vessel class which indicates the size of suitable vessels. Examples: '80', '75000/10', '270', '180/10', 'VLCC', 'Kmx/Ppmx'. |
quantity |
Optional[float]
|
Numeric. The mapped quantity measured in tonnes [t]. Quantity would be equal to '180000', both for ScrapedQuantity '180/10' and '180000/5'. |
quantity_buffer |
Optional[float]
|
Numeric. The quantity buffer if reported in the cargo line, expressed as a fraction of 1. Examples: for ScrapedQuantity='75/10', QuantityBuffer=0.1. For ScrapedQuantity='180000/5', QuantityBuffer=0.05. |
quantity_from |
Optional[float]
|
Numeric. The lower limit of the quantity range measured in tonnes [t], computed as QuantityFrom=(1-QuantityBuffer)*Quantity. Examples: for ScrapedQuantity='170/10', QuantityFrom=153000. For ScrapedQuantity='150000/10', QuantityFrom=135000. If QuantityBuffer=-0, we have Quantity=QuantityFrom=QuantityTo. |
quantity_to |
Optional[float]
|
Numeric. The upper limit of the quantity range measured in tonnes [t], computed as QuantityFrom=(1+QuantityBuffer)*Quantity. Examples: for ScrapedQuantity='170/10', QuantityFrom=187000. For ScrapedQuantity='150000/10', QuantityFrom=165000. If QuantityBuffer=-0, we have Quantity=QuantityFrom=QuantityTo. |
size_from |
Optional[float]
|
Numeric. The lower limit of the size range measured in tonnes [t]. Examples: for ScrapedQuantity='VLCC', SizeFrom=200000. For ScrapedQuantity='Kmx/Ppmx', SizeFrom=80000. |
size_to |
Optional[float]
|
Numeric. The upper limit of the size range measured in tonnes [t]. Examples: for ScrapedQuantity='VLCC', SizeTo=350000. For ScrapedQuantity='Kmx/Ppmx', SizeTo=110000. |
scraped_delivery_date |
Optional[str]
|
String. The delivery date of the time charter cargo as reported in the original text. It if often reported as a date range, e.g. '16/18 Nov', '17/19'. |
delivery_date_from |
Optional[datetime]
|
Date, format YYYY-MM-DD. The mapped date corresponding to the beginning of the delivery date range. |
delivery_date_to |
Optional[datetime]
|
Date, format YYYY-MM-DD. The mapped date corresponding to the end of the delivery date range. |
scraped_delivery_from |
Optional[str]
|
String. The delivery location reported in the original text of the cargo. Very common in the case of time charter cargoes. If the delivery is reported as a geographical range, this field contains the first string. Otherwise the only delivery location reported. Example: In a dry cargo like ''Acct IVS Supramax/ultramax Del South Africa/West Africa 1 tct to Cont 10 March onw 3.75 adcom pus' we have ScrapedRedeliveryFrom = 'South Africa' and ScrapedRedeliveryTo = 'West Africa'. For the cargo ''Nova Marine Carriers SA 25/32k dwt Dely W Med 29/31 March Redely UK 3,75 adc pus' we have ScrapedRedeliveryFrom = 'W Med'. |
delivery_from_geo_id |
Optional[int]
|
Integer. An internal ID corresponding to the mapped delivery location of the cargo. See LoadGeoID for more details. |
delivery_from_name |
Optional[str]
|
String. The name of the Signal geo entity related to the delivery location of the cargo. Examples: 'E.Med' matches to 'East Mediterranean' (DeliveryFromGeoID=24737, DeliveryFromTaxonomyID=4, DeliveryFromTaxonomy='Level0'); 'PDM' matches to 'Ponta Da Madeira' (DeliveryFromGeoID=13013, DeliveryFromTaxonomyID=2, DeliveryFromTaxonomy='Port'). |
delivery_from_taxonomy_id |
Optional[int]
|
Integer. An internal ID corresponding to the taxonomy of the mapped delivery to location. See LoadTaxonomyID for more details. |
delivery_from_taxonomy |
Optional[str]
|
String. The extended name identifying the taxonomy of the mapped delivery location. Possible values are: GeoAsset-> 1, Port -> 2, Country-> 3, Level0->4, Level1->5, Level2->6, Level3->7. |
scraped_delivery_to |
Optional[str]
|
String. If the delivery is reported as a geographical range, this field contains the end of the range as reported in the original text of the cargo. Example: In a dry cargo like ''Acct IVS Supramax/ultramax Del South Africa/West Africa 1 tct to Cont 10 March onw 3.75 adcom pus' we have ScrapedDeliveryTo = 'West Africa'. |
delivery_to_geo_id |
Optional[int]
|
Integer. An internal ID corresponding to the mapped delivery location of the cargo. See LoadGeoID for more details. |
delivery_to_name |
Optional[str]
|
String. The name of the Signal geo entity related to the delivery location of the cargo. Example: 'West Africa' matches to 'West Africa' (DeliveryToGeoID=37, DeliveryToTaxonomyID=5, DeliveryToTaxonomy='Level1') |
delivery_to_taxonomy_id |
Optional[int]
|
Integer. An internal ID corresponding to the taxonomy of the mapped delivery to location. See LoadTaxonomyID for more details. |
delivery_to_taxonomy |
Optional[str]
|
String. The extended name identifying the taxonomy of the mapped delivery location. Possible values are: GeoAsset-> 1, Port -> 2, Country-> 3, Level0->4, Level1->5, Level2->6, Level3->7. |
scraped_redelivery_from |
Optional[str]
|
String. The redelivery location reported in the original text of the cargo. Very common in the case of time charter cargoes. If the redelivery is reported as a geographical range, this field contains the first string. Otherwise the only delivery location reported. Example: In a dry cargo like ''dely Corpus Christi 6/10 Oct trip via US Gulf redel Skaw-Gibraltar $35,000 + $800,000 bb - XO Shipping' we have ScrapedRedeliveryFrom = 'Skaw' and ScrapedRedeliveryTo = 'Gibraltar'. For the cargo ''dely Belawan 20/21 Sep trip via Indonesia redel N China $39,000 - cnr' we have ScrapedRedeliveryFrom = 'N China'." |
redelivery_from_geo_id |
Optional[int]
|
Integer. An internal ID corresponding to the mapped redelivery location of the cargo. See LoadGeoID for more details. |
redelivery_from_name |
Optional[str]
|
String. The name of the Signal geo entity related to the redelivery location of the cargo. Example: 'N China' matches to 'North China' (RedeliveryFromGeoID=24666, DeliveryTaxonomyID=4, DeliveryTaxonomy='Level0'). |
redelivery_from_taxonomy_id |
Optional[int]
|
Integer. An internal ID corresponding to the taxonomy of the mapped redelivery location. Values from 1 to 7. See LoadTaxonomyID for more details. |
redelivery_from_taxonomy |
Optional[str]
|
String. The extended name identifying the taxonomy of the mapped redelivery location. Possible values are: GeoAsset-> 1, Port -> 2, Country-> 3, Level0->4, Level1->5, Level2->6, Level3->7. |
scraped_redelivery_to |
Optional[str]
|
String. If the redelivery is reported as a geographical range, this field contains the end of the range as reported in the original text of the cargo. Example: In a dry cargo like ''dely Corpus Christi 6/10 Oct trip via US Gulf redel Skaw-Gibraltar $35,000 + $800,000 bb - XO Shipping' we have ScrapedRedeliveryTo = 'Gibraltar'. |
redelivery_to_geo_id |
Optional[int]
|
Integer. An internal ID corresponding to the mapped redelivery location of the cargo. See LoadGeoID for more details. |
redelivery_to_name |
Optional[str]
|
String. The name of the Signal geo entity related to the redelivery location of the cargo. Example: 'Gibraltar' matches to 'Gibraltar' (RedeliveryToGeoID=7345, DeliveryTaxonomyID=2, DeliveryTaxonomy='Port'). |
redelivery_to_taxonomy_id |
Optional[int]
|
Integer. An internal ID corresponding to the taxonomy of the mapped redelivery location. Values from 1 to 7. See LoadTaxonomyID for more details. |
redelivery_to_taxonomy |
Optional[str]
|
String. The name of the Signal geo entity related to the redelivery location of the cargo. Example: 'Gibraltar' matches to 'Gibraltar' (RedeliveryToGeoID=7345, DeliveryTaxonomyID=2, DeliveryTaxonomy='Port'). |
charter_type_id |
Optional[int]
|
Integer. An internal ID to distinguish cargoes reporting voyage charter and time charter agreements. Possible values are 0 and 1. |
charter_type |
Optional[str]
|
String. The extended name of the type of shipping contract reported in the cargo. Values currently supported are 'Voyage'->0, 'Time charter'->1. |
cargo_status_id |
Optional[int]
|
Numeric ID corresponding to the different values of the CargoStatus field. 0-> OnSubs, 1-> FullyFixed, 2 -> Failed, 3 ->Cancelled , 4-> Available, -2 -> NotSet, -1 -> Unknown. |
cargo_status |
Optional[str]
|
String denoting the commercial status of a cargo if explicitly mentioned, like 'ffxd' for fully fixed or 'subs'/'-s-' for on subs. |
content |
Optional[str]
|
String. The full content of the cargo. For a single line cargo it is the line content. For multi line cargoes it is the collection of all the relevant parts of the text. |
subject |
Optional[str]
|
String. The email subject of the cargo. This field has content when Source="Email". |
sender |
Optional[str]
|
String. Our own mapping of the shipping company sending out the market report through email. This string helps grouping emails sent by the same organization, but from different domains. It is often the case for big organizations operating worldwide. For example Sender= 'SSY' for both domains 'ssysin.com' and 'ssy.co'. |
is_private |
Optional[bool]
|
Boolean. A cargo is private if injected by a user into his own private account within TSOP. A user can provide private information through email forwarding, through manual contributions or through Slack. Private cargo information stay in the account, are accessible by the account users only (people within the same company) and are the most valuable ones. |
Source code in signal_ocean/scraped_cargoes/models.py
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 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 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 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 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 |
|
ScrapedCargoesAPI
¶
Bases: ScrapedDataAPI[ScrapedCargoesResponse, ScrapedCargo]
Represents Signal's Scraped Cargoes API.
Source code in signal_ocean/scraped_cargoes/scraped_cargoes_api.py
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 |
|
get_cargoes(vessel_type, cargo_ids=None, message_ids=None, external_message_ids=None, received_date_from=None, received_date_to=None, updated_date_from=None, updated_date_to=None, include_details=True, include_scraped_fields=True, include_labels=True, include_content=True, include_sender=True, include_debug_info=True)
¶
This function collects and returns the cargoes by the given filters.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
vessel_type |
int
|
Format - int32. Available values Tanker = 1, Dry = 3, Container = 4, Lng = 5, Lpg = 6 |
required |
cargo_ids |
Optional[List[int]]
|
List - Comma separated list of CargoIDs |
None
|
message_ids |
Optional[List[int]]
|
List - Comma separated list of MessageIDs |
None
|
external_message_ids |
Optional[List[str]]
|
List - Comma separated list of ExternalMessageIDs |
None
|
received_date_from |
Optional[datetime]
|
Format - date-time (as date-time in RFC3339). Earliest date the cargo received. Cannot be combined with 'Updated' dates |
None
|
received_date_to |
Optional[datetime]
|
Format - date-time (as date-time in RFC3339). Latest date the cargo received. Cannot be combined with 'Updated' dates |
None
|
updated_date_from |
Optional[datetime]
|
Format - date-time (as date-time in RFC3339). Earliest date the cargo updated. Cannot be combined with 'Received' dates |
None
|
updated_date_to |
Optional[datetime]
|
Format - date-time (as date-time in RFC3339). Latest date the cargo updated. Cannot be combined with 'Received' dates |
None
|
include_details |
Optional[bool]
|
Boolean - Whether to include additional cargo details in the response. |
True
|
include_scraped_fields |
Optional[bool]
|
Boolean - Whether to include the relative scraped fields in the response. |
True
|
include_labels |
Optional[bool]
|
Boolean - Whether to include the relative labels in the response. |
True
|
include_content |
Optional[bool]
|
Boolean - Whether to include the original message line (untouched) in the response. |
True
|
include_sender |
Optional[bool]
|
Boolean - Whether to include some of the message sender details in the response. |
True
|
include_debug_info |
Optional[bool]
|
Boolean - Whether to include some information about the distribution of the cargo in the response. |
True
|
Returns:
Type | Description |
---|---|
ScrapedCargo
|
An Iterable of ScrapedCargo objects, as we have defined in |
...
|
models.py Python file. |
Source code in signal_ocean/scraped_cargoes/scraped_cargoes_api.py
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 |
|
get_cargoes_incremental(vessel_type, page_token=None, include_details=True, include_scraped_fields=True, include_labels=True, include_content=True, include_sender=True, include_debug_info=True)
¶
This function collects and returns cargoes.
Specifically, all the cargoes updated after the given page token. If page token is nullable, function will return all cargoes.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
vessel_type |
int
|
Format - int32. Available values Tanker = 1, Dry = 3, Container = 4, Lng = 5, Lpg = 6 |
required |
page_token |
Optional[str]
|
String. The key that should be used as a parameter of the token to retrieve the relevant page. |
None
|
include_details |
Optional[bool]
|
Boolean - Whether to include additional cargo details in the response. |
True
|
include_scraped_fields |
Optional[bool]
|
Boolean - Whether to include the relative scraped fields in the response. |
True
|
include_labels |
Optional[bool]
|
Boolean - Whether to include the relative labels in the response. |
True
|
include_content |
Optional[bool]
|
Boolean - Whether to include the original message line (untouched) in the response. |
True
|
include_sender |
Optional[bool]
|
Boolean - Whether to include some of the message sender details in the response. |
True
|
include_debug_info |
Optional[bool]
|
Boolean - Whether to include some information about the distribution of the cargo in the response. |
True
|
Returns:
Type | Description |
---|---|
IncrementalDataResponse[ScrapedCargo]
|
A dictionary containing a tuple of ScrapedCargo objects and |
IncrementalDataResponse[ScrapedCargo]
|
NextRequestToken. |
IncrementalDataResponse[ScrapedCargo]
|
ScrapedCargo object is defined in models.py Python file. |
IncrementalDataResponse[ScrapedCargo]
|
Next Request Token is used as page_token. |
Source code in signal_ocean/scraped_cargoes/scraped_cargoes_api.py
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 |
|
get_cargoes_incremental_token(updated_date_from)
¶
This function returns a token to use in the incremental cargoes endpoint.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
updated_date_from |
datetime
|
Format - date-time (as date-time in RFC3339). Earliest date the cargo updated. Cannot be combined with 'Received' dates |
required |
Returns:
Type | Description |
---|---|
Optional[str]
|
A string containing the corresponding page token to |
Optional[str]
|
the provided datetime input. |
Source code in signal_ocean/scraped_cargoes/scraped_cargoes_api.py
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 |
|