Sign in
latestSwagger 2.02026-08-1274120326.8 KB

3a995f316cda

Ocean

Ocean Lane Locations

This endpoint allows permissioned users to discover which origin and destination combinations form valid ocean lanes with available data.

For more information about getting access to this endpoint or using this endpoint, please reach out to our Customer Success team (cs@gosonar.com).

Provide an `origin` to receive the destinations that pair with it in a lane. Provide a `destination` to receive the origins that pair with it. Omit both to receive all valid origin and destination codes.

Returns an object with two arrays:

  • origins: the set of origin locations matching the filter
  • destinations: the set of destination locations matching the filter

Each location in either array contains the same fields as the `/ocean/locations` endpoint (code, port, port_name, country, type).

get/Ocean/lane_locations

Query parameters

originstring

Optional origin location code — when provided, returns only destinations that form a valid lane with this origin

destinationstring

Optional destination location code — when provided, returns only origins that form a valid lane with this destination

Headers

x-api-versionstring

Response

OK

Example response

{
  "origins": [
    {
      "code": "USSAV",
      "port": "USSAV",
      "port_name": "Savannah",
      "country": "United States of America",
      "type": "Port"
    }
  ],
  "destinations": [
    {
      "code": "USSAV",
      "port": "USSAV",
      "port_name": "Savannah",
      "country": "United States of America",
      "type": "Port"
    }
  ]
}