Locations
List Locations
Search locations with boat counts and geographic aggregation
Endpoint
Description
Search and list locations with boat and POI counts. Returns both individual locations (marinas, anchorages) and aggregated geographic results (cities, states, countries) when a search query matches higher-level regions.
Results are cached for 5 minutes.
Authentication
No authentication required. This is a public endpoint.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
q | string | No | Search query |
limit | number | No | Max results (default: 20, max: 200) |
ids | string | No | Comma-separated location IDs to fetch directly |
Example Requests
Search by Name
Fetch by IDs
Example Response (Search)
Example Response (IDs)
Response Fields (Search)
| Field | Type | Description |
|---|---|---|
id | number|string | Location ID (number) or aggregate key (e.g. country:GR) |
type | string | Result type: marina, city, municipality, state, or country |
name | string | Location or region name |
lat | number | Latitude (center point for aggregates) |
lon | number | Longitude (center point for aggregates) |
city | string|null | City name |
state | string|null | State or region |
country | string|null | Country name |
country_code | string|null | ISO country code |
location | string | Formatted location string |
boat_count | number | Number of available boats |
poi_count | number | Number of points of interest |
harbour_category | string|null | Type of harbour (marina type only) |
location_count | number | Number of locations in this region (aggregate types only) |
Sorting
Results are sorted by:
- Locations with boats first
- Aggregate types first (country, state, municipality, city, marina)
- Boat count descending