How to use the vortexasdk.utils.convert_to_list function in vortexasdk
To help you get started, we’ve selected a few vortexasdk examples, based on popular ways it is used in public projects.
Secure your code as it's written. Use Snyk Code to scan source code in minutes - no build needed - and fix issues immediately.
V0RT3X4 / python-sdk / vortexasdk / endpoints / vessel_movements.py View on Github 
```
| | start_timestamp | end_timestamp | vessel.imo | vessel.name | vessel.vessel_class | origin.location.country.label | origin.location.port.label | destination.location.country.label | destination.location.port.label | cargoes.0.quantity | cargoes.0.product.grade.label |
|---:|:-------------------------|:-------------------------|-------------:|:--------------|:----------------------|:--------------------------------|:-----------------------------|:-------------------------------------|:----------------------------------|---------------------:|:--------------------------------|
| 0 | 2017-09-30T15:30:27+0000 | 2017-10-03T01:46:06+0000 | 9.21091e+06 | ADEBOMI 3 | handysize | Netherlands | Rotterdam [NL] | Netherlands | Rotterdam [NL] | nan | nan |
| 1 | 2017-08-29T14:51:32+0000 | 2017-10-04T14:46:21+0000 | 9.64544e+06 | AEGEAN VISION | suezmax | Netherlands | Rotterdam [NL] | Singapore | Singapore [SG] | 852261 | High Sulphur |
[Vessel Movements Endpoint Further Documentation](https://docs.vortexa.com/reference/POST/vessel-movements/search)
"""
exclude_params = {
"filter_origins": convert_to_list(exclude_origins),
"filter_destinations": convert_to_list(exclude_destinations),
"filter_products": convert_to_list(exclude_products),
"filter_vessels": convert_to_list(exclude_vessels),
"filter_vessel_classes": convert_to_list(exclude_vessel_classes),
"filter_charterers": convert_to_list(exclude_charterers),
"filter_owners": convert_to_list(exclude_owners),
"filter_vessel_flags": convert_to_list(exclude_vessel_flags),
"filter_vessel_ice_class": convert_to_list(
exclude_vessel_ice_class
),
"filter_vessel_propulsion": convert_to_list(
exclude_vessel_propulsion
),
}
api_params = {
"filter_activity": filter_activity,
"filter_time_min": to_ISODate(filter_time_min),
"filter_time_max": to_ISODate(filter_time_max),),
"filter_vessel_propulsion": convert_to_list(
exclude_vessel_propulsion
),
}
api_params = {
"filter_activity": filter_activity,
"filter_time_min": to_ISODate(filter_time_min),
"filter_time_max": to_ISODate(filter_time_max),
"timeseries_activity_time_span_min": timeseries_activity_time_span_min,
"timeseries_activity_time_span_max": timeseries_activity_time_span_max,
"cm_unit": cm_unit,
"filter_charterers": convert_to_list(filter_charterers),
"filter_owners": convert_to_list(filter_owners),
"filter_products": convert_to_list(filter_products),
"filter_vessels": convert_to_list(filter_vessels),
"filter_destinations": convert_to_list(filter_destinations),
"filter_origins": convert_to_list(filter_origins),
"filter_storage_locations": convert_to_list(
filter_storage_locations
),
"filter_ship_to_ship_locations": convert_to_list(
filter_ship_to_ship_locations
),
"filter_waypoints": convert_to_list(filter_waypoints),
"filter_vessel_age_min": filter_vessel_age_min,
"filter_vessel_age_max": filter_vessel_age_max,
"filter_vessel_scrubbers": filter_vessel_scrubbers,
"filter_vessel_flags": convert_to_list(filter_vessel_flags),
"filter_vessel_ice_class": convert_to_list(
filter_vessel_ice_class| 4 | MINERVA MARINA | suezmax | COSGLORY LAKE | vlcc_plus | nan | nan | Crude | 405724 |
| 5 | MASAL | suezmax | EKTA | vlcc_plus | nan | nan | Crude | 997896 |
| 6 | ATHENIAN FREEDOM | vlcc_plus | nan | nan | nan | nan | Crude | 120812 |
[Cargo Movements Endpoint Further Documentation](https://docs.vortexa.com/reference/POST/cargo-movements/search)
"""
exclude_params = {
"filter_origins": convert_to_list(exclude_origins),
"filter_destinations": convert_to_list(exclude_destinations),
"filter_products": convert_to_list(exclude_products),
"filter_vessels": convert_to_list(exclude_vessels),
"filter_charterers": convert_to_list(exclude_charterers),
"filter_owners": convert_to_list(exclude_owners),
"filter_vessel_flags": convert_to_list(exclude_vessel_flags),
"filter_vessel_ice_class": convert_to_list(
exclude_vessel_ice_class
),
"filter_vessel_propulsion": convert_to_list(
exclude_vessel_propulsion
),
}
api_params = {
"filter_activity": filter_activity,
"filter_time_min": to_ISODate(filter_time_min),
"filter_time_max": to_ISODate(filter_time_max),
"timeseries_activity_time_span_min": timeseries_activity_time_span_min,
"timeseries_activity_time_span_max": timeseries_activity_time_span_max,
"cm_unit": cm_unit,
"filter_charterers": convert_to_list(filter_charterers),
"filter_owners": convert_to_list(filter_owners),),
}
api_params = {
"filter_activity": filter_activity,
"filter_time_min": to_ISODate(filter_time_min),
"filter_time_max": to_ISODate(filter_time_max),
"timeseries_activity_time_span_min": timeseries_activity_time_span_min,
"timeseries_activity_time_span_max": timeseries_activity_time_span_max,
"cm_unit": cm_unit,
"filter_charterers": convert_to_list(filter_charterers),
"filter_owners": convert_to_list(filter_owners),
"filter_products": convert_to_list(filter_products),
"filter_vessels": convert_to_list(filter_vessels),
"filter_destinations": convert_to_list(filter_destinations),
"filter_origins": convert_to_list(filter_origins),
"filter_storage_locations": convert_to_list(
filter_storage_locations
),
"filter_ship_to_ship_locations": convert_to_list(
filter_ship_to_ship_locations
),
"filter_waypoints": convert_to_list(filter_waypoints),
"filter_vessel_age_min": filter_vessel_age_min,
"filter_vessel_age_max": filter_vessel_age_max,
"filter_vessel_scrubbers": filter_vessel_scrubbers,
"filter_vessel_flags": convert_to_list(filter_vessel_flags),
"filter_vessel_ice_class": convert_to_list(
filter_vessel_ice_class
),
"filter_vessel_propulsion": convert_to_list(
filter_vessel_propulsion>>> from vortexasdk import Attributes
>>> df = Attributes().search(type="scrubber").to_df()
```
returns
| | id | name | type |
|---:|:-----------------|:-----------|:------------|
| 0 | 14c7b073809eb565 | Open Loop | scrubber |
| 1 | 478fca39000c49d6 | Unkown | scrubber |
"""
search_params = {
"term": [str(e) for e in convert_to_list(term)],
"ids": convert_to_list(ids),
"type": type,
}
return AttributeResult(super().search(**search_params))
- Let's find all the vessels currently carrying Crude.
```python
>>> from vortexasdk import Vessels, Products
>>> crude = [p.id for p in Products().search(term="crude").to_list() if 'group' in p.layer]
>>> vessels_df = Vessels().search(vessel_product_types=crude).to_df()
```
# Further Documentation
[VortexaAPI Vessel Reference](https://docs.vortexa.com/reference/POST/reference/vessels)
"""
search_params = {
"term": [str(e) for e in convert_to_list(term)],
"ids": convert_to_list(ids),
"vessel_product_types": convert_to_list(vessel_product_types),
"vessel_classes": [
v.lower() for v in (convert_to_list(vessel_classes))
],
}
return VesselsResult(super().search(**search_params))```python
>>> from vortexasdk import Attributes
>>> df = Attributes().search(type="scrubber").to_df()
```
returns
| | id | name | type |
|---:|:-----------------|:-----------|:------------|
| 0 | 14c7b073809eb565 | Open Loop | scrubber |
| 1 | 478fca39000c49d6 | Unkown | scrubber |
"""
search_params = {
"term": [str(e) for e in convert_to_list(term)],
"ids": convert_to_list(ids),
"type": type,
}
return AttributeResult(super().search(**search_params))
| | start_timestamp | end_timestamp | vessel.imo | vessel.name | vessel.vessel_class | origin.location.country.label | origin.location.port.label | destination.location.country.label | destination.location.port.label | cargoes.0.quantity | cargoes.0.product.grade.label |
|---:|:-------------------------|:-------------------------|-------------:|:--------------|:----------------------|:--------------------------------|:-----------------------------|:-------------------------------------|:----------------------------------|---------------------:|:--------------------------------|
| 0 | 2017-09-30T15:30:27+0000 | 2017-10-03T01:46:06+0000 | 9.21091e+06 | ADEBOMI 3 | handysize | Netherlands | Rotterdam [NL] | Netherlands | Rotterdam [NL] | nan | nan |
| 1 | 2017-08-29T14:51:32+0000 | 2017-10-04T14:46:21+0000 | 9.64544e+06 | AEGEAN VISION | suezmax | Netherlands | Rotterdam [NL] | Singapore | Singapore [SG] | 852261 | High Sulphur |
[Vessel Movements Endpoint Further Documentation](https://docs.vortexa.com/reference/POST/vessel-movements/search)
"""
exclude_params = {
"filter_origins": convert_to_list(exclude_origins),
"filter_destinations": convert_to_list(exclude_destinations),
"filter_products": convert_to_list(exclude_products),
"filter_vessels": convert_to_list(exclude_vessels),
"filter_vessel_classes": convert_to_list(exclude_vessel_classes),
"filter_charterers": convert_to_list(exclude_charterers),
"filter_owners": convert_to_list(exclude_owners),
"filter_vessel_flags": convert_to_list(exclude_vessel_flags),
"filter_vessel_ice_class": convert_to_list(
exclude_vessel_ice_class
),
"filter_vessel_propulsion": convert_to_list(
exclude_vessel_propulsion
),
}
api_params = {
"filter_activity": filter_activity,
"filter_time_min": to_ISODate(filter_time_min),
"filter_time_max": to_ISODate(filter_time_max),
"unit": unit,
"filter_charterers": convert_to_list(filter_charterers),
"filter_owners": convert_to_list(filter_owners),"filter_activity": filter_activity,
"filter_time_min": to_ISODate(filter_time_min),
"filter_time_max": to_ISODate(filter_time_max),
"timeseries_activity_time_span_min": timeseries_activity_time_span_min,
"timeseries_activity_time_span_max": timeseries_activity_time_span_max,
"cm_unit": cm_unit,
"filter_charterers": convert_to_list(filter_charterers),
"filter_owners": convert_to_list(filter_owners),
"filter_products": convert_to_list(filter_products),
"filter_vessels": convert_to_list(filter_vessels),
"filter_destinations": convert_to_list(filter_destinations),
"filter_origins": convert_to_list(filter_origins),
"filter_storage_locations": convert_to_list(
filter_storage_locations
),
"filter_ship_to_ship_locations": convert_to_list(
filter_ship_to_ship_locations
),
"filter_waypoints": convert_to_list(filter_waypoints),
"filter_vessel_age_min": filter_vessel_age_min,
"filter_vessel_age_max": filter_vessel_age_max,
"filter_vessel_scrubbers": filter_vessel_scrubbers,
"filter_vessel_flags": convert_to_list(filter_vessel_flags),
"filter_vessel_ice_class": convert_to_list(
filter_vessel_ice_class
),
"filter_vessel_propulsion": convert_to_list(
filter_vessel_propulsion
),
"exclude": exclude_params,
"disable_geographic_exclusion_rules": disable_geographic_exclusion_rules,
"size": self._MAX_PAGE_RESULT_SIZE,```python
>>> from vortexasdk import Vessels, Products
>>> crude = [p.id for p in Products().search(term="crude").to_list() if 'group' in p.layer]
>>> vessels_df = Vessels().search(vessel_product_types=crude).to_df()
```
# Further Documentation
[VortexaAPI Vessel Reference](https://docs.vortexa.com/reference/POST/reference/vessels)
"""
search_params = {
"term": [str(e) for e in convert_to_list(term)],
"ids": convert_to_list(ids),
"vessel_product_types": convert_to_list(vessel_product_types),
"vessel_classes": [
v.lower() for v in (convert_to_list(vessel_classes))
],
}
return VesselsResult(super().search(**search_params))
Popular vortexasdk functions
- vortexasdk.api.search_result.Result
- vortexasdk.api.serdes.FromDictMixin
- vortexasdk.client.create_client
- vortexasdk.client.set_client
- vortexasdk.conversions.convert_to_vessel_ids
- vortexasdk.endpoints.cargo_movements.CargoMovements
- vortexasdk.endpoints.cargo_timeseries.CargoTimeSeries
- vortexasdk.endpoints.products.Products
- vortexasdk.endpoints.vessels.Vessels
- vortexasdk.Geographies
- vortexasdk.logger.get_logger
- vortexasdk.operations.Reference
- vortexasdk.operations.Reference.__init__
- vortexasdk.operations.Search
- vortexasdk.operations.Search.__init__
- vortexasdk.result_conversions.create_dataframe
- vortexasdk.result_conversions.create_list
- vortexasdk.utils.convert_to_list
- vortexasdk.utils.convert_values_to_list
- vortexasdk.VesselMovements