Ocean
Ocean Metrics Locations
This endpoint allows permissioned users to get all available ocean route locations that can be origins and/or destinations to request data on ocean lanes.
For more information about getting access to this endpoint or using this endpoint, please reach out to our Customer Success team (cs@gosonar.com).
Returns a collection of all supported ocean route origin/destination locations including specific ports, all ports in a given country or even all ports worldwide.
Here are the output fields returned in a successful call:
- code: a unique code to identify any ocean data location
- port: a unique code to identify a specific port, when the location type is port, this will be the same as the code
- port_name: a human readable port name
- country: the country for the location
- type: the type of location, may be Port, Country or AllPorts
Any returned code, including ALL, may be used as the origin and/or the destination on every ocean metrics endpoint.
get/Ocean/locations
Request
- Base URLhttps://api.freightwaves.com (the document declares no server; this is the origin it was published from)
- Authnone declared
Headers
x-api-versionstring
Response
OK
Example response
[
{
"code": "USSAV",
"port": "USSAV",
"port_name": "Savannah",
"country": "United States of America",
"type": "Port"
}
]Changes
No recorded changes to this operation across all 5 revisions of this API.