Location codes
Regions and sea areas
Group locations and facilities by region and by the sea they are on, and filter by either.
Every location and facility is placed in wider areas, so you can group or filter without keeping lists of countries yourself:
- Regions are continents such as Europe, and parts of them such as Western Europe, by M49 code. A place is in its country's regions.
- Sea areas are seas such as the North Sea or the Persian Gulf, by S-23 code. A port or facility is in the sea area it is on, which a country's regions cannot tell you for a country on several seas.
Regions
Each region has a three-digit code. They nest up to three levels deep:
| Level | Example |
|---|---|
region | 150 Europe, 142 Asia, 019 Americas |
sub_region | 155 Western Europe, 030 Eastern Asia |
intermediate_region | 005 South America, within 419 Latin America and the Caribbean |
Locations and facilities carry their regions' codes in regions, broadest first:
{ "code": "NLRTM", "country": "NL", "regions": ["150", "155"] }List regions gives every region's name, level, parent and countries. regions is left out
for a place in no region: Antarctica, or XZ, the code for installations in international waters.
Sea areas
Each sea area has a code such as 4 for the North Sea or 41 for the Persian Gulf. Case matters: 28A is the Western
Basin of the Mediterranean, 28a the Strait of Gibraltar. List sea areas gives every
code and name.
Ports carry the sea area they are on in modalities.port.sea_area, and facilities in sea_area:
{ "code": "NLRTM", "modalities": { "port": { "sea_area": "4" } } }A port is on a sea area when it lies within the area, which reaches up estuaries, or within 25 km of it, as a port's position is often its town's. A port further inland, on a lake or far up a river, has none.
Smaller seas are areas of their own rather than parts of a larger one: a port on the Adriatic Sea has 28g, not a code
for the Mediterranean. To cover a whole sea, ask for each of its areas.
Filtering
Pass region to Search locations, Nearby locations,
Search facilities or Nearby facilities, at any level and
once per value. A place matches if it is in any of them:
curl "https://waykite.com/api/v1/locations/search?region=155®ion=154&function=port" \
-H "Authorization: Bearer $WAYKITE_API_KEY"Pass sea_area to the searches the same way, here for the Persian Gulf and the Gulf of Oman:
curl "https://waykite.com/api/v1/facilities/search?sea_area=41&sea_area=40&type=lng_terminal" \
-H "Authorization: Bearer $WAYKITE_API_KEY"With country too, a place has to match both.