get https://api.searoutes.com/itinerary/v2/proformas/
This endpoint retrieves detailed itinerary information for a specific route, identified by its unique hash.
Itinerary hashes are generated and returned in the /co2/v2/plan response, allowing users to request detailed routing information for a given carrier and port pair.
The response provides:
- Itinerary-level details (duration, distance, COโe emissions).
- Leg-specific details (departure and arrival days, port of calls, service ID).
- Route geometry (LineString in GeoJSON format).
Response
The response is a GeoJSON FeatureCollection, where:
- Each
Featurerepresents a leg of the itinerary. Propertiescontain key details such as transit time, COโ emissions, and ports of call.Geometryprovides the route geometry as aLineStringin GeoJSON format.
| Field | Description |
|---|---|
duration.days | Estimated transit time in days, including transhipments and waiting time in ports. |
duration.ms | Estimated transit time in milliseconds. |
departure.dayNumber | Represents the starting reference day of the journey. |
arrival.dayNumber | Represents the arrival day relative to the departure day. |
from.locode | Departure port UN/LOCODE. |
from.name | Departure port name. |
to.locode | Arrival port UN/LOCODE. |
to.name | Arrival port name. |
distance | Total itinerary distance (in meters). |
mode | Mode of transport ("SEA"). |
serviceId | Service ID associated with the leg. Retrievable with /search/v2/service/{id}. |
calls | List of intermediate port calls. |
co2e | Estimated COโ emissions for the itinerary (in grams), corresponding to the load characteristics passed as input when searching for the itinerary |
geometry | GeoJSON LineString representing the legโs route geometry. |
Notes & Considerations
- GeoJSON compliance: by default, the response includes a properties field at the FeatureCollection level. If full GeoJSON compliance is required, you should omit
propertiesfield. - Antimeridian crossing: if a LineString crosses the antimeridian (longitude ยฑ180ยฐ), the response may include longitude values greater than 180ยฐ or less than -180ยฐ. This behavior maintains continuity in a single LineString.
- Hashes are not intended to be persisted or used as permanent references.
Support endpoints and resources
- Get COโ-based itineraries: use our
/co2/v2/planendpoint to retrieve itinerary hashes and estimated emissions for a given carrier and port pair. - Learn about our methodology: visit the Methodology for sea emissions calculation page.