Passages
List Passages
List sailing passages between locations
Endpoint
Description
List sailing passages (routes between two locations) with optional filtering by location and difficulty. Each passage includes distance, difficulty rating, and departure/arrival location details.
Authentication
No authentication required for server-side requests — this is a public read endpoint. (A key is only needed for cross-origin calls made from a browser on another domain; see Authentication.)
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
location_id | number | No | Filter passages that start or end at this location |
difficulty | string | No | Filter by difficulty level |
sort | string | No | Sort order: distance (default), rating, or variants |
limit | number | No | Max results (default: 50, max: 100) |
offset | number | No | Pagination offset (default: 0) |
Example Request
Example Response
Response Fields
| Field | Type | Description |
|---|---|---|
id | string | Route ID (UUID) |
from_location_id / to_location_id | number | Departure / arrival location IDs |
slug | string | URL-friendly slug |
title | string | Route title |
description | string|null | Route description |
distance_nm | number|null | Distance in nautical miles |
difficulty | string|null | Difficulty level |
typical_duration_hours | number|null | Estimated sailing time in hours |
rating | number|null | Average rating |
rating_count | number | Number of ratings (0 when none) |
variant_count | number|null | Number of route variants |
geojson | object|null | Route geometry as a GeoJSON Feature (geometry LineString + properties with distance_nm, waypoints, etc.) |
created_at / updated_at | string | Row timestamps |
from_location | object | Departure location (id, name, country_code, lat, lon) |
to_location | object | Arrival location (same shape) |
In the list endpoint the embedded from_location / to_location carry only id, name, country_code, lat, and lon (no country, image_url, or harbour_category — those appear in Get Passage). country_code is lowercase.
Sort Options
| Value | Description |
|---|---|
distance | Shortest passages first (default) |
rating | Highest rated first |
variants | Most route variants first |