sort parameter to the voyages end-point.with_all_direct parameter from the sailings end-point. These results are now always included.terminals as firms (where available).code attribute is no longer included in terminals (previously it was included as null).with_all_direct parameter to the sailings end-point.has_schedules parameter to the carriers end-point.calls to portcallstrips to sailingsschedules to voyagesThe old end-point names can still be used but will be removed in a future version.
with_distances to the /trips end-point.route_id to the /schedules end-point.voyage to the /calls end-point.voyage to the /schedules end-point./portpairs end-point.with_alias_ports to the /trips end-point.in_schedules to the /ports end-point.routes_id and routes_code to the /calls end-point.notice is now returned from the /carriers end-point. This attribute is present if there is a notice for the carrier./routes and /tracking.kind of a carrier is now returned from the /carriers end-point and a new carrier_kinds parameter can be specified with the /calls, /schedules and /trips end-points to limit results to carriers of the specified kinds.terminals are returned from an end-point they now also include the SMDG code as a new code attribute. This will be null if not available.port_registry attribute returned by the /vessels end-point now contains the port LOCODE rather the name.smdg (SMDG Liner code) and bic (BIC code) are now returned from the /carriers end-point.This version of the API adds an additional with_terms parameter to the following API end-points:
/ports/calls/schedules/tripsIf this parameter is set to 1, then the response will contain an additional terminals attribute for any returned ports. The value of the attribute is a list of the names of the terminals at the port that the vessel is expected to call at. This will be an empty list if this information is not currently available.
Additionally the /trips end-point now supports two new parameters (with_nearby_origins and with_nearby_destinations). When set to 1 these indicate that ports that are nearby to those specified should also be included in searches.
There are no breaking changes in this version of the API. All existing code will continue to work unchanged.
This version of the API adds additional parameters to several API end-points which allows vessels, ports and carriers to be specified using IMO, LOCODE and SCAC values rather than Linescape IDs.
Any end-point that previously accepted a parameter ending _id to specify a vessel, port or carrier will now also support a parameter with the same name but ending with either _imo, _code or _scac respectively.
This also applies to the carriers and carriers.ne parameters which gain carriers_scac and carriers_scac.ne variants. For consistency, the carriers and carriers.ne parameters have been renamed to carriers_id and carriers_id.ne althought the original version will continue to be accepted.
Additionally this version of the API adds ETA/ETD times to the results returned by the /calls end-point and the ability to sort the results returned by the /vessels end-point.
A new /usage end-point has also been added which can be used to return the remaining quota of API calls available.
There are no breaking changes in this version of the API. All existing code will continue to work unchanged.
New port_code parameter: This works the same as port_id but requires a port LOCODE rather than an ID.
New vessel_imo parameter: This works the same as vessel_id but requires a vessel IMO rather than an ID.
New carriers_scac parameter: This works the same as carriers but requires a list of SCAC codes rather than IDs.
New carriers_scac.ne parameter: This works the same as carriers.ne but requires a list of SCAC codes rather than IDs.
New carriers_id parameter: This is an alias for carriers added for naming consistency.
New carriers_id.ne parameter: This is an alias for carriers.ne added for naming consistency.
New eta_time and etd_time attributes returned in items: These give the ETA/ETD times (e.g. "eta_time": "09:21") for each port call. They will be set to null if not available.
carrier_scac parameter: This works the same as carrier_id but requires a SCAC code rather than an ID.New carrier_scac parameter: This works the same as carrier_id but requires a SCAC code rather than an ID.
New sort parameter: Enables the results to be sorted by vessel name and/or carrier.
vessel_imo parameter: This works the same as vessel_id but requires a vessel IMO rather than an ID.carrier_scac parameter: This works the same as carrier_id but requires a SCAC code rather than an ID.start_port_code parameter: This works the same as start_port_id but requires a port LOCODE rather than an ID.end_port_code parameter: This works the same as end_port_id but requires a port LOCODE rather than an ID.New origins_code parameter: This works the same as origin_ids but requires a list of port LOCODEs rather than IDs.
New destinations_code parameter: This works the same as destination_ids but requires a list of port LOCODEs rather than IDs.
New carriers_scac parameter: This works the same as carriers but requires a list of SCAC codes rather than IDs.
New carriers_scac.ne parameter: This works the same as carriers.ne but requires a list of SCAC codes rather than IDs.
New carriers_id parameter: This is an alias for carriers added for naming consistency.
New carriers_id.ne parameter: This is an alias for carriers.ne added for naming consistency.
New origins_id parameter: This is an alias for origin_ids added for naming consistency.
New destinations_id parameter: This is an alias for destination_ids added for naming consistency.
New end-point added.