API reference API Reference
Boataround allows searching boats, availabilities, prices with it's internal API. We have separated four main categories of endpoints - Availability, Boats, Prices and Search.
Token authorization
Specific endpoints require API token, what is non-public key to access and manipulate privileged data. For business usage, do not hesitate to contact our sales team at info@boataround.com, to provide you with useful information about our API usage.
Boat title
Every boat title is catenation of other boat attributes, strictly in following position - Boat manufacturer, boat model and boat name. Boat name is always preceded by pipe character |, to clearly identify difference between boat model and boat name.
Example: Typical boat title
"Bavaria 37 | Prima"
Boat attributes:
- Boat manufacturer - "Bavaria"
- Boat model - "37"
- Boat name - "Prima"
Boat slug
All boat slugs are url encoded titles, where spaces are replaces with minus character '-' and all spcial characters are removed.
Example: Manufacturer is Bavaria, Boat model is 47 and Boat name is Prima
title = "Bavaria 37 | Prima"
slug = "bavaria-37-prima"
It's possible to use functions like slugify to convert titles to slugs.
Example: slugify.js
function slugify(str){
if(typeof str != 'undefined'){
return str.toLowerCase()
.replace(/[^\w\s-]/g, '')
.replace(/[\s_-]+/g, '-')
.replace(/^-+|-+$/g, '');
}
else{ return '';}
}
Issue tracker
If you have any questions or problems to integrate our API with your service, please visit ours issue tracker https://github.com/Boataround/api-documentation/issues. We will try to solve your problem as soon as possible.
API Endpoint
https://api.boataround.com/v1/Contact: info@boataround.com
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: 1.0.719
Authentication
ApplicationAuth
Unique token is generated by Boataround application. To receive token, please contact sales team at at info@boataround.com.
type
apiKey
in
header
name
x-application-token
Availability
Methods provide access to reservation dates for every boat. Therefore with these methods you can access whether particular boat is already reserved or available for given timeframe. Availability is descibed with objects representing check-in and check-out dates for reservations of particular boat. The returned data represents when the boat is already reserved (unavailable).
By boat
/GET Method
Returns all availabilities for boat, which must be defined by it's slug. In case of success returns an array with single element containing availability information about selected boat.
Example: request
GET https://api.boataround.com/v1/availability/bavaria-37-prima
slug:
string
in path
Unique boat slug. Check Boat slug section for more details
Success
400 Bad Request
Invalid request, usually caused by invalid parameter values
500 Internal Server Error
Server error
Response Example (200 OK)
{
"data": [
{
"charter": "string",
"availabilities": [
{
"chin": "string (date)",
"chout": "string (date)"
}
],
"_id": "integer",
"title": "string",
"slug": "string",
"cabins": "integer",
"year": "integer",
"marina": "string"
}
],
"statusCode": "integer",
"status": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"errors": [
null
]
}
Response Example (500 Internal Server Error)
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
By boat
/GET Method
Returns all availabilities for boat, which must be defined by it's slug. In case of success returns an array with single element containing availability information about selected boat.
Example: request
GET https://api.boataround.com/v1/time-basedavailability/bavaria-37-prima
slug:
string
in path
Unique boat slug. Check Boat slug section for more details
Success
400 Bad Request
Invalid request, usually caused by invalid parameter values
500 Internal Server Error
Server error
Response Example (200 OK)
{
"data": [
{
"charter": "string",
"availabilities": [
{
"chin": "string (date)",
"chout": "string (date)"
}
],
"_id": "integer",
"title": "string",
"slug": "string",
"cabins": "integer",
"year": "integer",
"marina": "string"
}
],
"statusCode": "integer",
"status": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"errors": [
null
]
}
Response Example (500 Internal Server Error)
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
Search
Search functionality to get translated boat data with basic endpoint.
Search
Returns an array of available boats in selected range of dates(checkIn and checkOut). If checkIn or checkOut parameter is not defined, return boats with minimal price per day. We are limiting results to 18 per page.
checkIn:
string
(string)
in query
Start date, when order start. Format YYYY-MM-DD.
checkOut:
string
(string)
in query
End date, when order end. Format YYYY-MM-DD.
title:
string
(string)
in query
Title of boat. Title is constructed from Manufacturer, Model and Name of boat. E.g. Bavaria 33 | Maria.
category:
string
(string)
in query
Cateory of boat.
It's possible search by more manufacturers separated by comma (,)
| Value | Description |
|---|---|
| Sailing Yacht | Rerurn all Sailing Yachts |
| sailing-yacht | Rerurn all Sailing Yachts |
| Catamaran | Rerurn all Catamarans |
| catamaran | Rerurn all Catamarans |
| Motor Yacht | Rerurn all Motor Yachts |
| motor-yacht | Rerurn all Motor Yachts |
| Motor Boat | Rerurn all Motor Boats |
| motor-boat | Rerurn all Motor Boats |
| Gulet | Rerurn all Gulets |
| gulet | Rerurn all Gulets |
| Power catamaran | Rerurn all Power catamarans |
| power-catamaran | Rerurn all Power catamarans |
| Examples: | Description |
|---|---|
| category=Catamaran | Return all Catamarans |
| category=Catamaran,Gulet | Return all Catamarans and Gulets |
| category=power-catamaran | Return all Power catamarans |
| category=motor-boat,gulet | Return all Motor Boats and Gulets |
destination:
string
(string)
in query
Destination of boat. Destination can be country, region, city or marina.
destinations:
string[]
in query
Destinations of boat. Destinations can be country, region, city or marina.
country:
string
(string)
in query
Country, where boat is located.
region:
string
(string)
in query
Region in country, where boat is located.
city:
string
(string)
in query
City in country, where boat is located.
marina:
string
(string)
in query
Marina in city, where boat is located.
page:
integer
x ≥ 1
1
in query
Page of boats. Page setup offset for search.
maxSleeps:
string
(string)
in query
Max sleeps parameter can be number or numbers of max sleeps separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| maxSleeps=5 | Select all boats where can be 5 sleeps |
| maxSleeps=0-5 | Search all boats which have from 0 to 5 sleeps |
| maxSleeps=0- | Search all boats which have 0 or more sleeps |
| maxSleeps=-6 | Search all boats which have 6 or less sleeps |
allowedPeople:
string
(string)
in query
| Examples: | Description |
|---|---|
| allowedPeople=5 | Select all boats where can be 5 people |
| allowedPeople=0-5 | Search all boats which have from 0 to 5 people |
| allowedPeople=0- | Search all boats which have 0 or more people |
| allowedPeople=-6 | Search all boats which have 6 or less people |
cabins:
string
(string)
in query
Max number of cabins.
Cabins parameter can be number or numbers of cabins separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| cabins=3 | Search all boats which have 3 cabins |
| cabins=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 cabins |
| cabins=0-5 | Search all boats which have from 0 to 5 cabins |
| cabins=0- | Search all boats which have 0 or more cabins |
| cabins=-6 | Search all boats which have 6 or less cabins |
singleCabins:
string
(string)
in query
singleCabins parameter can be number or numbers of single cabins separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| singleCabins=3 | Search all boats which have 3 single cabins |
| singleCabins=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 single cabins |
| singleCabins=0-5 | Search all boats which have from 0 to 5 single cabins |
| singleCabins=0- | Search all boats which have 0 or more single cabins |
| singleCabins=-6 | Search all boats which have 6 or less single cabins |
doubleCabins:
string
(string)
in query
doubleCabins parameter can be number or numbers of double cabins separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| doubleCabins=3 | Search all boats which have 3 double cabins |
| doubleCabins=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 double cabins |
| doubleCabins=0-5 | Search all boats which have from 0 to 5 double cabins |
| doubleCabins=0- | Search all boats which have 0 or more double cabins |
| doubleCabins=-6 | Search all boats which have 6 or less double cabins |
tripleCabins:
string
(string)
in query
tripleCabins parameter can be number or numbers of triple cabins separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| tripleCabins=3 | Search all boats which have 3 triple cabins |
| tripleCabins=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 triple cabins |
| tripleCabins=0-5 | Search all boats which have from 0 to 5 triple cabins |
| tripleCabins=0- | Search all boats which have 0 or more triple cabins |
| tripleCabins=-6 | Search all boats which have 6 or less triple cabins |
quadrupleCabins:
string
(string)
in query
quadrupleCabins parameter can be number or numbers of quadruple cabins separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| quadrupleCabins=3 | Search all boats which have 3 quadruple cabins |
| quadrupleCabins=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 quadruple cabins |
| quadrupleCabins=0-5 | Search all boats which have from 0 to 5 quadruple cabins |
| quadrupleCabins=0- | Search all boats which have 0 or more quadruple cabins |
| quadrupleCabins=-6 | Search all boats which have 6 or less quadruple cabins |
cabinsWithBunkBed:
string
(string)
in query
cabinsWithBunkBed parameter can be number or numbers of cabins with bunk bed separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| cabinsWithBunkBed=3 | Search all boats which have 3 cabins with bunk bed |
| cabinsWithBunkBed=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 cabins with bunk bed |
| cabinsWithBunkBed=0-5 | Search all boats which have from 0 to 5 cabins with bunk bed |
| cabinsWithBunkBed=0- | Search all boats which have 0 or more cabins with bunk bed |
| cabinsWithBunkBed=-6 | Search all boats which have 6 or less cabins with bunk bed |
toilets:
string
(string)
in query
Number of toilets.
Toilets parameter can be number or numbers of toilets separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| toilets=3 | Search all boats which have 3 toilets |
| toilets=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 toilets |
| toilets=0-5 | Search all boats which have from 0 to 5 toilets |
| toilets=0- | Search all boats which have 0 or more toilets |
| toilets=-6 | Search all boats which have 6 or less toilets |
year:
string
(string)
in query
Year of manufacturing boat.
| Examples: | Description |
|---|---|
| year=2003 | Search all boats which year of manufacturing is 2015 |
| year=2002,2003,2004 | Search all boats which year of manufacturing is 2002 or 2003 or 2004 |
| year=2002-2005 | Search all boats which year of manufacturing is from 2002 to 2005 |
| year=2005- | Search all boats which year of manufacturing is 2005 or more |
| year=-2010 | Search all boats which year of manufacturing is 2010 or less |
manufacturer:
string
in query
Boat manufacturer
Using this parameter will search all boats which are manufactured by specified manufacturer.
It's possible search by more manufacturers separated by comma (,)
| Examples | Description |
|---|---|
| manufacturer=Bavaria | Return all boats manufactured by Bavaria |
| manufacturer=Bavaria,Elan | Return all boats manufactured by Bavaria or Elam |
In this parameter is possible specify models of boats for every Manufacturer. Models have to be separated by semilocon (;)
| Examples | Description |
|---|---|
| manufacturer=Bavaria[46;35] | Return all boats Bavaria model 46 or 35 |
| manufacturer=Bavaria[46;35],Elan[40;50] | Return all boats Bavaria model 46 or 35 and Elan models 40 or 50 |
boatLength:
string
in query
Boat length. Can be number which can be combined, separated by comma (,) or range in format 'X-Y' in meters
| Examples: | Description |
|---|---|
| boatLength=5 | Search all boats which length is equals 5 meters |
| boatLength=small | Search all boats which length is greater than or equals 0 and less than 10 meters |
| boatLength=small,medium | Search all boats which length is greater than or equals 0 and less than 12 meters |
| boatLength=0-5 | Search all boats which have length from 0 to 5 meters |
| boatLength=2- | Search all boats which have length 2 or more meters |
| boatLength=-6 | Search all boats which have 6 meters or less |
charter:
string
in query
Charter of boat
Using this parameter will search all boats belong specified charter. Charter is specified by it's name. At this moment, charters don't have slug option allowed. If charter name contains specific characters, use functions to encode strings into url parameters. F.e: in javascript encodeURIComponent.
It's possible search by more charters separated by comma (,)
| Examples | Description |
|---|---|
| charter=Euronautic | Return all boats belong to Euronautic charter |
| charter=Euronautic,Pitter Yachtcharter | Return all boats belong to Euronautic or Pitter Yachtcharter |
price:
string
in query
Average price of boat per day.
Using this parameter will search all boats which have average price per day in defined range It's possible search by more ranges separated by comma (,)
Using price parameter depends on currency parameter (default currency is EUR).
| Examples | Description |
|---|---|
| price=[0-142] | Return all boats which average price for day is 0-142 (EUR) |
| price=[0-142],[285-428] | Return all boats which average price for day is 0-142 (EUR) or 285-428 (EUR) |
coordinates:
string
(string)
in query
Rectangle coordinates.
Coordinates define area (rectangle) in which boats are located.
Format have to be: bottom left corner and upper right corner.
https://docs.mongodb.com/manual/reference/operator/query/box/
Example:
coordinates=40.79,18.40,48.58,11.74
near:
string
(string)
in query
Near define area from which will be taken radius 30km.
Format have to be: first parameter is Latitude and second is Longitude.
**Example:**
near=40.79,18.40
zoom:
string
(integer)
in query
Current zoom of map.
Zoom parameter is used for group boats by destination. For creating markers on map.
| Value | Description |
|---|---|
| 0-5 | Group boats by Country |
| 6-9 | Group boats by City |
| 10+ | Group boats by Marina |
lang:
string
(string)
en_EN,
en_GB,
en_US,
cs_CZ,
sk_SK,
no_NO,
nb_NO,
sv_SE,
da_DK,
fi_FI,
de_DE,
fr_FR,
pl_PL,
it_IT,
nl_NL,
hu_HU,
ru_RU,
ru_UA,
es_ES,
sl_SI,
hr_HR,
bg_BG,
ro_RO,
lv_LV,
pt_PT,
el_GR,
et_EE,
lt_LT,
tr_TR,
is_IS,
sr_RS,
ca_ES,
en_AU
en_EN
in query
Language of parameters names.
limit:
integer
1 ≤ x ≤ 50
18
in query
Limit results query.
skip:
integer
in query
Skip results query.
sort:
string
priceDown,
priceUp,
discountDown,
discountUp,
reviewsDown,
reviewsCountDown,
rank,
rankWithoutDotd,
dealsFirst,
cheapestDealsFirst,
extra,
prepaymentDown,
prepaymentUp,
freeCancellation
rank
in query
Type of sorting
| Value | Description |
|---|---|
| priceDown | Sort result by price ascending |
| priceUp | Sort result by price descending |
| discountDown | Sort result by discount ascending |
| discountUp | Sort result by discount descending |
| reviewsDown | Sort result by reviews score descending |
| rank | Sort result by rank descending (rank - score from content score, reviews, comersion score) |
| dealsFirst | Sort result by rank descending (rank - score from content score, reviews, comersion score) with special deals on the top |
| cheapestDealsFirst | Sort result by rank descending (rank - score from content score, reviews, comersion score) with cheapest special deals on the top |
| rankWithoutDotd | Sort result by rank (dofd will not be as first result) |
| extra | Sort result by extra discount |
| prepaymentDown | Sort result by prepayment percentage ascending |
| prepaymentUp | Sort result by prepayment percentage descending |
| freeCancellation | Sort result by free cancellation |
sail:
string
in query
Type of main sail. Can be: (classic, roll) which can be combined, separated by comma (,) or english name separated by comma (,)
| Value | Description |
|---|---|
| classic | Search all boats which have classic main sail |
| roll | Search all boats which have rolling main sail |
| Classical mainsail | Search all boats which have classic main sail |
| Rolling mainsail | Search all boats which have rolling sail |
| No sail | Search all boats which don't have sail |
cockpit:
string
in query
Boat interior:
Return all boats contain selected boat amenities. Values can be combined, separated by comma (,)
| Value |
|---|
| Air condition |
| Cooker |
| Dishwasher |
| Freezer |
| Grill |
| Heating |
| Kitchen utensils |
| Microwave |
| Oven |
| Pillows and blankets |
| Refrigerator |
| Shower |
| Sink |
| Towels |
| Coffee machine |
| Ice maker |
| Washing machine |
| Examples | Description |
|---|---|
| cockpit=Grill,Shower,Microwave | Return all boats which contain grill, shower and microwave |
entertainment:
string
in query
Boat entertainment:
Return all boats contain selected boat amenities. Values can be combined, separated by comma (,)
| Value |
|---|
| Inside cockpit speakers |
| Karaoke |
| Kayak |
| LCD TV |
| Outside deck speakers |
| Radio CD / MP3 player |
| Snorkel sets |
| Water skis |
| Wakeboard |
| Bathing platform |
| Stand Up Paddle |
| Bicycle |
| Jet ski |
| Game console |
| DVD Player |
| Examples | Description |
|---|---|
| entertainment=Kayak,LCD TV,Karaoke | Return all boats which contain kayak, LCD TV and karaoke |
equipment:
string
in query
Navigation and safety:
Return all boats contain selected boat amenities. Values can be combined, separated by comma (,)
| Value |
|---|
| Bow thruster |
| Solar panels |
| Bimini |
| Cockpit GPS autopilot |
| Deck GPS autopilot |
| Dinghy |
| Spinnaker |
| Teak deck |
| Jacuzzi |
| Generator |
| Electric winches |
| Flybridge |
| Radar |
| Inverter |
| Autopilot |
| Examples | Description |
|---|---|
| equipment=Jacuzzi,Radar,Dinghy | Return all boats which contain jacuzzi, radar and dinghy |
skipper:
string
in query
Return all boats which have skipper included in price or search by crewed boat and bareboat
| Examples | Description |
|---|---|
| Bareboat | Return all boats which have no crew |
| Crewed | Return all boats which have crew |
currency:
string
EUR,
USD,
CZK,
GBP,
HUF,
DKK,
PLN,
SEK,
NOK,
RUB,
RON,
CHF,
ISK,
TRY,
CAD,
AUD,
ILS,
THB
EUR
in query
Currency standard codes - https://www.xe.com/iso4217.php
engineType:
string
in query
Return all boats contain selected boat engine types. Values can be combined, separated by comma (,)
| Examples | Description |
|---|---|
| engineType=diesel,hybrid | Return all boats which contain engine type: Diesel or Hybrid |
enginePower:
string
in query
Engine power in hp.
Using this parameter will search all boats which have engine power in defined range It's possible search by more ranges separated by comma (,)
| Examples | Description |
|---|---|
| enginePower=0-142 | Return all boats which engine power is 0-142 (hp) |
| enginePower=0-142,285-428 | Return all boats which engine power is 0-142 (hp) or 285-428 (hp) |
reviewScore:
string
(string)
in query
Max number of reviewScore.
Review score parameter can be number or numbers of review score separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| reviewScore=3 | Search all boats which have 3 review score |
| reviewScore=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 review score |
| reviewScore=0-5 | Search all boats which have from 0 to 5 review score |
| reviewScore=0- | Search all boats which have 0 or more review score |
| reviewScore=-6 | Search all boats which have 6 or less review score |
loggedIn:
string
in query
Defines if the user if logged in, value is either 0 or 1
availability:
string
all,
available,
available,all,
all,available
all
in query
Defines if the search returns only available boats or also prereserved
cancellation:
string
free
in query
Defines if the search returns only boats with certain cancellation policy
services:
string
in query
(no description)
hasElectricToilets:
boolean
in query
(no description)
licenses:
string
in query
(no description)
slugs:
string
in query
List of unique boat slugs.
200 OK
Success
204 No Content
No Content (no boats), but filter's possible values are returned
default
Error
Response Example (200 OK)
{
"data": {
"_id": "null",
"data": [
{
"old_id": "integer",
"slug": "string",
"parameters": {
"cabins": "integer",
"max_sleeps": "integer",
"max_people": "integer",
"single_cabins": "integer",
"double_cabins": "integer",
"triple_cabins": "integer",
"quadruple_cabins": "integer",
"cabins_with_bunk_bed": "integer",
"saloon_sleeps": "integer",
"crew_sleeps": "integer",
"toilets": "integer",
"electric_toilets": "integer",
"length": "number",
"beam": "number",
"draft": "number",
"year": "integer",
"renovated_year": "integer",
"sail_renovated_year": "integer",
"engine": "string",
"engine_type": "string",
"fuel": "number",
"cruising_consumption": "number",
"maximum_speed": "number"
},
"title": "string",
"thumb": "string (url)",
"main_img": "string (url)",
"gallery": [
"string (url)"
],
"boataroundExtra": "boolean",
"marina": "string",
"coordinates": [
"number"
],
"country": "string",
"region": "string",
"city": "string",
"category": "string",
"flag": "string",
"sail": "string",
"engineType": "string",
"captain": [
"string"
],
"usp": [
{
"name": "string",
"icon": "string",
"provider": "string"
}
],
"restrictions_covered": "object",
"cancellationInsurance": "object",
"freeBerths": "object",
"charter_rank": "object",
"charter": "string",
"charter_logo": "string",
"charter_id": "string",
"manufacturer": "string",
"illustrated": "boolean",
"priceFrom": "number",
"currency": "string",
"price_type": "string",
"prepayment": "number",
"newboat": "boolean",
"lastCustomer": "string",
"rank": "number",
"views": "integer",
"noLicense": "string",
"reviewsScore": "integer",
"totalReviews": "null,integer",
"deal_of_the_day": "string (date)",
"isSpecialDealDay": "boolean",
"dealType": "string",
"isSmartDeal": "boolean"
}
],
"dataNearBy": [
{
"old_id": "integer",
"slug": "string",
"parameters": {
"cabins": "integer",
"max_sleeps": "integer",
"max_people": "integer",
"single_cabins": "integer",
"double_cabins": "integer",
"triple_cabins": "integer",
"quadruple_cabins": "integer",
"cabins_with_bunk_bed": "integer",
"saloon_sleeps": "integer",
"crew_sleeps": "integer",
"toilets": "integer",
"electric_toilets": "integer",
"length": "number",
"beam": "number",
"draft": "number",
"year": "integer",
"renovated_year": "integer",
"sail_renovated_year": "integer",
"engine": "string",
"engine_type": "string",
"fuel": "number",
"cruising_consumption": "number",
"maximum_speed": "number"
},
"title": "string",
"thumb": "string (url)",
"main_img": "string (url)",
"gallery": [
"string (url)"
],
"boataroundExtra": "boolean",
"marina": "string",
"coordinates": [
"number"
],
"country": "string",
"region": "string",
"city": "string",
"category": "string",
"flag": "string",
"sail": "string",
"engineType": "string",
"captain": [
"string"
],
"usp": [
{
"name": "string",
"icon": "string",
"provider": "string"
}
],
"restrictions_covered": "object",
"cancellationInsurance": "object",
"freeBerths": "object",
"charter_rank": "object",
"charter": "string",
"charter_logo": "string",
"charter_id": "string",
"manufacturer": "string",
"illustrated": "boolean",
"priceFrom": "number",
"currency": "string",
"price_type": "string",
"prepayment": "number",
"newboat": "boolean",
"lastCustomer": "string",
"rank": "number",
"views": "integer",
"noLicense": "string",
"reviewsScore": "integer",
"totalReviews": "null,integer",
"deal_of_the_day": "string (date)",
"isSpecialDealDay": "boolean",
"dealType": "string",
"isSmartDeal": "boolean"
}
],
"totalBoats": "integer",
"totalResults": "integer",
"totalBoatsWithNearBy": "integer",
"totalDestinationCount": "integer",
"currentPage": "integer",
"filter": {
"price": [
{
"_id": "integer",
"count": "integer"
}
],
"cabins": [
{
"_id": "integer",
"count": "integer"
}
],
"singleCabins": [
{
"_id": "integer",
"count": "integer"
}
],
"doubleCabins": [
{
"_id": "integer",
"count": "integer"
}
],
"tripleCabins": [
{
"_id": "integer",
"count": "integer"
}
],
"quadrupleCabins": [
{
"_id": "integer",
"count": "integer"
}
],
"cabinsWithBunkBed": [
{
"_id": "integer",
"count": "integer"
}
],
"toilets": [
{
"_id": "integer",
"count": "integer"
}
],
"charter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"maxSleeps": [
{
"_id": "integer",
"count": "integer"
}
],
"allowedPeople": [
{
"_id": "integer",
"count": "integer"
}
],
"manufacturer": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"models": [
{
"_id": "string",
"count": "integer",
"name": "string",
"manufacturer": "string"
}
],
"boatLength": [
{
"_id": "number",
"count": "integer"
}
],
"year": [
{
"_id": "integer",
"count": "integer"
}
],
"sail": [
{
"_id": "string",
"count": "integer"
}
],
"category": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"cockpit": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"entertainment": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"equipment": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"skipper": [
{
"_id": "string",
"count": "integer"
}
],
"enginePower": [
{
"_id": "integer",
"count": "integer"
}
],
"engineType": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"price_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"cabins_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"single_cabins_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"double_cabins_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"triple_cabins_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"quadruple_cabins_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"cabins_with_bunk_bed_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"toilets_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"charter_nofilter": [
{
"_id": "string",
"count": "integer"
}
],
"max_sleeps_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"manufacturer_nofilter": [
{
"_id": "string",
"count": "integer"
}
],
"models_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string",
"manufacturer": "string"
}
],
"length_nofilter": [
{
"_id": "number",
"count": "integer"
}
],
"year_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"sail_nofilter": [
{
"_id": "string",
"count": "integer"
}
],
"category_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"cockpit_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"entertainment_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"equipment_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"skipper_nofilter": [
{
"_id": "string",
"count": "integer"
}
],
"enginePower_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"engineType_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
]
}
},
"statusCode": "integer",
"status": "string"
}
Response Example (204 No Content)
{
"data": {
"_id": "null",
"totalBoats": "integer",
"totalResults": "integer",
"currentPage": "integer",
"skip": "integer",
"filter": {
"price": [
{
"_id": "integer",
"count": "integer"
}
],
"cabins": [
{
"_id": "integer",
"count": "integer"
}
],
"singleCabins": [
{
"_id": "integer",
"count": "integer"
}
],
"doubleCabins": [
{
"_id": "integer",
"count": "integer"
}
],
"tripleCabins": [
{
"_id": "integer",
"count": "integer"
}
],
"quadrupleCabins": [
{
"_id": "integer",
"count": "integer"
}
],
"cabinsWithBunkBed": [
{
"_id": "integer",
"count": "integer"
}
],
"toilets": [
{
"_id": "integer",
"count": "integer"
}
],
"charter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"maxSleeps": [
{
"_id": "integer",
"count": "integer"
}
],
"allowedPeople": [
{
"_id": "integer",
"count": "integer"
}
],
"manufacturer": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"models": [
{
"_id": "string",
"count": "integer",
"name": "string",
"manufacturer": "string"
}
],
"boatLength": [
{
"_id": "number",
"count": "integer"
}
],
"year": [
{
"_id": "integer",
"count": "integer"
}
],
"sail": [
{
"_id": "string",
"count": "integer"
}
],
"category": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"cockpit": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"entertainment": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"equipment": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"skipper": [
{
"_id": "string",
"count": "integer"
}
],
"enginePower": [
{
"_id": "integer",
"count": "integer"
}
],
"engineType": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"price_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"cabins_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"single_cabins_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"double_cabins_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"triple_cabins_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"quadruple_cabins_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"cabins_with_bunk_bed_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"toilets_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"charter_nofilter": [
{
"_id": "string",
"count": "integer"
}
],
"max_sleeps_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"manufacturer_nofilter": [
{
"_id": "string",
"count": "integer"
}
],
"models_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string",
"manufacturer": "string"
}
],
"length_nofilter": [
{
"_id": "number",
"count": "integer"
}
],
"year_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"sail_nofilter": [
{
"_id": "string",
"count": "integer"
}
],
"category_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"cockpit_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"entertainment_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"equipment_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"skipper_nofilter": [
{
"_id": "string",
"count": "integer"
}
],
"enginePower_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"engineType_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
]
}
},
"statusCode": "integer",
"status": "string"
}
Response Example (default )
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
Search
Returns an array of available experiences in selected range of dates(checkIn and checkOut). If checkIn or checkOut parameter is not defined, return boats with minimal price per day. We are limiting results to 18 per page.
checkIn:
string
(string)
in query
Start date, when order start. Format YYYY-MM-DD.
checkOut:
string
(string)
in query
End date, when order end. Format YYYY-MM-DD.
destinations:
string[]
in query
Destinations of boat. Destinations can be country, region, city or marina.
country:
string
(string)
in query
Country, where boat is located.
region:
string
(string)
in query
Region in country, where boat is located.
city:
string
(string)
in query
City in country, where boat is located.
marina:
string
(string)
in query
Marina in city, where boat is located.
page:
integer
x ≥ 1
1
in query
Page of boats. Page setup offset for search.
maxSleeps:
string
(string)
in query
Max sleeps parameter can be number or numbers of max sleeps separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| maxSleeps=5 | Select all boats where can be 5 sleeps |
| maxSleeps=0-5 | Search all boats which have from 0 to 5 sleeps |
| maxSleeps=0- | Search all boats which have 0 or more sleeps |
| maxSleeps=-6 | Search all boats which have 6 or less sleeps |
allowedPeople:
string
(string)
in query
| Examples: | Description |
|---|---|
| allowedPeople=5 | Select all boats where can be 5 people |
| allowedPeople=0-5 | Search all boats which have from 0 to 5 people |
| allowedPeople=0- | Search all boats which have 0 or more people |
| allowedPeople=-6 | Search all boats which have 6 or less people |
cabins:
string
(string)
in query
Max number of cabins.
Cabins parameter can be number or numbers of cabins separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| cabins=3 | Search all boats which have 3 cabins |
| cabins=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 cabins |
| cabins=0-5 | Search all boats which have from 0 to 5 cabins |
| cabins=0- | Search all boats which have 0 or more cabins |
| cabins=-6 | Search all boats which have 6 or less cabins |
singleCabins:
string
(string)
in query
singleCabins parameter can be number or numbers of single cabins separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| singleCabins=3 | Search all boats which have 3 single cabins |
| singleCabins=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 single cabins |
| singleCabins=0-5 | Search all boats which have from 0 to 5 single cabins |
| singleCabins=0- | Search all boats which have 0 or more single cabins |
| singleCabins=-6 | Search all boats which have 6 or less single cabins |
doubleCabins:
string
(string)
in query
doubleCabins parameter can be number or numbers of double cabins separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| doubleCabins=3 | Search all boats which have 3 double cabins |
| doubleCabins=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 double cabins |
| doubleCabins=0-5 | Search all boats which have from 0 to 5 double cabins |
| doubleCabins=0- | Search all boats which have 0 or more double cabins |
| doubleCabins=-6 | Search all boats which have 6 or less double cabins |
tripleCabins:
string
(string)
in query
tripleCabins parameter can be number or numbers of triple cabins separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| tripleCabins=3 | Search all boats which have 3 triple cabins |
| tripleCabins=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 triple cabins |
| tripleCabins=0-5 | Search all boats which have from 0 to 5 triple cabins |
| tripleCabins=0- | Search all boats which have 0 or more triple cabins |
| tripleCabins=-6 | Search all boats which have 6 or less triple cabins |
quadrupleCabins:
string
(string)
in query
quadrupleCabins parameter can be number or numbers of quadruple cabins separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| quadrupleCabins=3 | Search all boats which have 3 quadruple cabins |
| quadrupleCabins=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 quadruple cabins |
| quadrupleCabins=0-5 | Search all boats which have from 0 to 5 quadruple cabins |
| quadrupleCabins=0- | Search all boats which have 0 or more quadruple cabins |
| quadrupleCabins=-6 | Search all boats which have 6 or less quadruple cabins |
cabinsWithBunkBed:
string
(string)
in query
cabinsWithBunkBed parameter can be number or numbers of cabins with bunk bed separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| cabinsWithBunkBed=3 | Search all boats which have 3 cabins with bunk bed |
| cabinsWithBunkBed=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 cabins with bunk bed |
| cabinsWithBunkBed=0-5 | Search all boats which have from 0 to 5 cabins with bunk bed |
| cabinsWithBunkBed=0- | Search all boats which have 0 or more cabins with bunk bed |
| cabinsWithBunkBed=-6 | Search all boats which have 6 or less cabins with bunk bed |
charter:
string
in query
Charter of boat
Using this parameter will search all boats belong specified charter. Charter is specified by it's name. At this moment, charters don't have slug option allowed. If charter name contains specific characters, use functions to encode strings into url parameters. F.e: in javascript encodeURIComponent.
It's possible search by more charters separated by comma (,)
| Examples | Description |
|---|---|
| charter=Euronautic | Return all boats belong to Euronautic charter |
| charter=Euronautic,Pitter Yachtcharter | Return all boats belong to Euronautic or Pitter Yachtcharter |
price:
string
in query
Average price of boat per day.
Using this parameter will search all boats which have average price per day in defined range It's possible search by more ranges separated by comma (,)
Using price parameter depends on currency parameter (default currency is EUR).
| Examples | Description |
|---|---|
| price=[0-142] | Return all boats which average price for day is 0-142 (EUR) |
| price=[0-142],[285-428] | Return all boats which average price for day is 0-142 (EUR) or 285-428 (EUR) |
coordinates:
string
(string)
in query
Rectangle coordinates.
Coordinates define area (rectangle) in which boats are located.
Format have to be: bottom left corner and upper right corner.
https://docs.mongodb.com/manual/reference/operator/query/box/
Example:
coordinates=40.79,18.40,48.58,11.74
near:
string
(string)
in query
Near define area from which will be taken radius 30km.
Format have to be: first parameter is Latitude and second is Longitude.
**Example:**
near=40.79,18.40
zoom:
string
(integer)
in query
Current zoom of map.
Zoom parameter is used for group boats by destination. For creating markers on map.
| Value | Description |
|---|---|
| 0-5 | Group boats by Country |
| 6-9 | Group boats by City |
| 10+ | Group boats by Marina |
lang:
string
(string)
en_EN,
en_GB,
en_US,
cs_CZ,
sk_SK,
no_NO,
nb_NO,
sv_SE,
da_DK,
fi_FI,
de_DE,
fr_FR,
pl_PL,
it_IT,
nl_NL,
hu_HU,
ru_RU,
ru_UA,
es_ES,
sl_SI,
hr_HR,
bg_BG,
ro_RO,
lv_LV,
pt_PT,
el_GR,
et_EE,
lt_LT,
tr_TR,
is_IS,
sr_RS,
ca_ES,
en_AU
en_EN
in query
Language of parameters names.
limit:
integer
1 ≤ x ≤ 50
18
in query
Limit results query.
sort:
string
priceDown,
priceUp,
discountDown,
discountUp,
reviewsDown,
reviewsCountDown,
rank,
rankWithoutDotd,
dealsFirst,
cheapestDealsFirst,
extra,
prepaymentDown,
prepaymentUp,
freeCancellation
rank
in query
Type of sorting
| Value | Description |
|---|---|
| priceDown | Sort result by price ascending |
| priceUp | Sort result by price descending |
| discountDown | Sort result by discount ascending |
| discountUp | Sort result by discount descending |
| reviewsDown | Sort result by reviews score descending |
| rank | Sort result by rank descending (rank - score from content score, reviews, comersion score) |
| dealsFirst | Sort result by rank descending (rank - score from content score, reviews, comersion score) with special deals on the top |
| cheapestDealsFirst | Sort result by rank descending (rank - score from content score, reviews, comersion score) with cheapest special deals on the top |
| rankWithoutDotd | Sort result by rank (dofd will not be as first result) |
| extra | Sort result by extra discount |
| prepaymentDown | Sort result by prepayment percentage ascending |
| prepaymentUp | Sort result by prepayment percentage descending |
| freeCancellation | Sort result by free cancellation |
cockpit:
string
in query
Boat interior:
Return all boats contain selected boat amenities. Values can be combined, separated by comma (,)
| Value |
|---|
| Air condition |
| Cooker |
| Dishwasher |
| Freezer |
| Grill |
| Heating |
| Kitchen utensils |
| Microwave |
| Oven |
| Pillows and blankets |
| Refrigerator |
| Shower |
| Sink |
| Towels |
| Coffee machine |
| Ice maker |
| Washing machine |
| Examples | Description |
|---|---|
| cockpit=Grill,Shower,Microwave | Return all boats which contain grill, shower and microwave |
entertainment:
string
in query
Boat entertainment:
Return all boats contain selected boat amenities. Values can be combined, separated by comma (,)
| Value |
|---|
| Inside cockpit speakers |
| Karaoke |
| Kayak |
| LCD TV |
| Outside deck speakers |
| Radio CD / MP3 player |
| Snorkel sets |
| Water skis |
| Wakeboard |
| Bathing platform |
| Stand Up Paddle |
| Bicycle |
| Jet ski |
| Game console |
| DVD Player |
| Examples | Description |
|---|---|
| entertainment=Kayak,LCD TV,Karaoke | Return all boats which contain kayak, LCD TV and karaoke |
equipment:
string
in query
Navigation and safety:
Return all boats contain selected boat amenities. Values can be combined, separated by comma (,)
| Value |
|---|
| Bow thruster |
| Solar panels |
| Bimini |
| Cockpit GPS autopilot |
| Deck GPS autopilot |
| Dinghy |
| Spinnaker |
| Teak deck |
| Jacuzzi |
| Generator |
| Electric winches |
| Flybridge |
| Radar |
| Inverter |
| Autopilot |
| Examples | Description |
|---|---|
| equipment=Jacuzzi,Radar,Dinghy | Return all boats which contain jacuzzi, radar and dinghy |
currency:
string
EUR,
USD,
CZK,
GBP,
HUF,
DKK,
PLN,
SEK,
NOK,
RUB,
RON,
CHF,
ISK,
TRY,
CAD,
AUD,
ILS,
THB
EUR
in query
Currency standard codes - https://www.xe.com/iso4217.php
tripType:
string
(string)
in query
Trip type of experience.
It's possible search by more trip types separated by comma (,)
| Value | Description |
|---|---|
| sunset-boat | Rerurn all Sunset Boat experiences |
| Examples: | Description |
|---|---|
| tripType=sunset-boat | Return all Sunset Boat experiences |
cancellation:
string
free
in query
Defines if the search returns only boats with certain cancellation policy
slugs:
string
in query
List of unique boat slugs.
200 OK
Success
204 No Content
No Content (no boats), but filter's possible values are returned
default
Error
Response Example (200 OK)
{
"data": {
"_id": "null",
"data": [
{
"old_id": "integer",
"slug": "string",
"parameters": {
"cabins": "integer",
"max_sleeps": "integer",
"max_people": "integer",
"single_cabins": "integer",
"double_cabins": "integer",
"triple_cabins": "integer",
"quadruple_cabins": "integer",
"cabins_with_bunk_bed": "integer",
"saloon_sleeps": "integer",
"crew_sleeps": "integer"
},
"title": "string",
"thumb": "string (url)",
"main_img": "string (url)",
"gallery": [
"string (url)"
],
"boataroundExtra": "boolean",
"marina": "string",
"coordinates": [
"number"
],
"country": "string",
"region": "string",
"city": "string",
"flag": "string",
"usp": [
{
"name": "string",
"icon": "string",
"provider": "string"
}
],
"restrictions_covered": "object",
"cancellationInsurance": "object",
"freeBerths": "object",
"charter_rank": "object",
"charter": "string",
"charter_logo": "string",
"charter_id": "string",
"illustrated": "boolean",
"priceFrom": "number",
"currency": "string",
"price_type": "string",
"prepayment": "number",
"newboat": "boolean",
"lastCustomer": "string",
"rank": "number",
"views": "integer",
"noLicense": "string",
"reviewsScore": "integer",
"totalReviews": "null,integer",
"deal_of_the_day": "string (date)",
"isSpecialDealDay": "boolean",
"isSmartDeal": "boolean"
}
],
"totalBoats": "integer",
"totalResults": "integer",
"currentPage": "integer",
"skip": "integer",
"filter": {
"price": [
{
"_id": "integer",
"count": "integer"
}
],
"maxSleeps": [
{
"_id": "integer",
"count": "integer"
}
],
"allowedPeople": [
{
"_id": "integer",
"count": "integer"
}
],
"cockpit": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"entertainment": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"equipment": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"price_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"max_sleeps_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"cockpit_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"entertainment_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"equipment_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
]
}
},
"statusCode": "integer",
"status": "string"
}
Response Example (204 No Content)
{
"data": {
"_id": "null",
"totalBoats": "integer",
"totalResults": "integer",
"currentPage": "integer",
"skip": "integer",
"filter": {
"price": [
{
"_id": "integer",
"count": "integer"
}
],
"maxSleeps": [
{
"_id": "integer",
"count": "integer"
}
],
"allowedPeople": [
{
"_id": "integer",
"count": "integer"
}
],
"cockpit": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"entertainment": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"equipment": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"price_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"max_sleeps_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"cockpit_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"entertainment_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"equipment_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
]
}
},
"statusCode": "integer",
"status": "string"
}
Response Example (default )
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
Find destination
Returns 'An array of destinations
query:
string
(string)
in query
Query string.
sessionToken:
string
(string)
in query
UUIDv4 session token to group autocomplete request to one session
excludedSearches:
string[]
in query
Excluded selected results.
excludedTypes:
string[]
in query
Excluded types from results.
lang:
string
(string)
in query
Language.
limit:
integer
1 ≤ x ≤ 50
5
in query
Limit results.
ab:
string
in query
(no description)
200 OK
Success
400 Bad Request
Invalid request, usually caused by invalid parameter values
500 Internal Server Error
Server error
Response Example (200 OK)
{
"data": [
{
"total": "integer",
"icon": "string",
"name": "string",
"type": "string",
"autocomplete": "string",
"label": "string",
"expression": "string",
"is_google": "boolean"
}
],
"statusCode": "integer",
"status": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"errors": [
null
]
}
Response Example (500 Internal Server Error)
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
Find destination
Returns 'An array of destinations
query:
string
(string)
in query
Query string.
sessionToken:
string
(string)
in query
UUIDv4 session token to group autocomplete request to one session
excludedSearches:
string[]
in query
Excluded selected results.
excludedTypes:
string[]
in query
Excluded types from results.
lang:
string
(string)
in query
Language.
limit:
integer
1 ≤ x ≤ 50
5
in query
Limit results.
ab:
string
in query
(no description)
200 OK
Success
400 Bad Request
Invalid request, usually caused by invalid parameter values
500 Internal Server Error
Server error
Response Example (200 OK)
{
"data": [
{
"total": "integer",
"icon": "string",
"name": "string",
"type": "string",
"autocomplete": "string",
"label": "string",
"expression": "string",
"is_google": "boolean"
}
],
"statusCode": "integer",
"status": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"errors": [
null
]
}
Response Example (500 Internal Server Error)
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
Boats
GET /boats/similar
Returns 'An array of similar boats by parameters' to the caller
checkIn:
string
(string)
in query
Start date, when order start. Format YYYY-MM-DD.
checkOut:
string
(string)
in query
End date, when order end. Format YYYY-MM-DD.
exBoat:
string
in query
Except boat by slug
near:
string
(string)
in query
Near define area from which will be taken radius 30km.
Format have to be: first parameter is Latitude and second is Longitude.
**Example:**
near=40.79,18.40
sort:
string
priceDown,
priceUp,
discountDown,
discountUp,
reviewsDown,
reviewsCountDown,
rank,
rankWithoutDotd,
dealsFirst,
cheapestDealsFirst,
extra,
prepaymentDown,
prepaymentUp,
freeCancellation
rank
in query
Type of sorting
| Value | Description |
|---|---|
| priceDown | Sort result by price ascending |
| priceUp | Sort result by price descending |
| discountDown | Sort result by discount ascending |
| discountUp | Sort result by discount descending |
| reviewsDown | Sort result by reviews score descending |
| rank | Sort result by rank descending (rank - score from content score, reviews, comersion score) |
| dealsFirst | Sort result by rank descending (rank - score from content score, reviews, comersion score) with special deals on the top |
| cheapestDealsFirst | Sort result by rank descending (rank - score from content score, reviews, comersion score) with cheapest special deals on the top |
| rankWithoutDotd | Sort result by rank (dofd will not be as first result) |
| extra | Sort result by extra discount |
| prepaymentDown | Sort result by prepayment percentage ascending |
| prepaymentUp | Sort result by prepayment percentage descending |
| freeCancellation | Sort result by free cancellation |
availability:
string
all,
available,
available,all,
all,available
all
in query
Defines if the search returns only available boats or also prereserved
limit:
integer
1 ≤ x ≤ 50
18
in query
Limit results query.
price:
string
in query
Average price of boat per day.
Using this parameter will search all boats which have average price per day in defined range It's possible search by more ranges separated by comma (,)
Using price parameter depends on currency parameter (default currency is EUR).
| Examples | Description |
|---|---|
| price=[0-142] | Return all boats which average price for day is 0-142 (EUR) |
| price=[0-142],[285-428] | Return all boats which average price for day is 0-142 (EUR) or 285-428 (EUR) |
year:
string
(string)
in query
Year of manufacturing boat.
| Examples: | Description |
|---|---|
| year=2003 | Search all boats which year of manufacturing is 2015 |
| year=2002,2003,2004 | Search all boats which year of manufacturing is 2002 or 2003 or 2004 |
| year=2002-2005 | Search all boats which year of manufacturing is from 2002 to 2005 |
| year=2005- | Search all boats which year of manufacturing is 2005 or more |
| year=-2010 | Search all boats which year of manufacturing is 2010 or less |
lang:
string
(string)
en_EN,
en_GB,
en_US,
cs_CZ,
sk_SK,
no_NO,
nb_NO,
sv_SE,
da_DK,
fi_FI,
de_DE,
fr_FR,
pl_PL,
it_IT,
nl_NL,
hu_HU,
ru_RU,
ru_UA,
es_ES,
sl_SI,
hr_HR,
bg_BG,
ro_RO,
lv_LV,
pt_PT,
el_GR,
et_EE,
lt_LT,
tr_TR,
is_IS,
sr_RS,
ca_ES,
en_AU
en_EN
in query
Language of parameters names.
category:
string
(string)
in query
Cateory of boat.
It's possible search by more manufacturers separated by comma (,)
| Value | Description |
|---|---|
| Sailing Yacht | Rerurn all Sailing Yachts |
| sailing-yacht | Rerurn all Sailing Yachts |
| Catamaran | Rerurn all Catamarans |
| catamaran | Rerurn all Catamarans |
| Motor Yacht | Rerurn all Motor Yachts |
| motor-yacht | Rerurn all Motor Yachts |
| Motor Boat | Rerurn all Motor Boats |
| motor-boat | Rerurn all Motor Boats |
| Gulet | Rerurn all Gulets |
| gulet | Rerurn all Gulets |
| Power catamaran | Rerurn all Power catamarans |
| power-catamaran | Rerurn all Power catamarans |
| Examples: | Description |
|---|---|
| category=Catamaran | Return all Catamarans |
| category=Catamaran,Gulet | Return all Catamarans and Gulets |
| category=power-catamaran | Return all Power catamarans |
| category=motor-boat,gulet | Return all Motor Boats and Gulets |
cabins:
string
(string)
in query
Max number of cabins.
Cabins parameter can be number or numbers of cabins separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| cabins=3 | Search all boats which have 3 cabins |
| cabins=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 cabins |
| cabins=0-5 | Search all boats which have from 0 to 5 cabins |
| cabins=0- | Search all boats which have 0 or more cabins |
| cabins=-6 | Search all boats which have 6 or less cabins |
currency:
string
EUR,
USD,
CZK,
GBP,
HUF,
DKK,
PLN,
SEK,
NOK,
RUB,
RON,
CHF,
ISK,
TRY,
CAD,
AUD,
ILS,
THB
EUR
in query
Currency standard codes - https://www.xe.com/iso4217.php
200 OK
Success
default
Error
Response Example (200 OK)
{
"data": [
{
"_id": "null",
"totalBoats": "integer",
"data": [
{
"_id": "string",
"slug": "string",
"title": "string",
"thumb": "string (url)",
"main_img": "string (url)",
"boataroundExtra": "boolean",
"marina": "string",
"country": "string",
"region": "string",
"city": "string",
"flag": "string",
"currency": "string",
"price": "number",
"totalPrice": "number",
"priceFrom": "number",
"discount": "number",
"period": "integer",
"old_id": "number"
}
]
}
],
"statusCode": "integer",
"status": "string"
}
Response Example (default )
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
GET /boats/manufacturers/popular
Returns 'An array of popular manufacturers by boat views' to the caller
limit:
integer
1 ≤ x ≤ 50
18
in query
Limit results query.
200 OK
Success
400 Bad Request
Invalid request, usually caused by invalid parameter values
500 Internal Server Error
Server error
Response Example (200 OK)
{
"data": [
{
"slug": "string",
"name": "string",
"total": "integer"
}
],
"statusCode": "integer",
"status": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"errors": [
null
]
}
Response Example (500 Internal Server Error)
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
GET /boats/charters/popular
Returns 'An array of popular charters by boat views' to the caller
limit:
integer
1 ≤ x ≤ 50
18
in query
Limit results query.
200 OK
Success
400 Bad Request
Invalid request, usually caused by invalid parameter values
500 Internal Server Error
Server error
Response Example (200 OK)
{
"data": [
{
"slug": "string",
"name": "string",
"total": "integer"
}
],
"statusCode": "integer",
"status": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"errors": [
null
]
}
Response Example (500 Internal Server Error)
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
GET /boats/countries/popular
Returns 'An array of popular countries by boat views' to the caller
limit:
integer
1 ≤ x ≤ 50
18
in query
Limit results query.
lang:
string
(string)
en_EN,
en_GB,
en_US,
cs_CZ,
sk_SK,
no_NO,
nb_NO,
sv_SE,
da_DK,
fi_FI,
de_DE,
fr_FR,
pl_PL,
it_IT,
nl_NL,
hu_HU,
ru_RU,
ru_UA,
es_ES,
sl_SI,
hr_HR,
bg_BG,
ro_RO,
lv_LV,
pt_PT,
el_GR,
et_EE,
lt_LT,
tr_TR,
is_IS,
sr_RS,
ca_ES,
en_AU
en_EN
in query
Language of parameters names.
200 OK
Success
400 Bad Request
Invalid request, usually caused by invalid parameter values
500 Internal Server Error
Server error
Response Example (200 OK)
{
"data": [
{
"slug": "string",
"name": "string",
"total": "integer"
}
],
"statusCode": "integer",
"status": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"errors": [
null
]
}
Response Example (500 Internal Server Error)
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
GET /boats/regions/popular
Returns 'An array of popular regions by boat views' to the caller
limit:
integer
1 ≤ x ≤ 50
18
in query
Limit results query.
lang:
string
(string)
en_EN,
en_GB,
en_US,
cs_CZ,
sk_SK,
no_NO,
nb_NO,
sv_SE,
da_DK,
fi_FI,
de_DE,
fr_FR,
pl_PL,
it_IT,
nl_NL,
hu_HU,
ru_RU,
ru_UA,
es_ES,
sl_SI,
hr_HR,
bg_BG,
ro_RO,
lv_LV,
pt_PT,
el_GR,
et_EE,
lt_LT,
tr_TR,
is_IS,
sr_RS,
ca_ES,
en_AU
en_EN
in query
Language of parameters names.
200 OK
Success
400 Bad Request
Invalid request, usually caused by invalid parameter values
500 Internal Server Error
Server error
Response Example (200 OK)
{
"data": [
{
"slug": "string",
"name": "string",
"total": "integer"
}
],
"statusCode": "integer",
"status": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"errors": [
null
]
}
Response Example (500 Internal Server Error)
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
GET /boats/cities/popular
Returns 'An array of popular cities by boat views' to the caller
limit:
integer
1 ≤ x ≤ 50
18
in query
Limit results query.
lang:
string
(string)
en_EN,
en_GB,
en_US,
cs_CZ,
sk_SK,
no_NO,
nb_NO,
sv_SE,
da_DK,
fi_FI,
de_DE,
fr_FR,
pl_PL,
it_IT,
nl_NL,
hu_HU,
ru_RU,
ru_UA,
es_ES,
sl_SI,
hr_HR,
bg_BG,
ro_RO,
lv_LV,
pt_PT,
el_GR,
et_EE,
lt_LT,
tr_TR,
is_IS,
sr_RS,
ca_ES,
en_AU
en_EN
in query
Language of parameters names.
200 OK
Success
400 Bad Request
Invalid request, usually caused by invalid parameter values
500 Internal Server Error
Server error
Response Example (200 OK)
{
"data": [
{
"slug": "string",
"name": "string",
"total": "integer"
}
],
"statusCode": "integer",
"status": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"errors": [
null
]
}
Response Example (500 Internal Server Error)
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
GET /boats/marinas/popular
Returns 'An array of popular marinas by boat views' to the caller
limit:
integer
1 ≤ x ≤ 50
18
in query
Limit results query.
lang:
string
(string)
en_EN,
en_GB,
en_US,
cs_CZ,
sk_SK,
no_NO,
nb_NO,
sv_SE,
da_DK,
fi_FI,
de_DE,
fr_FR,
pl_PL,
it_IT,
nl_NL,
hu_HU,
ru_RU,
ru_UA,
es_ES,
sl_SI,
hr_HR,
bg_BG,
ro_RO,
lv_LV,
pt_PT,
el_GR,
et_EE,
lt_LT,
tr_TR,
is_IS,
sr_RS,
ca_ES,
en_AU
en_EN
in query
Language of parameters names.
200 OK
Success
400 Bad Request
Invalid request, usually caused by invalid parameter values
500 Internal Server Error
Server error
Response Example (200 OK)
{
"data": [
{
"slug": "string",
"name": "string",
"total": "integer"
}
],
"statusCode": "integer",
"status": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"errors": [
null
]
}
Response Example (500 Internal Server Error)
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
GET /boats/locations/
Returns locations for given parameters
checkIn:
string
(string)
in query
Start date, when order start. Format YYYY-MM-DD.
checkOut:
string
(string)
in query
End date, when order end. Format YYYY-MM-DD.
category:
string
(string)
in query
Cateory of boat.
It's possible search by more manufacturers separated by comma (,)
| Value | Description |
|---|---|
| Sailing Yacht | Rerurn all Sailing Yachts |
| sailing-yacht | Rerurn all Sailing Yachts |
| Catamaran | Rerurn all Catamarans |
| catamaran | Rerurn all Catamarans |
| Motor Yacht | Rerurn all Motor Yachts |
| motor-yacht | Rerurn all Motor Yachts |
| Motor Boat | Rerurn all Motor Boats |
| motor-boat | Rerurn all Motor Boats |
| Gulet | Rerurn all Gulets |
| gulet | Rerurn all Gulets |
| Power catamaran | Rerurn all Power catamarans |
| power-catamaran | Rerurn all Power catamarans |
| Examples: | Description |
|---|---|
| category=Catamaran | Return all Catamarans |
| category=Catamaran,Gulet | Return all Catamarans and Gulets |
| category=power-catamaran | Return all Power catamarans |
| category=motor-boat,gulet | Return all Motor Boats and Gulets |
country:
string
(string)
in query
Country, where boat is located.
region:
string
(string)
in query
Region in country, where boat is located.
city:
string
(string)
in query
City in country, where boat is located.
marina:
string
(string)
in query
Marina in city, where boat is located.
page:
integer
x ≥ 1
1
in query
Page of boats. Page setup offset for search.
maxSleeps:
string
(string)
in query
Max sleeps parameter can be number or numbers of max sleeps separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| maxSleeps=5 | Select all boats where can be 5 sleeps |
| maxSleeps=0-5 | Search all boats which have from 0 to 5 sleeps |
| maxSleeps=0- | Search all boats which have 0 or more sleeps |
| maxSleeps=-6 | Search all boats which have 6 or less sleeps |
allowedPeople:
string
(string)
in query
| Examples: | Description |
|---|---|
| allowedPeople=5 | Select all boats where can be 5 people |
| allowedPeople=0-5 | Search all boats which have from 0 to 5 people |
| allowedPeople=0- | Search all boats which have 0 or more people |
| allowedPeople=-6 | Search all boats which have 6 or less people |
cabins:
string
(string)
in query
Max number of cabins.
Cabins parameter can be number or numbers of cabins separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| cabins=3 | Search all boats which have 3 cabins |
| cabins=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 cabins |
| cabins=0-5 | Search all boats which have from 0 to 5 cabins |
| cabins=0- | Search all boats which have 0 or more cabins |
| cabins=-6 | Search all boats which have 6 or less cabins |
singleCabins:
string
(string)
in query
singleCabins parameter can be number or numbers of single cabins separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| singleCabins=3 | Search all boats which have 3 single cabins |
| singleCabins=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 single cabins |
| singleCabins=0-5 | Search all boats which have from 0 to 5 single cabins |
| singleCabins=0- | Search all boats which have 0 or more single cabins |
| singleCabins=-6 | Search all boats which have 6 or less single cabins |
doubleCabins:
string
(string)
in query
doubleCabins parameter can be number or numbers of double cabins separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| doubleCabins=3 | Search all boats which have 3 double cabins |
| doubleCabins=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 double cabins |
| doubleCabins=0-5 | Search all boats which have from 0 to 5 double cabins |
| doubleCabins=0- | Search all boats which have 0 or more double cabins |
| doubleCabins=-6 | Search all boats which have 6 or less double cabins |
tripleCabins:
string
(string)
in query
tripleCabins parameter can be number or numbers of triple cabins separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| tripleCabins=3 | Search all boats which have 3 triple cabins |
| tripleCabins=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 triple cabins |
| tripleCabins=0-5 | Search all boats which have from 0 to 5 triple cabins |
| tripleCabins=0- | Search all boats which have 0 or more triple cabins |
| tripleCabins=-6 | Search all boats which have 6 or less triple cabins |
quadrupleCabins:
string
(string)
in query
quadrupleCabins parameter can be number or numbers of quadruple cabins separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| quadrupleCabins=3 | Search all boats which have 3 quadruple cabins |
| quadrupleCabins=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 quadruple cabins |
| quadrupleCabins=0-5 | Search all boats which have from 0 to 5 quadruple cabins |
| quadrupleCabins=0- | Search all boats which have 0 or more quadruple cabins |
| quadrupleCabins=-6 | Search all boats which have 6 or less quadruple cabins |
cabinsWithBunkBed:
string
(string)
in query
cabinsWithBunkBed parameter can be number or numbers of cabins with bunk bed separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| cabinsWithBunkBed=3 | Search all boats which have 3 cabins with bunk bed |
| cabinsWithBunkBed=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 cabins with bunk bed |
| cabinsWithBunkBed=0-5 | Search all boats which have from 0 to 5 cabins with bunk bed |
| cabinsWithBunkBed=0- | Search all boats which have 0 or more cabins with bunk bed |
| cabinsWithBunkBed=-6 | Search all boats which have 6 or less cabins with bunk bed |
toilets:
string
(string)
in query
Number of toilets.
Toilets parameter can be number or numbers of toilets separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| toilets=3 | Search all boats which have 3 toilets |
| toilets=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 toilets |
| toilets=0-5 | Search all boats which have from 0 to 5 toilets |
| toilets=0- | Search all boats which have 0 or more toilets |
| toilets=-6 | Search all boats which have 6 or less toilets |
year:
string
(string)
in query
Year of manufacturing boat.
| Examples: | Description |
|---|---|
| year=2003 | Search all boats which year of manufacturing is 2015 |
| year=2002,2003,2004 | Search all boats which year of manufacturing is 2002 or 2003 or 2004 |
| year=2002-2005 | Search all boats which year of manufacturing is from 2002 to 2005 |
| year=2005- | Search all boats which year of manufacturing is 2005 or more |
| year=-2010 | Search all boats which year of manufacturing is 2010 or less |
manufacturer:
string
in query
Boat manufacturer
Using this parameter will search all boats which are manufactured by specified manufacturer.
It's possible search by more manufacturers separated by comma (,)
| Examples | Description |
|---|---|
| manufacturer=Bavaria | Return all boats manufactured by Bavaria |
| manufacturer=Bavaria,Elan | Return all boats manufactured by Bavaria or Elam |
In this parameter is possible specify models of boats for every Manufacturer. Models have to be separated by semilocon (;)
| Examples | Description |
|---|---|
| manufacturer=Bavaria[46;35] | Return all boats Bavaria model 46 or 35 |
| manufacturer=Bavaria[46;35],Elan[40;50] | Return all boats Bavaria model 46 or 35 and Elan models 40 or 50 |
boatLength:
string
in query
Boat length. Can be number which can be combined, separated by comma (,) or range in format 'X-Y' in meters
| Examples: | Description |
|---|---|
| boatLength=5 | Search all boats which length is equals 5 meters |
| boatLength=small | Search all boats which length is greater than or equals 0 and less than 10 meters |
| boatLength=small,medium | Search all boats which length is greater than or equals 0 and less than 12 meters |
| boatLength=0-5 | Search all boats which have length from 0 to 5 meters |
| boatLength=2- | Search all boats which have length 2 or more meters |
| boatLength=-6 | Search all boats which have 6 meters or less |
charter:
string
in query
Charter of boat
Using this parameter will search all boats belong specified charter. Charter is specified by it's name. At this moment, charters don't have slug option allowed. If charter name contains specific characters, use functions to encode strings into url parameters. F.e: in javascript encodeURIComponent.
It's possible search by more charters separated by comma (,)
| Examples | Description |
|---|---|
| charter=Euronautic | Return all boats belong to Euronautic charter |
| charter=Euronautic,Pitter Yachtcharter | Return all boats belong to Euronautic or Pitter Yachtcharter |
price:
string
in query
Average price of boat per day.
Using this parameter will search all boats which have average price per day in defined range It's possible search by more ranges separated by comma (,)
Using price parameter depends on currency parameter (default currency is EUR).
| Examples | Description |
|---|---|
| price=[0-142] | Return all boats which average price for day is 0-142 (EUR) |
| price=[0-142],[285-428] | Return all boats which average price for day is 0-142 (EUR) or 285-428 (EUR) |
coordinates:
string
(string)
in query
Rectangle coordinates.
Coordinates define area (rectangle) in which boats are located.
Format have to be: bottom left corner and upper right corner.
https://docs.mongodb.com/manual/reference/operator/query/box/
Example:
coordinates=40.79,18.40,48.58,11.74
near:
string
(string)
in query
Near define area from which will be taken radius 30km.
Format have to be: first parameter is Latitude and second is Longitude.
**Example:**
near=40.79,18.40
zoom:
string
(integer)
in query
Current zoom of map.
Zoom parameter is used for group boats by destination. For creating markers on map.
| Value | Description |
|---|---|
| 0-5 | Group boats by Country |
| 6-9 | Group boats by City |
| 10+ | Group boats by Marina |
lang:
string
(string)
en_EN,
en_GB,
en_US,
cs_CZ,
sk_SK,
no_NO,
nb_NO,
sv_SE,
da_DK,
fi_FI,
de_DE,
fr_FR,
pl_PL,
it_IT,
nl_NL,
hu_HU,
ru_RU,
ru_UA,
es_ES,
sl_SI,
hr_HR,
bg_BG,
ro_RO,
lv_LV,
pt_PT,
el_GR,
et_EE,
lt_LT,
tr_TR,
is_IS,
sr_RS,
ca_ES,
en_AU
en_EN
in query
Language of parameters names.
sail:
string
in query
Type of main sail. Can be: (classic, roll) which can be combined, separated by comma (,) or english name separated by comma (,)
| Value | Description |
|---|---|
| classic | Search all boats which have classic main sail |
| roll | Search all boats which have rolling main sail |
| Classical mainsail | Search all boats which have classic main sail |
| Rolling mainsail | Search all boats which have rolling sail |
| No sail | Search all boats which don't have sail |
cockpit:
string
in query
Boat interior:
Return all boats contain selected boat amenities. Values can be combined, separated by comma (,)
| Value |
|---|
| Air condition |
| Cooker |
| Dishwasher |
| Freezer |
| Grill |
| Heating |
| Kitchen utensils |
| Microwave |
| Oven |
| Pillows and blankets |
| Refrigerator |
| Shower |
| Sink |
| Towels |
| Coffee machine |
| Ice maker |
| Washing machine |
| Examples | Description |
|---|---|
| cockpit=Grill,Shower,Microwave | Return all boats which contain grill, shower and microwave |
entertainment:
string
in query
Boat entertainment:
Return all boats contain selected boat amenities. Values can be combined, separated by comma (,)
| Value |
|---|
| Inside cockpit speakers |
| Karaoke |
| Kayak |
| LCD TV |
| Outside deck speakers |
| Radio CD / MP3 player |
| Snorkel sets |
| Water skis |
| Wakeboard |
| Bathing platform |
| Stand Up Paddle |
| Bicycle |
| Jet ski |
| Game console |
| DVD Player |
| Examples | Description |
|---|---|
| entertainment=Kayak,LCD TV,Karaoke | Return all boats which contain kayak, LCD TV and karaoke |
equipment:
string
in query
Navigation and safety:
Return all boats contain selected boat amenities. Values can be combined, separated by comma (,)
| Value |
|---|
| Bow thruster |
| Solar panels |
| Bimini |
| Cockpit GPS autopilot |
| Deck GPS autopilot |
| Dinghy |
| Spinnaker |
| Teak deck |
| Jacuzzi |
| Generator |
| Electric winches |
| Flybridge |
| Radar |
| Inverter |
| Autopilot |
| Examples | Description |
|---|---|
| equipment=Jacuzzi,Radar,Dinghy | Return all boats which contain jacuzzi, radar and dinghy |
skipper:
string
in query
Return all boats which have skipper included in price or search by crewed boat and bareboat
| Examples | Description |
|---|---|
| Bareboat | Return all boats which have no crew |
| Crewed | Return all boats which have crew |
currency:
string
EUR,
USD,
CZK,
GBP,
HUF,
DKK,
PLN,
SEK,
NOK,
RUB,
RON,
CHF,
ISK,
TRY,
CAD,
AUD,
ILS,
THB
EUR
in query
Currency standard codes - https://www.xe.com/iso4217.php
200 OK
Success
400 Bad Request
Invalid request, usually caused by invalid parameter values
500 Internal Server Error
Server error
Response Example (200 OK)
{
"data": [
{
"_id": "null",
"totalResults": "integer",
"data": [
{
"name": "string",
"slug": "string",
"type": "string",
"totalBoats": "integer",
"location": {
"type": "string",
"coordinates": [
"number"
]
}
}
]
}
],
"statusCode": "integer",
"status": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"errors": [
null
]
}
Response Example (500 Internal Server Error)
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
GET /nearest-locations/
Returns nearest locations for given location (works only for marina and city location type) with available boats in max distance 50km
from:
string
in query
Location from which is calculated nearest locations - accepts location search_slug
exclude:
string
in query
Excluded location slugs (search_slug parameter on location), more locations separated by comma Example: marina-kornati,marina-punat
limit:
number
1 ≤ x ≤ 10
3
in query
Limit for nearest location count
lang:
string
(string)
en_EN,
en_GB,
en_US,
cs_CZ,
sk_SK,
no_NO,
nb_NO,
sv_SE,
da_DK,
fi_FI,
de_DE,
fr_FR,
pl_PL,
it_IT,
nl_NL,
hu_HU,
ru_RU,
ru_UA,
es_ES,
sl_SI,
hr_HR,
bg_BG,
ro_RO,
lv_LV,
pt_PT,
el_GR,
et_EE,
lt_LT,
tr_TR,
is_IS,
sr_RS,
ca_ES,
en_AU
en_EN
in query
Language of parameters names.
200 OK
Success
400 Bad Request
Invalid request, usually caused by invalid parameter values
500 Internal Server Error
Server error
Response Example (200 OK)
{
"data": [
{
"data": [
{
"type": "string",
"coordinates": [
"integer"
],
"name": "string",
"image": "string",
"boats": "integer",
"distance": "integer"
}
]
}
],
"statusCode": "integer",
"status": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"errors": [
null
]
}
Response Example (500 Internal Server Error)
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
GET /category/{category}
Returns 'An array of available boats for specific category' to the caller
category:
string
(string)
in path
Category of boat.
lang:
string
(string)
en_EN
in query
Language category name.
skip:
number
(integer)
0
in query
Skip results query.
limit:
integer
1 ≤ x ≤ 50
18
in query
Limit results query.
200 OK
Success
default
Error
Response Content-Types: application/json
Response Example (200 OK)
{
"data": [
{
"id": "null",
"totalBoats": "integer",
"totalResults": "integer",
"data": [
{
"_id": "string",
"title": "string",
"slug": "string",
"thumb": "string (url)",
"main_img": "string (url)",
"max_sleeps": "integer",
"cabins": "integer",
"year": "integer",
"marina": "string",
"city": "string",
"country": "string",
"region": "string",
"category": "string",
"flag": "string"
}
]
}
],
"statusCode": "integer",
"status": "string"
}
Response Example (default )
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
GET /categories/all
Return array of categories with their language translation and total boats
lang:
string
(string)
en_EN,
en_GB,
en_US,
cs_CZ,
sk_SK,
no_NO,
nb_NO,
sv_SE,
da_DK,
fi_FI,
de_DE,
fr_FR,
pl_PL,
it_IT,
nl_NL,
hu_HU,
ru_RU,
ru_UA,
es_ES,
sl_SI,
hr_HR,
bg_BG,
ro_RO,
lv_LV,
pt_PT,
el_GR,
et_EE,
lt_LT,
tr_TR,
is_IS,
sr_RS,
ca_ES,
en_AU
en_EN
in query
Language of parameters names.
country:
string
(string)
in query
Country, where boat is located.
region:
string
(string)
in query
Region in country, where boat is located.
city:
string
(string)
in query
City in country, where boat is located.
marina:
string
(string)
in query
Marina in city, where boat is located.
currency:
string
EUR,
USD,
CZK,
GBP,
HUF,
DKK,
PLN,
SEK,
NOK,
RUB,
RON,
CHF,
ISK,
TRY,
CAD,
AUD,
ILS,
THB
EUR
in query
Currency standard codes - https://www.xe.com/iso4217.php
200 OK
Success
default
Error
Response Example (200 OK)
{
"data": [
{
"_id": "string",
"title": "string",
"priceFrom": "number",
"currency": "string",
"totalBoats": "integer"
}
],
"statusCode": "integer",
"status": "string"
}
Response Example (default )
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
Manufacturers
GET /boats/manufacturers/popular
Returns 'An array of popular manufacturers by boat views' to the caller
limit:
integer
1 ≤ x ≤ 50
18
in query
Limit results query.
200 OK
Success
400 Bad Request
Invalid request, usually caused by invalid parameter values
500 Internal Server Error
Server error
Response Example (200 OK)
{
"data": [
{
"slug": "string",
"name": "string",
"total": "integer"
}
],
"statusCode": "integer",
"status": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"errors": [
null
]
}
Response Example (500 Internal Server Error)
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
Charters
GET /boats/charters/popular
Returns 'An array of popular charters by boat views' to the caller
limit:
integer
1 ≤ x ≤ 50
18
in query
Limit results query.
200 OK
Success
400 Bad Request
Invalid request, usually caused by invalid parameter values
500 Internal Server Error
Server error
Response Example (200 OK)
{
"data": [
{
"slug": "string",
"name": "string",
"total": "integer"
}
],
"statusCode": "integer",
"status": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"errors": [
null
]
}
Response Example (500 Internal Server Error)
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
Locations
GET /boats/countries/popular
Returns 'An array of popular countries by boat views' to the caller
limit:
integer
1 ≤ x ≤ 50
18
in query
Limit results query.
lang:
string
(string)
en_EN,
en_GB,
en_US,
cs_CZ,
sk_SK,
no_NO,
nb_NO,
sv_SE,
da_DK,
fi_FI,
de_DE,
fr_FR,
pl_PL,
it_IT,
nl_NL,
hu_HU,
ru_RU,
ru_UA,
es_ES,
sl_SI,
hr_HR,
bg_BG,
ro_RO,
lv_LV,
pt_PT,
el_GR,
et_EE,
lt_LT,
tr_TR,
is_IS,
sr_RS,
ca_ES,
en_AU
en_EN
in query
Language of parameters names.
200 OK
Success
400 Bad Request
Invalid request, usually caused by invalid parameter values
500 Internal Server Error
Server error
Response Example (200 OK)
{
"data": [
{
"slug": "string",
"name": "string",
"total": "integer"
}
],
"statusCode": "integer",
"status": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"errors": [
null
]
}
Response Example (500 Internal Server Error)
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
GET /boats/regions/popular
Returns 'An array of popular regions by boat views' to the caller
limit:
integer
1 ≤ x ≤ 50
18
in query
Limit results query.
lang:
string
(string)
en_EN,
en_GB,
en_US,
cs_CZ,
sk_SK,
no_NO,
nb_NO,
sv_SE,
da_DK,
fi_FI,
de_DE,
fr_FR,
pl_PL,
it_IT,
nl_NL,
hu_HU,
ru_RU,
ru_UA,
es_ES,
sl_SI,
hr_HR,
bg_BG,
ro_RO,
lv_LV,
pt_PT,
el_GR,
et_EE,
lt_LT,
tr_TR,
is_IS,
sr_RS,
ca_ES,
en_AU
en_EN
in query
Language of parameters names.
200 OK
Success
400 Bad Request
Invalid request, usually caused by invalid parameter values
500 Internal Server Error
Server error
Response Example (200 OK)
{
"data": [
{
"slug": "string",
"name": "string",
"total": "integer"
}
],
"statusCode": "integer",
"status": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"errors": [
null
]
}
Response Example (500 Internal Server Error)
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
GET /boats/cities/popular
Returns 'An array of popular cities by boat views' to the caller
limit:
integer
1 ≤ x ≤ 50
18
in query
Limit results query.
lang:
string
(string)
en_EN,
en_GB,
en_US,
cs_CZ,
sk_SK,
no_NO,
nb_NO,
sv_SE,
da_DK,
fi_FI,
de_DE,
fr_FR,
pl_PL,
it_IT,
nl_NL,
hu_HU,
ru_RU,
ru_UA,
es_ES,
sl_SI,
hr_HR,
bg_BG,
ro_RO,
lv_LV,
pt_PT,
el_GR,
et_EE,
lt_LT,
tr_TR,
is_IS,
sr_RS,
ca_ES,
en_AU
en_EN
in query
Language of parameters names.
200 OK
Success
400 Bad Request
Invalid request, usually caused by invalid parameter values
500 Internal Server Error
Server error
Response Example (200 OK)
{
"data": [
{
"slug": "string",
"name": "string",
"total": "integer"
}
],
"statusCode": "integer",
"status": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"errors": [
null
]
}
Response Example (500 Internal Server Error)
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
GET /boats/marinas/popular
Returns 'An array of popular marinas by boat views' to the caller
limit:
integer
1 ≤ x ≤ 50
18
in query
Limit results query.
lang:
string
(string)
en_EN,
en_GB,
en_US,
cs_CZ,
sk_SK,
no_NO,
nb_NO,
sv_SE,
da_DK,
fi_FI,
de_DE,
fr_FR,
pl_PL,
it_IT,
nl_NL,
hu_HU,
ru_RU,
ru_UA,
es_ES,
sl_SI,
hr_HR,
bg_BG,
ro_RO,
lv_LV,
pt_PT,
el_GR,
et_EE,
lt_LT,
tr_TR,
is_IS,
sr_RS,
ca_ES,
en_AU
en_EN
in query
Language of parameters names.
200 OK
Success
400 Bad Request
Invalid request, usually caused by invalid parameter values
500 Internal Server Error
Server error
Response Example (200 OK)
{
"data": [
{
"slug": "string",
"name": "string",
"total": "integer"
}
],
"statusCode": "integer",
"status": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"errors": [
null
]
}
Response Example (500 Internal Server Error)
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
All poi
Return list of all poi
country:
string
in query
Country of Poi.
region:
string
in query
Region of Poi.
lang:
string
en_EN
in query
(no description)
200 OK
Success
default
Error
Response Example (200 OK)
{
"_id": "string",
"name": "string",
"types_poi": [
"string"
],
"coordinates": [
"number"
],
"description": "string",
"slug": "string"
}
Response Example (default )
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
Map
GET /boats/locations/
Returns locations for given parameters
checkIn:
string
(string)
in query
Start date, when order start. Format YYYY-MM-DD.
checkOut:
string
(string)
in query
End date, when order end. Format YYYY-MM-DD.
category:
string
(string)
in query
Cateory of boat.
It's possible search by more manufacturers separated by comma (,)
| Value | Description |
|---|---|
| Sailing Yacht | Rerurn all Sailing Yachts |
| sailing-yacht | Rerurn all Sailing Yachts |
| Catamaran | Rerurn all Catamarans |
| catamaran | Rerurn all Catamarans |
| Motor Yacht | Rerurn all Motor Yachts |
| motor-yacht | Rerurn all Motor Yachts |
| Motor Boat | Rerurn all Motor Boats |
| motor-boat | Rerurn all Motor Boats |
| Gulet | Rerurn all Gulets |
| gulet | Rerurn all Gulets |
| Power catamaran | Rerurn all Power catamarans |
| power-catamaran | Rerurn all Power catamarans |
| Examples: | Description |
|---|---|
| category=Catamaran | Return all Catamarans |
| category=Catamaran,Gulet | Return all Catamarans and Gulets |
| category=power-catamaran | Return all Power catamarans |
| category=motor-boat,gulet | Return all Motor Boats and Gulets |
country:
string
(string)
in query
Country, where boat is located.
region:
string
(string)
in query
Region in country, where boat is located.
city:
string
(string)
in query
City in country, where boat is located.
marina:
string
(string)
in query
Marina in city, where boat is located.
page:
integer
x ≥ 1
1
in query
Page of boats. Page setup offset for search.
maxSleeps:
string
(string)
in query
Max sleeps parameter can be number or numbers of max sleeps separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| maxSleeps=5 | Select all boats where can be 5 sleeps |
| maxSleeps=0-5 | Search all boats which have from 0 to 5 sleeps |
| maxSleeps=0- | Search all boats which have 0 or more sleeps |
| maxSleeps=-6 | Search all boats which have 6 or less sleeps |
allowedPeople:
string
(string)
in query
| Examples: | Description |
|---|---|
| allowedPeople=5 | Select all boats where can be 5 people |
| allowedPeople=0-5 | Search all boats which have from 0 to 5 people |
| allowedPeople=0- | Search all boats which have 0 or more people |
| allowedPeople=-6 | Search all boats which have 6 or less people |
cabins:
string
(string)
in query
Max number of cabins.
Cabins parameter can be number or numbers of cabins separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| cabins=3 | Search all boats which have 3 cabins |
| cabins=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 cabins |
| cabins=0-5 | Search all boats which have from 0 to 5 cabins |
| cabins=0- | Search all boats which have 0 or more cabins |
| cabins=-6 | Search all boats which have 6 or less cabins |
singleCabins:
string
(string)
in query
singleCabins parameter can be number or numbers of single cabins separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| singleCabins=3 | Search all boats which have 3 single cabins |
| singleCabins=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 single cabins |
| singleCabins=0-5 | Search all boats which have from 0 to 5 single cabins |
| singleCabins=0- | Search all boats which have 0 or more single cabins |
| singleCabins=-6 | Search all boats which have 6 or less single cabins |
doubleCabins:
string
(string)
in query
doubleCabins parameter can be number or numbers of double cabins separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| doubleCabins=3 | Search all boats which have 3 double cabins |
| doubleCabins=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 double cabins |
| doubleCabins=0-5 | Search all boats which have from 0 to 5 double cabins |
| doubleCabins=0- | Search all boats which have 0 or more double cabins |
| doubleCabins=-6 | Search all boats which have 6 or less double cabins |
tripleCabins:
string
(string)
in query
tripleCabins parameter can be number or numbers of triple cabins separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| tripleCabins=3 | Search all boats which have 3 triple cabins |
| tripleCabins=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 triple cabins |
| tripleCabins=0-5 | Search all boats which have from 0 to 5 triple cabins |
| tripleCabins=0- | Search all boats which have 0 or more triple cabins |
| tripleCabins=-6 | Search all boats which have 6 or less triple cabins |
quadrupleCabins:
string
(string)
in query
quadrupleCabins parameter can be number or numbers of quadruple cabins separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| quadrupleCabins=3 | Search all boats which have 3 quadruple cabins |
| quadrupleCabins=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 quadruple cabins |
| quadrupleCabins=0-5 | Search all boats which have from 0 to 5 quadruple cabins |
| quadrupleCabins=0- | Search all boats which have 0 or more quadruple cabins |
| quadrupleCabins=-6 | Search all boats which have 6 or less quadruple cabins |
cabinsWithBunkBed:
string
(string)
in query
cabinsWithBunkBed parameter can be number or numbers of cabins with bunk bed separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| cabinsWithBunkBed=3 | Search all boats which have 3 cabins with bunk bed |
| cabinsWithBunkBed=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 cabins with bunk bed |
| cabinsWithBunkBed=0-5 | Search all boats which have from 0 to 5 cabins with bunk bed |
| cabinsWithBunkBed=0- | Search all boats which have 0 or more cabins with bunk bed |
| cabinsWithBunkBed=-6 | Search all boats which have 6 or less cabins with bunk bed |
toilets:
string
(string)
in query
Number of toilets.
Toilets parameter can be number or numbers of toilets separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| toilets=3 | Search all boats which have 3 toilets |
| toilets=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 toilets |
| toilets=0-5 | Search all boats which have from 0 to 5 toilets |
| toilets=0- | Search all boats which have 0 or more toilets |
| toilets=-6 | Search all boats which have 6 or less toilets |
year:
string
(string)
in query
Year of manufacturing boat.
| Examples: | Description |
|---|---|
| year=2003 | Search all boats which year of manufacturing is 2015 |
| year=2002,2003,2004 | Search all boats which year of manufacturing is 2002 or 2003 or 2004 |
| year=2002-2005 | Search all boats which year of manufacturing is from 2002 to 2005 |
| year=2005- | Search all boats which year of manufacturing is 2005 or more |
| year=-2010 | Search all boats which year of manufacturing is 2010 or less |
manufacturer:
string
in query
Boat manufacturer
Using this parameter will search all boats which are manufactured by specified manufacturer.
It's possible search by more manufacturers separated by comma (,)
| Examples | Description |
|---|---|
| manufacturer=Bavaria | Return all boats manufactured by Bavaria |
| manufacturer=Bavaria,Elan | Return all boats manufactured by Bavaria or Elam |
In this parameter is possible specify models of boats for every Manufacturer. Models have to be separated by semilocon (;)
| Examples | Description |
|---|---|
| manufacturer=Bavaria[46;35] | Return all boats Bavaria model 46 or 35 |
| manufacturer=Bavaria[46;35],Elan[40;50] | Return all boats Bavaria model 46 or 35 and Elan models 40 or 50 |
boatLength:
string
in query
Boat length. Can be number which can be combined, separated by comma (,) or range in format 'X-Y' in meters
| Examples: | Description |
|---|---|
| boatLength=5 | Search all boats which length is equals 5 meters |
| boatLength=small | Search all boats which length is greater than or equals 0 and less than 10 meters |
| boatLength=small,medium | Search all boats which length is greater than or equals 0 and less than 12 meters |
| boatLength=0-5 | Search all boats which have length from 0 to 5 meters |
| boatLength=2- | Search all boats which have length 2 or more meters |
| boatLength=-6 | Search all boats which have 6 meters or less |
charter:
string
in query
Charter of boat
Using this parameter will search all boats belong specified charter. Charter is specified by it's name. At this moment, charters don't have slug option allowed. If charter name contains specific characters, use functions to encode strings into url parameters. F.e: in javascript encodeURIComponent.
It's possible search by more charters separated by comma (,)
| Examples | Description |
|---|---|
| charter=Euronautic | Return all boats belong to Euronautic charter |
| charter=Euronautic,Pitter Yachtcharter | Return all boats belong to Euronautic or Pitter Yachtcharter |
price:
string
in query
Average price of boat per day.
Using this parameter will search all boats which have average price per day in defined range It's possible search by more ranges separated by comma (,)
Using price parameter depends on currency parameter (default currency is EUR).
| Examples | Description |
|---|---|
| price=[0-142] | Return all boats which average price for day is 0-142 (EUR) |
| price=[0-142],[285-428] | Return all boats which average price for day is 0-142 (EUR) or 285-428 (EUR) |
coordinates:
string
(string)
in query
Rectangle coordinates.
Coordinates define area (rectangle) in which boats are located.
Format have to be: bottom left corner and upper right corner.
https://docs.mongodb.com/manual/reference/operator/query/box/
Example:
coordinates=40.79,18.40,48.58,11.74
near:
string
(string)
in query
Near define area from which will be taken radius 30km.
Format have to be: first parameter is Latitude and second is Longitude.
**Example:**
near=40.79,18.40
zoom:
string
(integer)
in query
Current zoom of map.
Zoom parameter is used for group boats by destination. For creating markers on map.
| Value | Description |
|---|---|
| 0-5 | Group boats by Country |
| 6-9 | Group boats by City |
| 10+ | Group boats by Marina |
lang:
string
(string)
en_EN,
en_GB,
en_US,
cs_CZ,
sk_SK,
no_NO,
nb_NO,
sv_SE,
da_DK,
fi_FI,
de_DE,
fr_FR,
pl_PL,
it_IT,
nl_NL,
hu_HU,
ru_RU,
ru_UA,
es_ES,
sl_SI,
hr_HR,
bg_BG,
ro_RO,
lv_LV,
pt_PT,
el_GR,
et_EE,
lt_LT,
tr_TR,
is_IS,
sr_RS,
ca_ES,
en_AU
en_EN
in query
Language of parameters names.
sail:
string
in query
Type of main sail. Can be: (classic, roll) which can be combined, separated by comma (,) or english name separated by comma (,)
| Value | Description |
|---|---|
| classic | Search all boats which have classic main sail |
| roll | Search all boats which have rolling main sail |
| Classical mainsail | Search all boats which have classic main sail |
| Rolling mainsail | Search all boats which have rolling sail |
| No sail | Search all boats which don't have sail |
cockpit:
string
in query
Boat interior:
Return all boats contain selected boat amenities. Values can be combined, separated by comma (,)
| Value |
|---|
| Air condition |
| Cooker |
| Dishwasher |
| Freezer |
| Grill |
| Heating |
| Kitchen utensils |
| Microwave |
| Oven |
| Pillows and blankets |
| Refrigerator |
| Shower |
| Sink |
| Towels |
| Coffee machine |
| Ice maker |
| Washing machine |
| Examples | Description |
|---|---|
| cockpit=Grill,Shower,Microwave | Return all boats which contain grill, shower and microwave |
entertainment:
string
in query
Boat entertainment:
Return all boats contain selected boat amenities. Values can be combined, separated by comma (,)
| Value |
|---|
| Inside cockpit speakers |
| Karaoke |
| Kayak |
| LCD TV |
| Outside deck speakers |
| Radio CD / MP3 player |
| Snorkel sets |
| Water skis |
| Wakeboard |
| Bathing platform |
| Stand Up Paddle |
| Bicycle |
| Jet ski |
| Game console |
| DVD Player |
| Examples | Description |
|---|---|
| entertainment=Kayak,LCD TV,Karaoke | Return all boats which contain kayak, LCD TV and karaoke |
equipment:
string
in query
Navigation and safety:
Return all boats contain selected boat amenities. Values can be combined, separated by comma (,)
| Value |
|---|
| Bow thruster |
| Solar panels |
| Bimini |
| Cockpit GPS autopilot |
| Deck GPS autopilot |
| Dinghy |
| Spinnaker |
| Teak deck |
| Jacuzzi |
| Generator |
| Electric winches |
| Flybridge |
| Radar |
| Inverter |
| Autopilot |
| Examples | Description |
|---|---|
| equipment=Jacuzzi,Radar,Dinghy | Return all boats which contain jacuzzi, radar and dinghy |
skipper:
string
in query
Return all boats which have skipper included in price or search by crewed boat and bareboat
| Examples | Description |
|---|---|
| Bareboat | Return all boats which have no crew |
| Crewed | Return all boats which have crew |
currency:
string
EUR,
USD,
CZK,
GBP,
HUF,
DKK,
PLN,
SEK,
NOK,
RUB,
RON,
CHF,
ISK,
TRY,
CAD,
AUD,
ILS,
THB
EUR
in query
Currency standard codes - https://www.xe.com/iso4217.php
200 OK
Success
400 Bad Request
Invalid request, usually caused by invalid parameter values
500 Internal Server Error
Server error
Response Example (200 OK)
{
"data": [
{
"_id": "null",
"totalResults": "integer",
"data": [
{
"name": "string",
"slug": "string",
"type": "string",
"totalBoats": "integer",
"location": {
"type": "string",
"coordinates": [
"number"
]
}
}
]
}
],
"statusCode": "integer",
"status": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"errors": [
null
]
}
Response Example (500 Internal Server Error)
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
Nearest locations
GET /nearest-locations/
Returns nearest locations for given location (works only for marina and city location type) with available boats in max distance 50km
from:
string
in query
Location from which is calculated nearest locations - accepts location search_slug
exclude:
string
in query
Excluded location slugs (search_slug parameter on location), more locations separated by comma Example: marina-kornati,marina-punat
limit:
number
1 ≤ x ≤ 10
3
in query
Limit for nearest location count
lang:
string
(string)
en_EN,
en_GB,
en_US,
cs_CZ,
sk_SK,
no_NO,
nb_NO,
sv_SE,
da_DK,
fi_FI,
de_DE,
fr_FR,
pl_PL,
it_IT,
nl_NL,
hu_HU,
ru_RU,
ru_UA,
es_ES,
sl_SI,
hr_HR,
bg_BG,
ro_RO,
lv_LV,
pt_PT,
el_GR,
et_EE,
lt_LT,
tr_TR,
is_IS,
sr_RS,
ca_ES,
en_AU
en_EN
in query
Language of parameters names.
200 OK
Success
400 Bad Request
Invalid request, usually caused by invalid parameter values
500 Internal Server Error
Server error
Response Example (200 OK)
{
"data": [
{
"data": [
{
"type": "string",
"coordinates": [
"integer"
],
"name": "string",
"image": "string",
"boats": "integer",
"distance": "integer"
}
]
}
],
"statusCode": "integer",
"status": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"errors": [
null
]
}
Response Example (500 Internal Server Error)
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
Experience
Search
Returns an array of available experiences in selected range of dates(checkIn and checkOut). If checkIn or checkOut parameter is not defined, return boats with minimal price per day. We are limiting results to 18 per page.
checkIn:
string
(string)
in query
Start date, when order start. Format YYYY-MM-DD.
checkOut:
string
(string)
in query
End date, when order end. Format YYYY-MM-DD.
destinations:
string[]
in query
Destinations of boat. Destinations can be country, region, city or marina.
country:
string
(string)
in query
Country, where boat is located.
region:
string
(string)
in query
Region in country, where boat is located.
city:
string
(string)
in query
City in country, where boat is located.
marina:
string
(string)
in query
Marina in city, where boat is located.
page:
integer
x ≥ 1
1
in query
Page of boats. Page setup offset for search.
maxSleeps:
string
(string)
in query
Max sleeps parameter can be number or numbers of max sleeps separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| maxSleeps=5 | Select all boats where can be 5 sleeps |
| maxSleeps=0-5 | Search all boats which have from 0 to 5 sleeps |
| maxSleeps=0- | Search all boats which have 0 or more sleeps |
| maxSleeps=-6 | Search all boats which have 6 or less sleeps |
allowedPeople:
string
(string)
in query
| Examples: | Description |
|---|---|
| allowedPeople=5 | Select all boats where can be 5 people |
| allowedPeople=0-5 | Search all boats which have from 0 to 5 people |
| allowedPeople=0- | Search all boats which have 0 or more people |
| allowedPeople=-6 | Search all boats which have 6 or less people |
cabins:
string
(string)
in query
Max number of cabins.
Cabins parameter can be number or numbers of cabins separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| cabins=3 | Search all boats which have 3 cabins |
| cabins=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 cabins |
| cabins=0-5 | Search all boats which have from 0 to 5 cabins |
| cabins=0- | Search all boats which have 0 or more cabins |
| cabins=-6 | Search all boats which have 6 or less cabins |
singleCabins:
string
(string)
in query
singleCabins parameter can be number or numbers of single cabins separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| singleCabins=3 | Search all boats which have 3 single cabins |
| singleCabins=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 single cabins |
| singleCabins=0-5 | Search all boats which have from 0 to 5 single cabins |
| singleCabins=0- | Search all boats which have 0 or more single cabins |
| singleCabins=-6 | Search all boats which have 6 or less single cabins |
doubleCabins:
string
(string)
in query
doubleCabins parameter can be number or numbers of double cabins separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| doubleCabins=3 | Search all boats which have 3 double cabins |
| doubleCabins=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 double cabins |
| doubleCabins=0-5 | Search all boats which have from 0 to 5 double cabins |
| doubleCabins=0- | Search all boats which have 0 or more double cabins |
| doubleCabins=-6 | Search all boats which have 6 or less double cabins |
tripleCabins:
string
(string)
in query
tripleCabins parameter can be number or numbers of triple cabins separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| tripleCabins=3 | Search all boats which have 3 triple cabins |
| tripleCabins=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 triple cabins |
| tripleCabins=0-5 | Search all boats which have from 0 to 5 triple cabins |
| tripleCabins=0- | Search all boats which have 0 or more triple cabins |
| tripleCabins=-6 | Search all boats which have 6 or less triple cabins |
quadrupleCabins:
string
(string)
in query
quadrupleCabins parameter can be number or numbers of quadruple cabins separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| quadrupleCabins=3 | Search all boats which have 3 quadruple cabins |
| quadrupleCabins=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 quadruple cabins |
| quadrupleCabins=0-5 | Search all boats which have from 0 to 5 quadruple cabins |
| quadrupleCabins=0- | Search all boats which have 0 or more quadruple cabins |
| quadrupleCabins=-6 | Search all boats which have 6 or less quadruple cabins |
cabinsWithBunkBed:
string
(string)
in query
cabinsWithBunkBed parameter can be number or numbers of cabins with bunk bed separated by comma (,) or range in format 'X-Y'
| Examples: | Description |
|---|---|
| cabinsWithBunkBed=3 | Search all boats which have 3 cabins with bunk bed |
| cabinsWithBunkBed=1,2,3,4 | Search all boats which have 1 or 2 or 3 or 4 cabins with bunk bed |
| cabinsWithBunkBed=0-5 | Search all boats which have from 0 to 5 cabins with bunk bed |
| cabinsWithBunkBed=0- | Search all boats which have 0 or more cabins with bunk bed |
| cabinsWithBunkBed=-6 | Search all boats which have 6 or less cabins with bunk bed |
charter:
string
in query
Charter of boat
Using this parameter will search all boats belong specified charter. Charter is specified by it's name. At this moment, charters don't have slug option allowed. If charter name contains specific characters, use functions to encode strings into url parameters. F.e: in javascript encodeURIComponent.
It's possible search by more charters separated by comma (,)
| Examples | Description |
|---|---|
| charter=Euronautic | Return all boats belong to Euronautic charter |
| charter=Euronautic,Pitter Yachtcharter | Return all boats belong to Euronautic or Pitter Yachtcharter |
price:
string
in query
Average price of boat per day.
Using this parameter will search all boats which have average price per day in defined range It's possible search by more ranges separated by comma (,)
Using price parameter depends on currency parameter (default currency is EUR).
| Examples | Description |
|---|---|
| price=[0-142] | Return all boats which average price for day is 0-142 (EUR) |
| price=[0-142],[285-428] | Return all boats which average price for day is 0-142 (EUR) or 285-428 (EUR) |
coordinates:
string
(string)
in query
Rectangle coordinates.
Coordinates define area (rectangle) in which boats are located.
Format have to be: bottom left corner and upper right corner.
https://docs.mongodb.com/manual/reference/operator/query/box/
Example:
coordinates=40.79,18.40,48.58,11.74
near:
string
(string)
in query
Near define area from which will be taken radius 30km.
Format have to be: first parameter is Latitude and second is Longitude.
**Example:**
near=40.79,18.40
zoom:
string
(integer)
in query
Current zoom of map.
Zoom parameter is used for group boats by destination. For creating markers on map.
| Value | Description |
|---|---|
| 0-5 | Group boats by Country |
| 6-9 | Group boats by City |
| 10+ | Group boats by Marina |
lang:
string
(string)
en_EN,
en_GB,
en_US,
cs_CZ,
sk_SK,
no_NO,
nb_NO,
sv_SE,
da_DK,
fi_FI,
de_DE,
fr_FR,
pl_PL,
it_IT,
nl_NL,
hu_HU,
ru_RU,
ru_UA,
es_ES,
sl_SI,
hr_HR,
bg_BG,
ro_RO,
lv_LV,
pt_PT,
el_GR,
et_EE,
lt_LT,
tr_TR,
is_IS,
sr_RS,
ca_ES,
en_AU
en_EN
in query
Language of parameters names.
limit:
integer
1 ≤ x ≤ 50
18
in query
Limit results query.
sort:
string
priceDown,
priceUp,
discountDown,
discountUp,
reviewsDown,
reviewsCountDown,
rank,
rankWithoutDotd,
dealsFirst,
cheapestDealsFirst,
extra,
prepaymentDown,
prepaymentUp,
freeCancellation
rank
in query
Type of sorting
| Value | Description |
|---|---|
| priceDown | Sort result by price ascending |
| priceUp | Sort result by price descending |
| discountDown | Sort result by discount ascending |
| discountUp | Sort result by discount descending |
| reviewsDown | Sort result by reviews score descending |
| rank | Sort result by rank descending (rank - score from content score, reviews, comersion score) |
| dealsFirst | Sort result by rank descending (rank - score from content score, reviews, comersion score) with special deals on the top |
| cheapestDealsFirst | Sort result by rank descending (rank - score from content score, reviews, comersion score) with cheapest special deals on the top |
| rankWithoutDotd | Sort result by rank (dofd will not be as first result) |
| extra | Sort result by extra discount |
| prepaymentDown | Sort result by prepayment percentage ascending |
| prepaymentUp | Sort result by prepayment percentage descending |
| freeCancellation | Sort result by free cancellation |
cockpit:
string
in query
Boat interior:
Return all boats contain selected boat amenities. Values can be combined, separated by comma (,)
| Value |
|---|
| Air condition |
| Cooker |
| Dishwasher |
| Freezer |
| Grill |
| Heating |
| Kitchen utensils |
| Microwave |
| Oven |
| Pillows and blankets |
| Refrigerator |
| Shower |
| Sink |
| Towels |
| Coffee machine |
| Ice maker |
| Washing machine |
| Examples | Description |
|---|---|
| cockpit=Grill,Shower,Microwave | Return all boats which contain grill, shower and microwave |
entertainment:
string
in query
Boat entertainment:
Return all boats contain selected boat amenities. Values can be combined, separated by comma (,)
| Value |
|---|
| Inside cockpit speakers |
| Karaoke |
| Kayak |
| LCD TV |
| Outside deck speakers |
| Radio CD / MP3 player |
| Snorkel sets |
| Water skis |
| Wakeboard |
| Bathing platform |
| Stand Up Paddle |
| Bicycle |
| Jet ski |
| Game console |
| DVD Player |
| Examples | Description |
|---|---|
| entertainment=Kayak,LCD TV,Karaoke | Return all boats which contain kayak, LCD TV and karaoke |
equipment:
string
in query
Navigation and safety:
Return all boats contain selected boat amenities. Values can be combined, separated by comma (,)
| Value |
|---|
| Bow thruster |
| Solar panels |
| Bimini |
| Cockpit GPS autopilot |
| Deck GPS autopilot |
| Dinghy |
| Spinnaker |
| Teak deck |
| Jacuzzi |
| Generator |
| Electric winches |
| Flybridge |
| Radar |
| Inverter |
| Autopilot |
| Examples | Description |
|---|---|
| equipment=Jacuzzi,Radar,Dinghy | Return all boats which contain jacuzzi, radar and dinghy |
currency:
string
EUR,
USD,
CZK,
GBP,
HUF,
DKK,
PLN,
SEK,
NOK,
RUB,
RON,
CHF,
ISK,
TRY,
CAD,
AUD,
ILS,
THB
EUR
in query
Currency standard codes - https://www.xe.com/iso4217.php
tripType:
string
(string)
in query
Trip type of experience.
It's possible search by more trip types separated by comma (,)
| Value | Description |
|---|---|
| sunset-boat | Rerurn all Sunset Boat experiences |
| Examples: | Description |
|---|---|
| tripType=sunset-boat | Return all Sunset Boat experiences |
cancellation:
string
free
in query
Defines if the search returns only boats with certain cancellation policy
slugs:
string
in query
List of unique boat slugs.
200 OK
Success
204 No Content
No Content (no boats), but filter's possible values are returned
default
Error
Response Example (200 OK)
{
"data": {
"_id": "null",
"data": [
{
"old_id": "integer",
"slug": "string",
"parameters": {
"cabins": "integer",
"max_sleeps": "integer",
"max_people": "integer",
"single_cabins": "integer",
"double_cabins": "integer",
"triple_cabins": "integer",
"quadruple_cabins": "integer",
"cabins_with_bunk_bed": "integer",
"saloon_sleeps": "integer",
"crew_sleeps": "integer"
},
"title": "string",
"thumb": "string (url)",
"main_img": "string (url)",
"gallery": [
"string (url)"
],
"boataroundExtra": "boolean",
"marina": "string",
"coordinates": [
"number"
],
"country": "string",
"region": "string",
"city": "string",
"flag": "string",
"usp": [
{
"name": "string",
"icon": "string",
"provider": "string"
}
],
"restrictions_covered": "object",
"cancellationInsurance": "object",
"freeBerths": "object",
"charter_rank": "object",
"charter": "string",
"charter_logo": "string",
"charter_id": "string",
"illustrated": "boolean",
"priceFrom": "number",
"currency": "string",
"price_type": "string",
"prepayment": "number",
"newboat": "boolean",
"lastCustomer": "string",
"rank": "number",
"views": "integer",
"noLicense": "string",
"reviewsScore": "integer",
"totalReviews": "null,integer",
"deal_of_the_day": "string (date)",
"isSpecialDealDay": "boolean",
"isSmartDeal": "boolean"
}
],
"totalBoats": "integer",
"totalResults": "integer",
"currentPage": "integer",
"skip": "integer",
"filter": {
"price": [
{
"_id": "integer",
"count": "integer"
}
],
"maxSleeps": [
{
"_id": "integer",
"count": "integer"
}
],
"allowedPeople": [
{
"_id": "integer",
"count": "integer"
}
],
"cockpit": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"entertainment": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"equipment": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"price_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"max_sleeps_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"cockpit_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"entertainment_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"equipment_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
]
}
},
"statusCode": "integer",
"status": "string"
}
Response Example (204 No Content)
{
"data": {
"_id": "null",
"totalBoats": "integer",
"totalResults": "integer",
"currentPage": "integer",
"skip": "integer",
"filter": {
"price": [
{
"_id": "integer",
"count": "integer"
}
],
"maxSleeps": [
{
"_id": "integer",
"count": "integer"
}
],
"allowedPeople": [
{
"_id": "integer",
"count": "integer"
}
],
"cockpit": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"entertainment": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"equipment": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"price_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"max_sleeps_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"cockpit_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"entertainment_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"equipment_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
]
}
},
"statusCode": "integer",
"status": "string"
}
Response Example (default )
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
Find destination
Returns 'An array of destinations
query:
string
(string)
in query
Query string.
sessionToken:
string
(string)
in query
UUIDv4 session token to group autocomplete request to one session
excludedSearches:
string[]
in query
Excluded selected results.
excludedTypes:
string[]
in query
Excluded types from results.
lang:
string
(string)
in query
Language.
limit:
integer
1 ≤ x ≤ 50
5
in query
Limit results.
ab:
string
in query
(no description)
200 OK
Success
400 Bad Request
Invalid request, usually caused by invalid parameter values
500 Internal Server Error
Server error
Response Example (200 OK)
{
"data": [
{
"total": "integer",
"icon": "string",
"name": "string",
"type": "string",
"autocomplete": "string",
"label": "string",
"expression": "string",
"is_google": "boolean"
}
],
"statusCode": "integer",
"status": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"errors": [
null
]
}
Response Example (500 Internal Server Error)
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
Price
GET /price/{slug}
Returns 'Price of the product' to the caller
slug:
string
in path
Product slug
checkIn:
string
(string)
in query
Start date, when order start. Format YYYY-MM-DD.
checkOut:
string
(string)
in query
End date, when order end. Format YYYY-MM-DD.
currency:
string
EUR,
USD,
CZK,
GBP,
HUF,
DKK,
PLN,
SEK,
NOK,
RUB,
RON,
CHF,
ISK,
TRY,
CAD,
AUD,
ILS,
THB
EUR
in query
Currency standard codes - https://www.xe.com/iso4217.php
lang:
string
(string)
en_EN,
en_GB,
en_US,
cs_CZ,
sk_SK,
no_NO,
nb_NO,
sv_SE,
da_DK,
fi_FI,
de_DE,
fr_FR,
pl_PL,
it_IT,
nl_NL,
hu_HU,
ru_RU,
ru_UA,
es_ES,
sl_SI,
hr_HR,
bg_BG,
ro_RO,
lv_LV,
pt_PT,
el_GR,
et_EE,
lt_LT,
tr_TR,
is_IS,
sr_RS,
ca_ES,
en_AU
en_EN
in query
Language of parameters names.
loggedIn:
string
in query
Defines if the user if logged in, value is either 0 or 1
200 OK
Success
default
Error
Response Example (200 OK)
{
"data": [
{
"_id": "null",
"totalResults": "integer",
"data": [
{
"_id": "string",
"slug": "string",
"title": "string",
"thumb": "string (url)",
"main_img": "string (url)",
"boataroundExtra": "boolean",
"marina": "string",
"country": "string",
"region": "string",
"city": "string",
"flag": "string",
"license": [
"string"
],
"charter": "string",
"charter_id": "string",
"coordinates": [
"number"
],
"views": "integer",
"usp": [
{
"name": "string",
"icon": "string",
"provider": "string"
}
],
"reviewsScore": "integer",
"currency": "string",
"price": "number",
"totalPrice": "number",
"discount": "number",
"period": "integer",
"deal_of_the_day": "string (date)",
"restrictions_covered": "object",
"cancellationInsurance": "object",
"freeBerths": "object",
"charter_rank": "object",
"isSmartDeal": "boolean"
}
]
}
],
"statusCode": "integer",
"status": "string"
}
Response Example (default )
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
Categories
GET /categories/all
Return array of categories with their language translation and total boats
lang:
string
(string)
en_EN,
en_GB,
en_US,
cs_CZ,
sk_SK,
no_NO,
nb_NO,
sv_SE,
da_DK,
fi_FI,
de_DE,
fr_FR,
pl_PL,
it_IT,
nl_NL,
hu_HU,
ru_RU,
ru_UA,
es_ES,
sl_SI,
hr_HR,
bg_BG,
ro_RO,
lv_LV,
pt_PT,
el_GR,
et_EE,
lt_LT,
tr_TR,
is_IS,
sr_RS,
ca_ES,
en_AU
en_EN
in query
Language of parameters names.
country:
string
(string)
in query
Country, where boat is located.
region:
string
(string)
in query
Region in country, where boat is located.
city:
string
(string)
in query
City in country, where boat is located.
marina:
string
(string)
in query
Marina in city, where boat is located.
currency:
string
EUR,
USD,
CZK,
GBP,
HUF,
DKK,
PLN,
SEK,
NOK,
RUB,
RON,
CHF,
ISK,
TRY,
CAD,
AUD,
ILS,
THB
EUR
in query
Currency standard codes - https://www.xe.com/iso4217.php
200 OK
Success
default
Error
Response Example (200 OK)
{
"data": [
{
"_id": "string",
"title": "string",
"priceFrom": "number",
"currency": "string",
"totalBoats": "integer"
}
],
"statusCode": "integer",
"status": "string"
}
Response Example (default )
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
default
GET /categories/{category}/popularCountries
returns popular countries for a specific boat category based on the number of boats of this category in a country
category:
string
in path
(no description)
lang:
string
(string)
en_EN,
en_GB,
en_US,
cs_CZ,
sk_SK,
no_NO,
nb_NO,
sv_SE,
da_DK,
fi_FI,
de_DE,
fr_FR,
pl_PL,
it_IT,
nl_NL,
hu_HU,
ru_RU,
ru_UA,
es_ES,
sl_SI,
hr_HR,
bg_BG,
ro_RO,
lv_LV,
pt_PT,
el_GR,
et_EE,
lt_LT,
tr_TR,
is_IS,
sr_RS,
ca_ES,
en_AU
en_EN
in query
Language of parameters names.
limit:
integer
1 ≤ x ≤ 50
18
in query
Limit results query.
Success
default
Error
Response Content-Types: application/json
Response Example (200 OK)
{
"countries": [
{
"name": "string",
"search_slug": "string"
}
]
}
Response Example (default )
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
Destinations
GET /destinations/nearest
Returns near destinations of searchSlug
searchSlug:
string
in query
destination search slug
excludedSearches:
string
in query
Excluded location slugs, more locations separated by comma Example: marina-kornati,marina-punat
limit:
integer
1 ≤ x ≤ 20
5
in query
limit of results
lang:
string
(string)
en_EN,
en_GB,
en_US,
cs_CZ,
sk_SK,
no_NO,
nb_NO,
sv_SE,
da_DK,
fi_FI,
de_DE,
fr_FR,
pl_PL,
it_IT,
nl_NL,
hu_HU,
ru_RU,
ru_UA,
es_ES,
sl_SI,
hr_HR,
bg_BG,
ro_RO,
lv_LV,
pt_PT,
el_GR,
et_EE,
lt_LT,
tr_TR,
is_IS,
sr_RS,
ca_ES,
en_AU
en_EN
in query
Language of parameters names.
200 OK
Success
default
Error
Response Content-Types: application/json
Response Example (200 OK)
{
"data": [
{
"total": "integer",
"icon": "string",
"name": "string",
"type": "string",
"autocomplete": "string",
"label": "string",
"expression": "string",
"is_google": "boolean"
}
],
"statusCode": "integer",
"status": "string"
}
Response Example (default )
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
Schema Definitions
Boat: object
- _id: string
- old_id: integer
- slug: string
- parameters: BoatParameters
- title: string
- thumb: string
-
(Deprecated, use main_img instead)
- main_img: string
- boataroundExtra: boolean
- marina: string
- region: string
- city: string
- category: string
- flag: string
- sail: string
- captain: string[]
-
string - specials: BoatSpecial
-
BoatSpecial - charter: string
- charter_id: string
- manufacturer: string
- illustrated: boolean
- prepayment: number (integer)
- newBoat: boolean
- rank: number (double)
- views: number (integer)
- score: number (integer)
- licence: string[]
-
string - reviewsScore: number (integer)
- totalReviews: number (integer)
- avg_price: number (integer)
- currency: string
- price: number (integer)
- totalPrice: number (integer)
- discount: number (integer)
- extended_discounts: number (integer)
- period: number (integer)
Example
{
"_id": "string",
"old_id": "integer",
"slug": "string",
"parameters": {
"engine": "string",
"toilets": "number (integer)",
"cabins": "number (integer)",
"year": "number (integer)",
"max_sleeps": "number (integer)",
"beam": "number",
"length": "number (double)",
"draft": "number",
"maximum_speed": "number",
"fuel": "number",
"cruising_consumption": "number"
},
"title": "string",
"thumb": "string",
"main_img": "string",
"boataroundExtra": "boolean",
"marina": "string",
"region": "string",
"city": "string",
"category": "string",
"flag": "string",
"sail": "string",
"captain": [
"string"
],
"specials": [
{
"id": "string",
"name": "string",
"icon": "string"
}
],
"charter": "string",
"charter_id": "string",
"manufacturer": "string",
"illustrated": "boolean",
"prepayment": "number (integer)",
"newBoat": "boolean",
"rank": "number (double)",
"views": "number (integer)",
"score": "number (integer)",
"licence": [
"string"
],
"reviewsScore": "number (integer)",
"totalReviews": "number (integer)",
"avg_price": "number (integer)",
"currency": "string",
"price": "number (integer)",
"totalPrice": "number (integer)",
"discount": "number (integer)",
"extended_discounts": "number (integer)",
"period": "number (integer)"
}
BoatCategorySlug: string
Unique slug identifier for a boat category.
RentalPeriod: object
- from: integer
- to: integer
- los: object
- drop_off_day: integer
- slots: string[]
-
string
Example
{
"from": "integer",
"to": "integer",
"los": "object",
"drop_off_day": "integer",
"slots": [
"string"
]
}
RentalPeriods: object
- status: string
- data: object[]
-
object - 0: RentalPeriod
- 1: RentalPeriod
- 2: RentalPeriod
- 3: RentalPeriod
- 4: RentalPeriod
- 5: RentalPeriod
- 6: RentalPeriod
- statusCode: integer
Example
{
"status": "string",
"data": [
{
"0": {
"from": "integer",
"to": "integer",
"los": "object",
"drop_off_day": "integer",
"slots": [
"string"
]
},
"1": {
"from": "integer",
"to": "integer",
"los": "object",
"drop_off_day": "integer",
"slots": [
"string"
]
},
"2": {
"from": "integer",
"to": "integer",
"los": "object",
"drop_off_day": "integer",
"slots": [
"string"
]
},
"3": {
"from": "integer",
"to": "integer",
"los": "object",
"drop_off_day": "integer",
"slots": [
"string"
]
},
"4": {
"from": "integer",
"to": "integer",
"los": "object",
"drop_off_day": "integer",
"slots": [
"string"
]
},
"5": {
"from": "integer",
"to": "integer",
"los": "object",
"drop_off_day": "integer",
"slots": [
"string"
]
},
"6": {
"from": "integer",
"to": "integer",
"los": "object",
"drop_off_day": "integer",
"slots": [
"string"
]
}
}
],
"statusCode": "integer"
}
PopularRentalPeriods: object
- status: string
- data: object[]
-
object - period: string
- statusCode: integer
Example
{
"status": "string",
"data": [
{
"period": "string"
}
],
"statusCode": "integer"
}
NearLocation:
- type: string
-
Location type, one of: marina, city
- coordinates: integer[]
-
integer - name: string
-
The translated name of a location in the given lang parameter
- image: string
- boats: integer
-
Count of available boats in this location
- distance: integer
-
Distance in meters from base locations
Example
{
"type": "string",
"coordinates": [
"integer"
],
"name": "string",
"image": "string",
"boats": "integer",
"distance": "integer"
}
BoatParameters: object
- engine: string
- toilets: number (integer)
- cabins: number (integer)
- year: number (integer)
- max_sleeps: number (integer)
- beam: number
- length: number (double)
- draft: number
- maximum_speed: number
- fuel: number
- cruising_consumption: number
Example
{
"engine": "string",
"toilets": "number (integer)",
"cabins": "number (integer)",
"year": "number (integer)",
"max_sleeps": "number (integer)",
"beam": "number",
"length": "number (double)",
"draft": "number",
"maximum_speed": "number",
"fuel": "number",
"cruising_consumption": "number"
}
BoatSpecial: object
- id: string
- name: string
- icon: string
Example
{
"id": "string",
"name": "string",
"icon": "string"
}
ReviewsAnswer: object
- field_id: string
- answer: string
- type: string
Example
{
"field_id": "string",
"answer": "string",
"type": "string"
}
ReviewTemplate: object
- template: object
-
- b_slug: string
- b_name: string
- u_name: string
- u_email: string
- u_comm_lang: string
- u_comm: string
- crea_date: object
-
- crea_date_s: string (date)
- crea_date_i: integer (integer)
Example
{
"template": {
"b_slug": "string",
"b_name": "string",
"u_name": "string",
"u_email": "string",
"u_comm_lang": "string",
"u_comm": "string",
"crea_date": {
"crea_date_s": "string (date)",
"crea_date_i": "integer (integer)"
}
}
}
Review: object
- _id: string
- reviews: object
-
- comment: string
- comment_original: string
- comment_dislike: string
- comment_dislike_original: string
- user: string
- score: integer
- experience: object
-
- boat: integer
- check_in: integer
- charter: integer
- marina: integer
- overall: integer
- lang: string
- created_at: string
- translated: integer
- totalScore: integer
- totalReviews: integer
- totalResults: integer
Example
{
"_id": "string",
"reviews": {
"comment": "string",
"comment_original": "string",
"comment_dislike": "string",
"comment_dislike_original": "string",
"user": "string",
"score": "integer",
"experience": {
"boat": "integer",
"check_in": "integer",
"charter": "integer",
"marina": "integer",
"overall": "integer"
},
"lang": "string",
"created_at": "string",
"translated": "integer"
},
"totalScore": "integer",
"totalReviews": "integer",
"totalResults": "integer"
}
CharterScore: object
- status: string
- data: object[]
-
object - _id: string
- score: number
- statusCode: integer
Example
{
"status": "string",
"data": [
{
"_id": "string",
"score": "number"
}
],
"statusCode": "integer"
}
TrustpilotReviews: object
- status: string
- data: object[]
-
object - _id: string
- created_at: string
- stars: number
- text: string
- tag: string
- name: string
- statusCode: integer
Example
{
"status": "string",
"data": [
{
"_id": "string",
"created_at": "string",
"stars": "number",
"text": "string",
"tag": "string",
"name": "string"
}
],
"statusCode": "integer"
}
TrustpilotOverallScore: object
- status: string
- data: object[]
-
object - _id: string
- number_of_reviews: object
-
- total: integer
- score: object
-
- trust_score: integer
- stars: integer
- statusCode: integer
Example
{
"status": "string",
"data": [
{
"_id": "string",
"number_of_reviews": {
"total": "integer"
},
"score": {
"trust_score": "integer",
"stars": "integer"
}
}
],
"statusCode": "integer"
}
Destination: object
- _id: string
- name: string
- slug: string
- description: string
- old_id: string
- type: string
- translation: object
-
- en_EN: object
-
- name: string
- slug: string
- description: string
- sk_SK: object
-
- name: string
- slug: string
- description: string
- cs_CZ: object
-
- name: string
- slug: string
- description: string
- da_DK: object
-
- name: string
- slug: string
- description: string
- fi_FI: object
-
- name: string
- slug: string
- description: string
- no_NO: object
-
- name: string
- slug: string
- description: string
- sv_SE: object
-
- name: string
- slug: string
- description: string
- de_DE: object
-
- name: string
- slug: string
- description: string
- fr_FR: object
-
- name: string
- slug: string
- description: string
- pl_PL: object
-
- name: string
- slug: string
- description: string
- it_IT: object
-
- name: string
- slug: string
- description: string
- nl_NL: object
-
- name: string
- slug: string
- description: string
- hu_HU: object
-
- name: string
- slug: string
- description: string
- ru_RU: object
-
- name: string
- slug: string
- description: string
- ru_UA: object
-
- name: string
- slug: string
- description: string
- en_US: object
-
- name: string
- slug: string
- description: string
- es_ES: object
-
- name: string
- slug: string
- description: string
- sl_SI: object
-
- name: string
- slug: string
- description: string
- hr_HR: object
-
- name: string
- slug: string
- description: string
- bg_BG: object
-
- name: string
- slug: string
- description: string
- ro_RO: object
-
- name: string
- slug: string
- description: string
- lv_LV: object
-
- name: string
- slug: string
- description: string
- pt_PT: object
-
- name: string
- slug: string
- description: string
- el_GR: object
-
- name: string
- slug: string
- description: string
- et_EE: object
-
- name: string
- slug: string
- description: string
- lt_LT: object
-
- name: string
- slug: string
- description: string
- tr_TR: object
-
- name: string
- slug: string
- description: string
- is_IS: object
-
- name: string
- slug: string
- description: string
- sr_RS: object
-
- name: string
- slug: string
- description: string
- ca_ES: object
-
- name: string
- slug: string
- description: string
- en_AU: object
-
- name: string
- slug: string
- description: string
- regions: Region
-
Region
Example
{
"_id": "string",
"name": "string",
"slug": "string",
"description": "string",
"old_id": "string",
"type": "string",
"translation": {
"en_EN": {
"name": "string",
"slug": "string",
"description": "string"
},
"sk_SK": {
"name": "string",
"slug": "string",
"description": "string"
},
"cs_CZ": {
"name": "string",
"slug": "string",
"description": "string"
},
"da_DK": {
"name": "string",
"slug": "string",
"description": "string"
},
"fi_FI": {
"name": "string",
"slug": "string",
"description": "string"
},
"no_NO": {
"name": "string",
"slug": "string",
"description": "string"
},
"sv_SE": {
"name": "string",
"slug": "string",
"description": "string"
},
"de_DE": {
"name": "string",
"slug": "string",
"description": "string"
},
"fr_FR": {
"name": "string",
"slug": "string",
"description": "string"
},
"pl_PL": {
"name": "string",
"slug": "string",
"description": "string"
},
"it_IT": {
"name": "string",
"slug": "string",
"description": "string"
},
"nl_NL": {
"name": "string",
"slug": "string",
"description": "string"
},
"hu_HU": {
"name": "string",
"slug": "string",
"description": "string"
},
"ru_RU": {
"name": "string",
"slug": "string",
"description": "string"
},
"ru_UA": {
"name": "string",
"slug": "string",
"description": "string"
},
"en_US": {
"name": "string",
"slug": "string",
"description": "string"
},
"es_ES": {
"name": "string",
"slug": "string",
"description": "string"
},
"sl_SI": {
"name": "string",
"slug": "string",
"description": "string"
},
"hr_HR": {
"name": "string",
"slug": "string",
"description": "string"
},
"bg_BG": {
"name": "string",
"slug": "string",
"description": "string"
},
"ro_RO": {
"name": "string",
"slug": "string",
"description": "string"
},
"lv_LV": {
"name": "string",
"slug": "string",
"description": "string"
},
"pt_PT": {
"name": "string",
"slug": "string",
"description": "string"
},
"el_GR": {
"name": "string",
"slug": "string",
"description": "string"
},
"et_EE": {
"name": "string",
"slug": "string",
"description": "string"
},
"lt_LT": {
"name": "string",
"slug": "string",
"description": "string"
},
"tr_TR": {
"name": "string",
"slug": "string",
"description": "string"
},
"is_IS": {
"name": "string",
"slug": "string",
"description": "string"
},
"sr_RS": {
"name": "string",
"slug": "string",
"description": "string"
},
"ca_ES": {
"name": "string",
"slug": "string",
"description": "string"
},
"en_AU": {
"name": "string",
"slug": "string",
"description": "string"
}
},
"regions": [
null
]
}
Envelope:
- statusCode: integer
-
Response status
- status: string Success, Error
-
Textual representation of response status
Example
{
"statusCode": "integer",
"status": "string"
}
ErrorResponse:
- code: string
-
Error code
- message: string
-
Error message
Example
{
"code": "string",
"message": "string",
"statusCode": "integer",
"status": "string"
}
ValidationErrorResponse:
- message: string
- errors: object[]
-
Array of validation errors
-
object
Example
{
"message": "string",
"errors": [
null
]
}
Availability:
- chin: string (date)
-
check-in of boat reservation
- chout: string (date)
-
check-out of boat reservation
Example
{
"chin": "string (date)",
"chout": "string (date)"
}
BoatAvailabilityBase:
- _id: integer
-
Boat id value
- title: string
-
Boataround boat title. String is cantenated with Manufacturer name, Model number, "|" and Boat name
- slug: string
-
Unique url slug for boat without domain path. Url is generated from boat title
- cabins: integer
-
Number of cabins in the boat
- year: integer
-
Year of construction
- marina: string
-
Marina in city, where boat is located
Example
{
"_id": "integer",
"title": "string",
"slug": "string",
"cabins": "integer",
"year": "integer",
"marina": "string"
}
BoatAvailability:
- charter: string
-
Boat charter name
- availabilities: Availability
-
Check-in and check-out of each boat reservation
-
Availability
Example
{
"charter": "string",
"availabilities": [
{
"chin": "string (date)",
"chout": "string (date)"
}
],
"_id": "integer",
"title": "string",
"slug": "string",
"cabins": "integer",
"year": "integer",
"marina": "string"
}
BoatAvailabilityWithDotdListResponse:
- data: BoatAvailability
-
Boat availability information
-
BoatAvailability
Example
{
"data": [
{
"charter": "string",
"availabilities": [
{
"chin": "string (date)",
"chout": "string (date)"
}
],
"_id": "integer",
"title": "string",
"slug": "string",
"cabins": "integer",
"year": "integer",
"marina": "string"
}
],
"statusCode": "integer",
"status": "string"
}
Location:
- name: string
-
Location name
- slug: string
-
Location slug
- type: string city, country, marina, region
-
Type of loaction
- totalBoats: integer
-
Number of boats in given location
- location: object
-
- type: string point
- coordinates: number[]
-
Array with two elements representing geographic coordinates
-
number
Example
{
"name": "string",
"slug": "string",
"type": "string",
"totalBoats": "integer",
"location": {
"type": "string",
"coordinates": [
"number"
]
}
}
LocationsResponse:
- data: object[]
-
Contains an array with single element representing operation result
-
object
Example
{
"data": [
{
"_id": "null",
"totalResults": "integer",
"data": [
{
"name": "string",
"slug": "string",
"type": "string",
"totalBoats": "integer",
"location": {
"type": "string",
"coordinates": [
"number"
]
}
}
]
}
],
"statusCode": "integer",
"status": "string"
}
NearestLocationsResponse:
- data: object[]
-
Contains an array with single element representing operation result
-
object - data: NearLocation
-
Array with locations
-
NearLocation
Example
{
"data": [
{
"data": [
{
"type": "string",
"coordinates": [
"integer"
],
"name": "string",
"image": "string",
"boats": "integer",
"distance": "integer"
}
]
}
],
"statusCode": "integer",
"status": "string"
}
BoatsPopularStaffResponse:
- data: object[]
-
object - slug: string
-
Slug of boat stuff
- name: string
-
Name of boat stuff
- total: integer
-
Number of boats by given stuff
Example
{
"data": [
{
"slug": "string",
"name": "string",
"total": "integer"
}
],
"statusCode": "integer",
"status": "string"
}
BoatsSimilarPrice:
- data: object[]
-
object - prices_list: object[]
-
object - _id: string
- price: number
- year: integer
- length: integer
- category: string
- prices: object[]
-
object - year: integer
- years: integer[]
-
integer - length: integer
- category: string
- prices: number[]
-
number - size: integer
- sizes: integer[]
-
integer
Example
{
"data": [
{
"prices_list": [
{
"_id": "string",
"price": "number",
"year": "integer",
"length": "integer",
"category": "string"
}
],
"prices": [
{
"year": "integer",
"years": [
"integer"
],
"length": "integer",
"category": "string",
"prices": [
"number"
],
"size": "integer"
}
],
"sizes": [
"integer"
]
}
],
"statusCode": "integer",
"status": "string"
}
BoatsSimilarPriceNoContent:
- data: object[]
-
object - prices_list: object[]
-
object - prices: object[]
-
object - sizes: integer[]
-
integer
Example
{
"data": [
{
"prices_list": [
"object"
],
"prices": [
"object"
],
"sizes": [
"integer"
]
}
],
"statusCode": "integer",
"status": "string"
}
AutocompleteRecord:
- total: integer
-
Number of boats associated with given record
- icon: string
-
HTML class name representing icon for the record
- name: string
-
Name of the record
- type: string
-
Type of record
- autocomplete: string
-
Autocomplete value matched against query
- label: string
-
Label of the record
- expression: string
- is_google: boolean
Example
{
"total": "integer",
"icon": "string",
"name": "string",
"type": "string",
"autocomplete": "string",
"label": "string",
"expression": "string",
"is_google": "boolean"
}
AutocompleteResponse:
- data: AutocompleteRecord
-
List of autocomplete records
-
AutocompleteRecord
Example
{
"data": [
{
"total": "integer",
"icon": "string",
"name": "string",
"type": "string",
"autocomplete": "string",
"label": "string",
"expression": "string",
"is_google": "boolean"
}
],
"statusCode": "integer",
"status": "string"
}
SimpleBoatsResponse:
Example
{
"data": [
{
"id": "null",
"totalBoats": "integer",
"totalResults": "integer",
"data": [
{
"_id": "string",
"title": "string",
"slug": "string",
"thumb": "string (url)",
"main_img": "string (url)",
"max_sleeps": "integer",
"cabins": "integer",
"year": "integer",
"marina": "string",
"city": "string",
"country": "string",
"region": "string",
"category": "string",
"flag": "string"
}
]
}
],
"statusCode": "integer",
"status": "string"
}
SimpleBoat:
- _id: string
- title: string
- slug: string
- thumb: string (url)
-
(Deprecated, use main_img instead)
- main_img: string (url)
- max_sleeps: integer
- cabins: integer
- year: integer
- marina: string
- city: string
- country: string
- region: string
- category: string
- flag: string
Example
{
"_id": "string",
"title": "string",
"slug": "string",
"thumb": "string (url)",
"main_img": "string (url)",
"max_sleeps": "integer",
"cabins": "integer",
"year": "integer",
"marina": "string",
"city": "string",
"country": "string",
"region": "string",
"category": "string",
"flag": "string"
}
SimpleBoatsResult:
- id: null
- totalBoats: integer
- totalResults: integer
- data: SimpleBoat
-
SimpleBoat
Example
{
"id": "null",
"totalBoats": "integer",
"totalResults": "integer",
"data": [
{
"_id": "string",
"title": "string",
"slug": "string",
"thumb": "string (url)",
"main_img": "string (url)",
"max_sleeps": "integer",
"cabins": "integer",
"year": "integer",
"marina": "string",
"city": "string",
"country": "string",
"region": "string",
"category": "string",
"flag": "string"
}
]
}
ModelAutogenResponse:
- destinations: object[]
-
object - name: string
- search_slug: string
- parameters: object
-
- draught: number
- beam: number
- length: number
- max_sleeps: integer
- min_sleeps: integer
- max_cabins: integer
- min_cabins: integer
- max_year: integer
- min_year: integer
- max_total_engine_power: integer
- min_total_engine_power: integer
- amenities: string[]
-
list of amenities translated
-
string - sails: string[]
-
list of sails strings
-
string - category: string
- category_slug: string
- manual_autogen: string
-
manual_autogen filled in admin system translated
Example
{
"destinations": [
{
"name": "string",
"search_slug": "string"
}
],
"parameters": {
"draught": "number",
"beam": "number",
"length": "number",
"max_sleeps": "integer",
"min_sleeps": "integer",
"max_cabins": "integer",
"min_cabins": "integer",
"max_year": "integer",
"min_year": "integer",
"max_total_engine_power": "integer",
"min_total_engine_power": "integer"
},
"amenities": [
"string"
],
"sails": [
"string"
],
"category": "string",
"category_slug": "string",
"manual_autogen": "string"
}
ManufacturerAutogenResponse:
- manual_autogen: string
-
manual_autogen filled in admin system translated
Example
{
"manual_autogen": "string"
}
StaticPageAutogenResponse:
- description: string | null
-
Static page seo description content
Example
{
"description": "string"
}
CustomCategoryAutogenResponse:
- description: string | null
-
Custom category search page SEO content
Example
{
"description": "string"
}
SimpleDestinationRecord:
- slug: string
-
Destination slug
- name: string
-
Destination name in a given language
Example
{
"slug": "string",
"name": "string"
}
DiscoverAll:
- _id: string
- name: string
- image: string
- search_slug: string
Example
{
"_id": "string",
"name": "string",
"image": "string",
"search_slug": "string"
}
SimpleLocation:
- _id: string
- name: string
- types_poi: string[]
-
string - coordinates: number[]
-
Array with two elements representing geographic coordinates
-
number - description: string
- slug: string
Example
{
"_id": "string",
"name": "string",
"types_poi": [
"string"
],
"coordinates": [
"number"
],
"description": "string",
"slug": "string"
}
LocationResponse:
- _id: string
- name: string
- slug: string
- search_slug: string
- generated_description: string
- generated_highlight: string
- manual_autogen: string
- most_searched_content: string
- faqs: string
Example
{
"_id": "string",
"name": "string",
"slug": "string",
"search_slug": "string",
"generated_description": "string",
"generated_highlight": "string",
"manual_autogen": "string",
"most_searched_content": "string",
"faqs": "string"
}
CharterResponse:
- _id: string
- name: string
- slug: string
- generated_description: string
- manual_autogen: string
Example
{
"_id": "string",
"name": "string",
"slug": "string",
"generated_description": "string",
"manual_autogen": "string"
}
AllCategory:
- _id: string
-
Id of boat category (by default english cetegory slug, but also 'luxury' for the luxury boats that are not a boat category per se)
- title: string
-
Localized category name (except for the luxury boats for which 'Luxury' is sent for all languags)
- priceFrom: number
-
Minimal daily price of boat in given category
- currency: string
-
currency standard codes - https://www.xe.com/iso4217.php
- totalBoats: integer
-
Number of boat in given category
Example
{
"_id": "string",
"title": "string",
"priceFrom": "number",
"currency": "string",
"totalBoats": "integer"
}
AllCategoriesResponse:
- data: AllCategory
-
AllCategory
Example
{
"data": [
{
"_id": "string",
"title": "string",
"priceFrom": "number",
"currency": "string",
"totalBoats": "integer"
}
],
"statusCode": "integer",
"status": "string"
}
CategoryPopularCountriesResponse:
- countries: object[]
-
object - name: string
- search_slug: string
Example
{
"countries": [
{
"name": "string",
"search_slug": "string"
}
]
}
DestinationsResponse:
Example
{
"data": [
{
"_id": "string",
"lang": "string",
"flag": "string",
"geo": [
"number"
],
"boats": "integer",
"regions": [
{
"_id": "string",
"lang": "string",
"geo": [
"number"
],
"boats": "integer",
"cities": [
{
"_id": "string",
"lang": "string",
"geo": [
"number"
],
"boats": "integer",
"marinas": [
{
"_id": "string",
"geo": [
"number"
],
"boats": "integer"
}
]
}
]
}
]
}
],
"statusCode": "integer",
"status": "string"
}
DestinationCountry:
- _id: string
-
Country id (by default english country name)
- lang: string
-
Localized country name
- flag: string
-
Abbreviation of boat flag name
- geo: number[]
-
Array with two elements representing geographic coordinates
-
number - boats: integer
-
Number of boats in given country
- regions: DestinationRegion
-
DestinationRegion
Example
{
"_id": "string",
"lang": "string",
"flag": "string",
"geo": [
"number"
],
"boats": "integer",
"regions": [
{
"_id": "string",
"lang": "string",
"geo": [
"number"
],
"boats": "integer",
"cities": [
{
"_id": "string",
"lang": "string",
"geo": [
"number"
],
"boats": "integer",
"marinas": [
{
"_id": "string",
"geo": [
"number"
],
"boats": "integer"
}
]
}
]
}
]
}
DestinationRegion:
- _id: string
-
Region id (by default english region name)
- lang: string
-
Localized region name
- geo: number[]
-
Array with two elements representing geographic coordinates
-
number - boats: integer
-
Number of boats in given region
- cities: DestinationCity
-
DestinationCity
Example
{
"_id": "string",
"lang": "string",
"geo": [
"number"
],
"boats": "integer",
"cities": [
{
"_id": "string",
"lang": "string",
"geo": [
"number"
],
"boats": "integer",
"marinas": [
{
"_id": "string",
"geo": [
"number"
],
"boats": "integer"
}
]
}
]
}
DestinationCity:
- _id: string
-
City id (by default english city name)
- lang: string
-
Localized city name
- geo: number[]
-
Array with two elements representing geographic coordinates
-
number - boats: integer
-
Number of boats in given city
- marinas: DestinationMarina
-
DestinationMarina
Example
{
"_id": "string",
"lang": "string",
"geo": [
"number"
],
"boats": "integer",
"marinas": [
{
"_id": "string",
"geo": [
"number"
],
"boats": "integer"
}
]
}
DestinationMarina:
- _id: string
-
Marina id (by default english marina name)
- geo: number[]
-
Array with two elements representing geographic coordinates
-
number - boats: integer
-
Number of boats in given marina
Example
{
"_id": "string",
"geo": [
"number"
],
"boats": "integer"
}
SearchFilterSingleCabinItem:
- _id: integer
- count: integer
Example
{
"_id": "integer",
"count": "integer"
}
SearchFilterDoubleCabinItem:
- _id: integer
- count: integer
Example
{
"_id": "integer",
"count": "integer"
}
SearchFilterTripleCabinItem:
- _id: integer
- count: integer
Example
{
"_id": "integer",
"count": "integer"
}
SearchFilterQuadrupleCabinItem:
- _id: integer
- count: integer
Example
{
"_id": "integer",
"count": "integer"
}
SearchFilterCabinWithBunkBedItem:
- _id: integer
- count: integer
Example
{
"_id": "integer",
"count": "integer"
}
SearchFilterToiletItem:
- _id: integer
- count: integer
Example
{
"_id": "integer",
"count": "integer"
}
SearchFilterCharterItem:
- _id: string
- count: integer
- name: string
Example
{
"_id": "string",
"count": "integer",
"name": "string"
}
SearchFilterManufacturerItem:
- _id: string
- count: integer
- name: string
Example
{
"_id": "string",
"count": "integer",
"name": "string"
}
SearchFilterMaxSleepItem:
- _id: integer
- count: integer
Example
{
"_id": "integer",
"count": "integer"
}
SearchFilterAllowedPeopleItem:
- _id: integer
- count: integer
Example
{
"_id": "integer",
"count": "integer"
}
SearchFilterModelItem:
- _id: string
- count: integer
- name: string
- manufacturer: string
Example
{
"_id": "string",
"count": "integer",
"name": "string",
"manufacturer": "string"
}
SearchFilterCategoryItem:
- _id: string
- count: integer
- name: string
Example
{
"_id": "string",
"count": "integer",
"name": "string"
}
SearchFilterCockpitItem:
- _id: string
- count: integer
- name: string
Example
{
"_id": "string",
"count": "integer",
"name": "string"
}
SearchFilterEntertainmentItem:
- _id: string
- count: integer
- name: string
Example
{
"_id": "string",
"count": "integer",
"name": "string"
}
SearchFilterEquipmentItem:
- _id: string
- count: integer
- name: string
Example
{
"_id": "string",
"count": "integer",
"name": "string"
}
SearchFilterEnginePowerItem:
- _id: integer
- count: integer
Example
{
"_id": "integer",
"count": "integer"
}
SearchFilterEngineTypeItem:
- _id: string
- count: integer
- name: string
Example
{
"_id": "string",
"count": "integer",
"name": "string"
}
SearchFilterCharterItemNoFilter:
- _id: string
- count: integer
Example
{
"_id": "string",
"count": "integer"
}
SearchFilterManufacturerItemNoFilter:
- _id: string
- count: integer
Example
{
"_id": "string",
"count": "integer"
}
ExperienceSearchResponse:
- data: object
-
- _id: null
- data: ExperienceSearch
-
ExperienceSearch - totalBoats: integer
- totalResults: integer
- currentPage: integer
- skip: integer
- filter: ExperienceSearchFilter
Example
{
"data": {
"_id": "null",
"data": [
{
"old_id": "integer",
"slug": "string",
"parameters": {
"cabins": "integer",
"max_sleeps": "integer",
"max_people": "integer",
"single_cabins": "integer",
"double_cabins": "integer",
"triple_cabins": "integer",
"quadruple_cabins": "integer",
"cabins_with_bunk_bed": "integer",
"saloon_sleeps": "integer",
"crew_sleeps": "integer"
},
"title": "string",
"thumb": "string (url)",
"main_img": "string (url)",
"gallery": [
"string (url)"
],
"boataroundExtra": "boolean",
"marina": "string",
"coordinates": [
"number"
],
"country": "string",
"region": "string",
"city": "string",
"flag": "string",
"usp": [
{
"name": "string",
"icon": "string",
"provider": "string"
}
],
"restrictions_covered": "object",
"cancellationInsurance": "object",
"freeBerths": "object",
"charter_rank": "object",
"charter": "string",
"charter_logo": "string",
"charter_id": "string",
"illustrated": "boolean",
"priceFrom": "number",
"currency": "string",
"price_type": "string",
"prepayment": "number",
"newboat": "boolean",
"lastCustomer": "string",
"rank": "number",
"views": "integer",
"noLicense": "string",
"reviewsScore": "integer",
"totalReviews": "null,integer",
"deal_of_the_day": "string (date)",
"isSpecialDealDay": "boolean",
"isSmartDeal": "boolean"
}
],
"totalBoats": "integer",
"totalResults": "integer",
"currentPage": "integer",
"skip": "integer",
"filter": {
"price": [
{
"_id": "integer",
"count": "integer"
}
],
"maxSleeps": [
{
"_id": "integer",
"count": "integer"
}
],
"allowedPeople": [
{
"_id": "integer",
"count": "integer"
}
],
"cockpit": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"entertainment": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"equipment": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"price_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"max_sleeps_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"cockpit_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"entertainment_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"equipment_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
]
}
},
"statusCode": "integer",
"status": "string"
}
ExperienceSearch:
- old_id: integer
- slug: string
-
Experience slug
- parameters: ExtendedExperienceParameters
- title: string
-
Experience title
- thumb: string (url)
-
(Deprecated, use main_img instead) Boat thumbnail
- main_img: string (url)
-
Boat main image
- gallery: string[]
-
Array of image urls
-
string (url) - boataroundExtra: boolean
-
Is Boataround extra applied to this boat?
- marina: string
-
Marina name
- coordinates: number[]
-
Array with two elements representing geographic coordinates
-
number - distance: object
-
Distance from the requested location (for /near endpoints)
- country: string
-
Boat country
- region: string
-
Boat region
- city: string
-
Boat city
- flag: string
-
Abbreviation of boat flag name
- usp: SearchUsp
-
List boat usp
-
SearchUsp - restrictions_covered: object
- cancellationInsurance: object
- freeBerths: object
- charter_rank: object
- charter: string
-
Name of boat charter
- charter_logo: string
-
Path to charter logo
- charter_id: string
-
Boat charter id
- illustrated: boolean
- priceFrom: number
- currency: string
- price_type: string nightly, daily
- prepayment: number
- newboat: boolean
- lastCustomer: string
-
Lowercase of ISO alpha 2 code https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 for country of last customer
- rank: number
- views: integer
- noLicense: string
- reviewsScore: integer
- totalReviews: null,integer
- deal_of_the_day: string (date)
- isSpecialDealDay: boolean
- isSmartDeal: boolean
Example
{
"old_id": "integer",
"slug": "string",
"parameters": {
"cabins": "integer",
"max_sleeps": "integer",
"max_people": "integer",
"single_cabins": "integer",
"double_cabins": "integer",
"triple_cabins": "integer",
"quadruple_cabins": "integer",
"cabins_with_bunk_bed": "integer",
"saloon_sleeps": "integer",
"crew_sleeps": "integer"
},
"title": "string",
"thumb": "string (url)",
"main_img": "string (url)",
"gallery": [
"string (url)"
],
"boataroundExtra": "boolean",
"marina": "string",
"coordinates": [
"number"
],
"country": "string",
"region": "string",
"city": "string",
"flag": "string",
"usp": [
{
"name": "string",
"icon": "string",
"provider": "string"
}
],
"restrictions_covered": "object",
"cancellationInsurance": "object",
"freeBerths": "object",
"charter_rank": "object",
"charter": "string",
"charter_logo": "string",
"charter_id": "string",
"illustrated": "boolean",
"priceFrom": "number",
"currency": "string",
"price_type": "string",
"prepayment": "number",
"newboat": "boolean",
"lastCustomer": "string",
"rank": "number",
"views": "integer",
"noLicense": "string",
"reviewsScore": "integer",
"totalReviews": "null,integer",
"deal_of_the_day": "string (date)",
"isSpecialDealDay": "boolean",
"isSmartDeal": "boolean"
}
SearchResponse:
- data: object
-
- _id: null
- data: Search
-
Search - dataNearBy: Search
-
Search - totalBoats: integer
- totalResults: integer
- totalBoatsWithNearBy: integer
- totalDestinationCount: integer
- currentPage: integer
- filter: SearchFilter
Example
{
"data": {
"_id": "null",
"data": [
{
"old_id": "integer",
"slug": "string",
"parameters": {
"cabins": "integer",
"max_sleeps": "integer",
"max_people": "integer",
"single_cabins": "integer",
"double_cabins": "integer",
"triple_cabins": "integer",
"quadruple_cabins": "integer",
"cabins_with_bunk_bed": "integer",
"saloon_sleeps": "integer",
"crew_sleeps": "integer",
"toilets": "integer",
"electric_toilets": "integer",
"length": "number",
"beam": "number",
"draft": "number",
"year": "integer",
"renovated_year": "integer",
"sail_renovated_year": "integer",
"engine": "string",
"engine_type": "string",
"fuel": "number",
"cruising_consumption": "number",
"maximum_speed": "number"
},
"title": "string",
"thumb": "string (url)",
"main_img": "string (url)",
"gallery": [
"string (url)"
],
"boataroundExtra": "boolean",
"marina": "string",
"coordinates": [
"number"
],
"country": "string",
"region": "string",
"city": "string",
"category": "string",
"flag": "string",
"sail": "string",
"engineType": "string",
"captain": [
"string"
],
"usp": [
{
"name": "string",
"icon": "string",
"provider": "string"
}
],
"restrictions_covered": "object",
"cancellationInsurance": "object",
"freeBerths": "object",
"charter_rank": "object",
"charter": "string",
"charter_logo": "string",
"charter_id": "string",
"manufacturer": "string",
"illustrated": "boolean",
"priceFrom": "number",
"currency": "string",
"price_type": "string",
"prepayment": "number",
"newboat": "boolean",
"lastCustomer": "string",
"rank": "number",
"views": "integer",
"noLicense": "string",
"reviewsScore": "integer",
"totalReviews": "null,integer",
"deal_of_the_day": "string (date)",
"isSpecialDealDay": "boolean",
"dealType": "string",
"isSmartDeal": "boolean"
}
],
"dataNearBy": [
{
"old_id": "integer",
"slug": "string",
"parameters": {
"cabins": "integer",
"max_sleeps": "integer",
"max_people": "integer",
"single_cabins": "integer",
"double_cabins": "integer",
"triple_cabins": "integer",
"quadruple_cabins": "integer",
"cabins_with_bunk_bed": "integer",
"saloon_sleeps": "integer",
"crew_sleeps": "integer",
"toilets": "integer",
"electric_toilets": "integer",
"length": "number",
"beam": "number",
"draft": "number",
"year": "integer",
"renovated_year": "integer",
"sail_renovated_year": "integer",
"engine": "string",
"engine_type": "string",
"fuel": "number",
"cruising_consumption": "number",
"maximum_speed": "number"
},
"title": "string",
"thumb": "string (url)",
"main_img": "string (url)",
"gallery": [
"string (url)"
],
"boataroundExtra": "boolean",
"marina": "string",
"coordinates": [
"number"
],
"country": "string",
"region": "string",
"city": "string",
"category": "string",
"flag": "string",
"sail": "string",
"engineType": "string",
"captain": [
"string"
],
"usp": [
{
"name": "string",
"icon": "string",
"provider": "string"
}
],
"restrictions_covered": "object",
"cancellationInsurance": "object",
"freeBerths": "object",
"charter_rank": "object",
"charter": "string",
"charter_logo": "string",
"charter_id": "string",
"manufacturer": "string",
"illustrated": "boolean",
"priceFrom": "number",
"currency": "string",
"price_type": "string",
"prepayment": "number",
"newboat": "boolean",
"lastCustomer": "string",
"rank": "number",
"views": "integer",
"noLicense": "string",
"reviewsScore": "integer",
"totalReviews": "null,integer",
"deal_of_the_day": "string (date)",
"isSpecialDealDay": "boolean",
"dealType": "string",
"isSmartDeal": "boolean"
}
],
"totalBoats": "integer",
"totalResults": "integer",
"totalBoatsWithNearBy": "integer",
"totalDestinationCount": "integer",
"currentPage": "integer",
"filter": {
"price": [
{
"_id": "integer",
"count": "integer"
}
],
"cabins": [
{
"_id": "integer",
"count": "integer"
}
],
"singleCabins": [
{
"_id": "integer",
"count": "integer"
}
],
"doubleCabins": [
{
"_id": "integer",
"count": "integer"
}
],
"tripleCabins": [
{
"_id": "integer",
"count": "integer"
}
],
"quadrupleCabins": [
{
"_id": "integer",
"count": "integer"
}
],
"cabinsWithBunkBed": [
{
"_id": "integer",
"count": "integer"
}
],
"toilets": [
{
"_id": "integer",
"count": "integer"
}
],
"charter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"maxSleeps": [
{
"_id": "integer",
"count": "integer"
}
],
"allowedPeople": [
{
"_id": "integer",
"count": "integer"
}
],
"manufacturer": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"models": [
{
"_id": "string",
"count": "integer",
"name": "string",
"manufacturer": "string"
}
],
"boatLength": [
{
"_id": "number",
"count": "integer"
}
],
"year": [
{
"_id": "integer",
"count": "integer"
}
],
"sail": [
{
"_id": "string",
"count": "integer"
}
],
"category": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"cockpit": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"entertainment": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"equipment": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"skipper": [
{
"_id": "string",
"count": "integer"
}
],
"enginePower": [
{
"_id": "integer",
"count": "integer"
}
],
"engineType": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"price_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"cabins_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"single_cabins_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"double_cabins_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"triple_cabins_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"quadruple_cabins_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"cabins_with_bunk_bed_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"toilets_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"charter_nofilter": [
{
"_id": "string",
"count": "integer"
}
],
"max_sleeps_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"manufacturer_nofilter": [
{
"_id": "string",
"count": "integer"
}
],
"models_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string",
"manufacturer": "string"
}
],
"length_nofilter": [
{
"_id": "number",
"count": "integer"
}
],
"year_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"sail_nofilter": [
{
"_id": "string",
"count": "integer"
}
],
"category_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"cockpit_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"entertainment_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"equipment_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"skipper_nofilter": [
{
"_id": "string",
"count": "integer"
}
],
"enginePower_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"engineType_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
]
}
},
"statusCode": "integer",
"status": "string"
}
SearchLowestResponse:
- data: object
-
- _id: null
- data: SearchLowestPrice
Example
{
"data": {
"_id": "null",
"data": {
"main_img": "string (url)",
"priceFrom": "number",
"price": "number",
"currency": "string"
}
},
"statusCode": "integer",
"status": "string"
}
ExperienceSearchNoContentResponse:
- data: object
-
- _id: null
- totalBoats: integer
- totalResults: integer
- currentPage: integer
- skip: integer
- filter: ExperienceSearchFilter
Example
{
"data": {
"_id": "null",
"totalBoats": "integer",
"totalResults": "integer",
"currentPage": "integer",
"skip": "integer",
"filter": {
"price": [
{
"_id": "integer",
"count": "integer"
}
],
"maxSleeps": [
{
"_id": "integer",
"count": "integer"
}
],
"allowedPeople": [
{
"_id": "integer",
"count": "integer"
}
],
"cockpit": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"entertainment": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"equipment": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"price_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"max_sleeps_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"cockpit_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"entertainment_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"equipment_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
]
}
},
"statusCode": "integer",
"status": "string"
}
SearchNoContentResponse:
- data: object
-
- _id: null
- totalBoats: integer
- totalResults: integer
- currentPage: integer
- skip: integer
- filter: SearchFilter
Example
{
"data": {
"_id": "null",
"totalBoats": "integer",
"totalResults": "integer",
"currentPage": "integer",
"skip": "integer",
"filter": {
"price": [
{
"_id": "integer",
"count": "integer"
}
],
"cabins": [
{
"_id": "integer",
"count": "integer"
}
],
"singleCabins": [
{
"_id": "integer",
"count": "integer"
}
],
"doubleCabins": [
{
"_id": "integer",
"count": "integer"
}
],
"tripleCabins": [
{
"_id": "integer",
"count": "integer"
}
],
"quadrupleCabins": [
{
"_id": "integer",
"count": "integer"
}
],
"cabinsWithBunkBed": [
{
"_id": "integer",
"count": "integer"
}
],
"toilets": [
{
"_id": "integer",
"count": "integer"
}
],
"charter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"maxSleeps": [
{
"_id": "integer",
"count": "integer"
}
],
"allowedPeople": [
{
"_id": "integer",
"count": "integer"
}
],
"manufacturer": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"models": [
{
"_id": "string",
"count": "integer",
"name": "string",
"manufacturer": "string"
}
],
"boatLength": [
{
"_id": "number",
"count": "integer"
}
],
"year": [
{
"_id": "integer",
"count": "integer"
}
],
"sail": [
{
"_id": "string",
"count": "integer"
}
],
"category": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"cockpit": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"entertainment": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"equipment": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"skipper": [
{
"_id": "string",
"count": "integer"
}
],
"enginePower": [
{
"_id": "integer",
"count": "integer"
}
],
"engineType": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"price_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"cabins_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"single_cabins_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"double_cabins_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"triple_cabins_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"quadruple_cabins_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"cabins_with_bunk_bed_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"toilets_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"charter_nofilter": [
{
"_id": "string",
"count": "integer"
}
],
"max_sleeps_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"manufacturer_nofilter": [
{
"_id": "string",
"count": "integer"
}
],
"models_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string",
"manufacturer": "string"
}
],
"length_nofilter": [
{
"_id": "number",
"count": "integer"
}
],
"year_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"sail_nofilter": [
{
"_id": "string",
"count": "integer"
}
],
"category_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"cockpit_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"entertainment_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"equipment_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"skipper_nofilter": [
{
"_id": "string",
"count": "integer"
}
],
"enginePower_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"engineType_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
]
}
},
"statusCode": "integer",
"status": "string"
}
ExperienceSearchFilter:
- price: SearchFilterPriceItem
-
SearchFilterPriceItem - maxSleeps: SearchFilterMaxSleepItem
-
SearchFilterMaxSleepItem - allowedPeople: SearchFilterAllowedPeopleItem
-
SearchFilterAllowedPeopleItem - cockpit: SearchFilterCockpitItem
-
SearchFilterCockpitItem - entertainment: SearchFilterEntertainmentItem
-
SearchFilterEntertainmentItem - equipment: SearchFilterEquipmentItem
-
SearchFilterEquipmentItem - price_nofilter: SearchFilterPriceItem
-
SearchFilterPriceItem - max_sleeps_nofilter: SearchFilterMaxSleepItem
-
SearchFilterMaxSleepItem - cockpit_nofilter: SearchFilterCockpitItem
-
SearchFilterCockpitItem - entertainment_nofilter: SearchFilterEntertainmentItem
-
SearchFilterEntertainmentItem - equipment_nofilter: SearchFilterEquipmentItem
-
SearchFilterEquipmentItem
Example
{
"price": [
{
"_id": "integer",
"count": "integer"
}
],
"maxSleeps": [
{
"_id": "integer",
"count": "integer"
}
],
"allowedPeople": [
{
"_id": "integer",
"count": "integer"
}
],
"cockpit": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"entertainment": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"equipment": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"price_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"max_sleeps_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"cockpit_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"entertainment_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"equipment_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
]
}
SearchFilter:
- price: SearchFilterPriceItem
-
SearchFilterPriceItem - cabins: SearchFilterCabinItem
-
SearchFilterCabinItem - singleCabins: SearchFilterSingleCabinItem
-
SearchFilterSingleCabinItem - doubleCabins: SearchFilterDoubleCabinItem
-
SearchFilterDoubleCabinItem - tripleCabins: SearchFilterTripleCabinItem
-
SearchFilterTripleCabinItem - quadrupleCabins: SearchFilterQuadrupleCabinItem
-
SearchFilterQuadrupleCabinItem - cabinsWithBunkBed: SearchFilterCabinWithBunkBedItem
-
SearchFilterCabinWithBunkBedItem - toilets: SearchFilterToiletItem
-
SearchFilterToiletItem - charter: SearchFilterCharterItem
-
SearchFilterCharterItem - maxSleeps: SearchFilterMaxSleepItem
-
SearchFilterMaxSleepItem - allowedPeople: SearchFilterAllowedPeopleItem
-
SearchFilterAllowedPeopleItem - manufacturer: SearchFilterManufacturerItem
-
SearchFilterManufacturerItem - models: SearchFilterModelItem
-
SearchFilterModelItem - boatLength: SearchFilterLengthItem
-
SearchFilterLengthItem - year: SearchFilterYearItem
-
SearchFilterYearItem - sail: SearchFilterSailItem
-
SearchFilterSailItem - category: SearchFilterCategoryItem
-
SearchFilterCategoryItem - cockpit: SearchFilterCockpitItem
-
SearchFilterCockpitItem - entertainment: SearchFilterEntertainmentItem
-
SearchFilterEntertainmentItem - equipment: SearchFilterEquipmentItem
-
SearchFilterEquipmentItem - skipper: SearchFilterSkipperItem
-
SearchFilterSkipperItem - enginePower: SearchFilterEnginePowerItem
-
SearchFilterEnginePowerItem - engineType: SearchFilterEngineTypeItem
-
SearchFilterEngineTypeItem - price_nofilter: SearchFilterPriceItem
-
SearchFilterPriceItem - cabins_nofilter: SearchFilterCabinItem
-
SearchFilterCabinItem - single_cabins_nofilter: SearchFilterSingleCabinItem
-
SearchFilterSingleCabinItem - double_cabins_nofilter: SearchFilterDoubleCabinItem
-
SearchFilterDoubleCabinItem - triple_cabins_nofilter: SearchFilterTripleCabinItem
-
SearchFilterTripleCabinItem - quadruple_cabins_nofilter: SearchFilterQuadrupleCabinItem
-
SearchFilterQuadrupleCabinItem - cabins_with_bunk_bed_nofilter: SearchFilterCabinWithBunkBedItem
-
SearchFilterCabinWithBunkBedItem - toilets_nofilter: SearchFilterToiletItem
-
SearchFilterToiletItem - charter_nofilter: SearchFilterCharterItemNoFilter
-
SearchFilterCharterItemNoFilter - max_sleeps_nofilter: SearchFilterMaxSleepItem
-
SearchFilterMaxSleepItem - manufacturer_nofilter: SearchFilterManufacturerItemNoFilter
-
SearchFilterManufacturerItemNoFilter - models_nofilter: SearchFilterModelItem
-
SearchFilterModelItem - length_nofilter: SearchFilterLengthItem
-
SearchFilterLengthItem - year_nofilter: SearchFilterYearItem
-
SearchFilterYearItem - sail_nofilter: SearchFilterSailItem
-
SearchFilterSailItem - category_nofilter: SearchFilterCategoryItem
-
SearchFilterCategoryItem - cockpit_nofilter: SearchFilterCockpitItem
-
SearchFilterCockpitItem - entertainment_nofilter: SearchFilterEntertainmentItem
-
SearchFilterEntertainmentItem - equipment_nofilter: SearchFilterEquipmentItem
-
SearchFilterEquipmentItem - skipper_nofilter: SearchFilterSkipperItem
-
SearchFilterSkipperItem - enginePower_nofilter: SearchFilterEnginePowerItem
-
SearchFilterEnginePowerItem - engineType_nofilter: SearchFilterEngineTypeItem
-
SearchFilterEngineTypeItem
Example
{
"price": [
{
"_id": "integer",
"count": "integer"
}
],
"cabins": [
{
"_id": "integer",
"count": "integer"
}
],
"singleCabins": [
{
"_id": "integer",
"count": "integer"
}
],
"doubleCabins": [
{
"_id": "integer",
"count": "integer"
}
],
"tripleCabins": [
{
"_id": "integer",
"count": "integer"
}
],
"quadrupleCabins": [
{
"_id": "integer",
"count": "integer"
}
],
"cabinsWithBunkBed": [
{
"_id": "integer",
"count": "integer"
}
],
"toilets": [
{
"_id": "integer",
"count": "integer"
}
],
"charter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"maxSleeps": [
{
"_id": "integer",
"count": "integer"
}
],
"allowedPeople": [
{
"_id": "integer",
"count": "integer"
}
],
"manufacturer": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"models": [
{
"_id": "string",
"count": "integer",
"name": "string",
"manufacturer": "string"
}
],
"boatLength": [
{
"_id": "number",
"count": "integer"
}
],
"year": [
{
"_id": "integer",
"count": "integer"
}
],
"sail": [
{
"_id": "string",
"count": "integer"
}
],
"category": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"cockpit": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"entertainment": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"equipment": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"skipper": [
{
"_id": "string",
"count": "integer"
}
],
"enginePower": [
{
"_id": "integer",
"count": "integer"
}
],
"engineType": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"price_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"cabins_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"single_cabins_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"double_cabins_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"triple_cabins_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"quadruple_cabins_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"cabins_with_bunk_bed_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"toilets_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"charter_nofilter": [
{
"_id": "string",
"count": "integer"
}
],
"max_sleeps_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"manufacturer_nofilter": [
{
"_id": "string",
"count": "integer"
}
],
"models_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string",
"manufacturer": "string"
}
],
"length_nofilter": [
{
"_id": "number",
"count": "integer"
}
],
"year_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"sail_nofilter": [
{
"_id": "string",
"count": "integer"
}
],
"category_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"cockpit_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"entertainment_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"equipment_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
],
"skipper_nofilter": [
{
"_id": "string",
"count": "integer"
}
],
"enginePower_nofilter": [
{
"_id": "integer",
"count": "integer"
}
],
"engineType_nofilter": [
{
"_id": "string",
"count": "integer",
"name": "string"
}
]
}
Search:
- old_id: integer
- slug: string
-
Boat slug
- parameters: ExtendedBoatParameters
- title: string
-
Boat title
- thumb: string (url)
-
(Deprecated, use main_img instead) Boat thumbnail
- main_img: string (url)
-
Boat main image
- gallery: string[]
-
Array of image urls
-
string (url) - boataroundExtra: boolean
-
Is Boataround extra applied to this boat?
- marina: string
-
Marina name
- coordinates: number[]
-
Array with two elements representing geographic coordinates
-
number - distance: object
-
Distance from the requested location (for /near endpoints)
- country: string
-
Boat country
- region: string
-
Boat region
- city: string
-
Boat city
- category: string
-
Boat category
- flag: string
-
Abbreviation of boat flag name
- sail: string
-
Type of boat sail
- engineType: string
-
Type of boat engine
- captain: string[]
-
string - usp: SearchUsp
-
List boat usp
-
SearchUsp - restrictions_covered: object
- cancellationInsurance: object
- freeBerths: object
- charter_rank: object
- charter: string
-
Name of boat charter
- charter_logo: string
-
Path to charter logo
- charter_id: string
-
Boat charter id
- manufacturer: string
-
Boat manufacturer
- illustrated: boolean
- priceFrom: number
- currency: string
- price_type: string nightly, daily
- prepayment: number
- newboat: boolean
- lastCustomer: string
-
Lowercase of ISO alpha 2 code https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 for country of last customer
- rank: number
- views: integer
- noLicense: string
- reviewsScore: integer
- totalReviews: null,integer
- deal_of_the_day: string (date)
- isSpecialDealDay: boolean
- dealType: string
- isSmartDeal: boolean
Example
{
"old_id": "integer",
"slug": "string",
"parameters": {
"cabins": "integer",
"max_sleeps": "integer",
"max_people": "integer",
"single_cabins": "integer",
"double_cabins": "integer",
"triple_cabins": "integer",
"quadruple_cabins": "integer",
"cabins_with_bunk_bed": "integer",
"saloon_sleeps": "integer",
"crew_sleeps": "integer",
"toilets": "integer",
"electric_toilets": "integer",
"length": "number",
"beam": "number",
"draft": "number",
"year": "integer",
"renovated_year": "integer",
"sail_renovated_year": "integer",
"engine": "string",
"engine_type": "string",
"fuel": "number",
"cruising_consumption": "number",
"maximum_speed": "number"
},
"title": "string",
"thumb": "string (url)",
"main_img": "string (url)",
"gallery": [
"string (url)"
],
"boataroundExtra": "boolean",
"marina": "string",
"coordinates": [
"number"
],
"country": "string",
"region": "string",
"city": "string",
"category": "string",
"flag": "string",
"sail": "string",
"engineType": "string",
"captain": [
"string"
],
"usp": [
{
"name": "string",
"icon": "string",
"provider": "string"
}
],
"restrictions_covered": "object",
"cancellationInsurance": "object",
"freeBerths": "object",
"charter_rank": "object",
"charter": "string",
"charter_logo": "string",
"charter_id": "string",
"manufacturer": "string",
"illustrated": "boolean",
"priceFrom": "number",
"currency": "string",
"price_type": "string",
"prepayment": "number",
"newboat": "boolean",
"lastCustomer": "string",
"rank": "number",
"views": "integer",
"noLicense": "string",
"reviewsScore": "integer",
"totalReviews": "null,integer",
"deal_of_the_day": "string (date)",
"isSpecialDealDay": "boolean",
"dealType": "string",
"isSmartDeal": "boolean"
}
SearchLowestPrice:
- main_img: string (url)
-
Boat main image
- priceFrom: number
- price: number
- currency: string
Example
{
"main_img": "string (url)",
"priceFrom": "number",
"price": "number",
"currency": "string"
}
SearchUsp:
- name: string
-
Unique selling point name
- icon: string
-
Icon HTML class
- provider: string
-
usp provider
Example
{
"name": "string",
"icon": "string",
"provider": "string"
}
ExtendedBoatParameters:
Boat parameters
- cabins: integer
-
Number of cabins
- max_sleeps: integer
-
Number of places to sleep
- max_people: integer
-
Maxim number of people per boat
- single_cabins: integer
-
Number of cabins with single bed
- double_cabins: integer
-
Number of cabins with double beds
- triple_cabins: integer
-
Number of cabins with triple beds
- quadruple_cabins: integer
-
Number of cabins with quadruple beds
- cabins_with_bunk_bed: integer
-
Number of cabins with bunk beds
- saloon_sleeps: integer
- crew_sleeps: integer
- toilets: integer
-
Number of toilets
- electric_toilets: integer
-
Number of electric toilets
- length: number
-
Boat length
- beam: number
- draft: number
- year: integer
- renovated_year: integer
- sail_renovated_year: integer
- engine: string
- engine_type: string
- fuel: number
- cruising_consumption: number
- maximum_speed: number
Example
{
"cabins": "integer",
"max_sleeps": "integer",
"max_people": "integer",
"single_cabins": "integer",
"double_cabins": "integer",
"triple_cabins": "integer",
"quadruple_cabins": "integer",
"cabins_with_bunk_bed": "integer",
"saloon_sleeps": "integer",
"crew_sleeps": "integer",
"toilets": "integer",
"electric_toilets": "integer",
"length": "number",
"beam": "number",
"draft": "number",
"year": "integer",
"renovated_year": "integer",
"sail_renovated_year": "integer",
"engine": "string",
"engine_type": "string",
"fuel": "number",
"cruising_consumption": "number",
"maximum_speed": "number"
}
ExtendedExperienceParameters:
Experience parameters
- cabins: integer
-
Number of cabins
- max_sleeps: integer
-
Number of places to sleep
- max_people: integer
-
Maxim number of people per experience
- single_cabins: integer
-
Number of cabins with single bed
- double_cabins: integer
-
Number of cabins with double beds
- triple_cabins: integer
-
Number of cabins with triple beds
- quadruple_cabins: integer
-
Number of cabins with quadruple beds
- cabins_with_bunk_bed: integer
-
Number of cabins with bunk beds
- saloon_sleeps: integer
- crew_sleeps: integer
Example
{
"cabins": "integer",
"max_sleeps": "integer",
"max_people": "integer",
"single_cabins": "integer",
"double_cabins": "integer",
"triple_cabins": "integer",
"quadruple_cabins": "integer",
"cabins_with_bunk_bed": "integer",
"saloon_sleeps": "integer",
"crew_sleeps": "integer"
}
PriceResponse:
- data: object[]
-
In case of succes array with one element containing data
-
object - _id: null
- totalResults: integer
- data: PriceResult
-
In case of succes array with one element containing boat data
-
PriceResult
Example
{
"data": [
{
"_id": "null",
"totalResults": "integer",
"data": [
{
"_id": "string",
"slug": "string",
"title": "string",
"thumb": "string (url)",
"main_img": "string (url)",
"boataroundExtra": "boolean",
"marina": "string",
"country": "string",
"region": "string",
"city": "string",
"flag": "string",
"license": [
"string"
],
"charter": "string",
"charter_id": "string",
"coordinates": [
"number"
],
"views": "integer",
"usp": [
{
"name": "string",
"icon": "string",
"provider": "string"
}
],
"reviewsScore": "integer",
"currency": "string",
"price": "number",
"totalPrice": "number",
"discount": "number",
"period": "integer",
"deal_of_the_day": "string (date)",
"restrictions_covered": "object",
"cancellationInsurance": "object",
"freeBerths": "object",
"charter_rank": "object",
"isSmartDeal": "boolean"
}
]
}
],
"statusCode": "integer",
"status": "string"
}
PriceResult:
- _id: string
- slug: string
-
Boat slug
- title: string
-
Boat title
- thumb: string (url)
-
(Deprecated, use main_img instead) Boat thumbnail
- main_img: string (url)
-
Boat main image
- boataroundExtra: boolean
-
Is Boataround extra applied to this boat?
- marina: string
-
Marina name
- country: string
-
Boat country
- region: string
-
Boat region
- city: string
-
Boat city
- flag: string
-
Abbreviation of boat flag name
- license: string[]
-
string - charter: string
-
Name of boat charter
- charter_id: string
-
Boat charter id
- coordinates: number[]
-
Array with two elements representing geographic coordinates
-
number - views: integer
- usp: SearchUsp
-
List boat usp
-
SearchUsp - reviewsScore: integer
- currency: string
- price: number
- totalPrice: number
- discount: number
- period: integer
- deal_of_the_day: string (date)
- restrictions_covered: object
- cancellationInsurance: object
- freeBerths: object
- charter_rank: object
- policies: PoliciesResults
- isSmartDeal: boolean
Example
{
"_id": "string",
"slug": "string",
"title": "string",
"thumb": "string (url)",
"main_img": "string (url)",
"boataroundExtra": "boolean",
"marina": "string",
"country": "string",
"region": "string",
"city": "string",
"flag": "string",
"license": [
"string"
],
"charter": "string",
"charter_id": "string",
"coordinates": [
"number"
],
"views": "integer",
"usp": [
{
"name": "string",
"icon": "string",
"provider": "string"
}
],
"reviewsScore": "integer",
"currency": "string",
"price": "number",
"totalPrice": "number",
"discount": "number",
"period": "integer",
"deal_of_the_day": "string (date)",
"restrictions_covered": "object",
"cancellationInsurance": "object",
"freeBerths": "object",
"charter_rank": "object",
"isSmartDeal": "boolean"
}
PoliciesResults:
- policy: BoatPolicy
- prices: object
-
- price_id: string
- price: number
- totalPrice: number
- discount: number
- deal_of_the_day: string (date)
- deal_type: string
- avg_price: number
- is_valid: boolean
- nb_discount: number
- price_type: string nightly, daily
Example
{
"policy": {
"name": "string",
"schedule": [
{
"percentage": "number",
"type": "string",
"event": "string",
"value": "number"
}
],
"slug": "string",
"is_default": "boolean",
"type": "string",
"id": "string"
},
"prices": {
"price_id": "string",
"price": "number",
"totalPrice": "number",
"discount": "number",
"deal_of_the_day": "string (date)",
"deal_type": "string",
"avg_price": "number",
"is_valid": "boolean",
"nb_discount": "number",
"price_type": "string"
}
}
BoatPolicy:
- name: string
- schedule: object[]
-
object - percentage: number
- type: string
- event: string
- value: number
- slug: string
- is_default: boolean
- type: string
- id: string
Example
{
"name": "string",
"schedule": [
{
"percentage": "number",
"type": "string",
"event": "string",
"value": "number"
}
],
"slug": "string",
"is_default": "boolean",
"type": "string",
"id": "string"
}
SimilarBoatsResponse:
- data: SimilarBoatsResult
-
In case of success array with single element representing result
-
SimilarBoatsResult
Example
{
"data": [
{
"_id": "null",
"totalBoats": "integer",
"data": [
{
"_id": "string",
"slug": "string",
"title": "string",
"thumb": "string (url)",
"main_img": "string (url)",
"boataroundExtra": "boolean",
"marina": "string",
"country": "string",
"region": "string",
"city": "string",
"flag": "string",
"currency": "string",
"price": "number",
"totalPrice": "number",
"priceFrom": "number",
"discount": "number",
"period": "integer",
"old_id": "number"
}
]
}
],
"statusCode": "integer",
"status": "string"
}
SimilarBoatsResult:
- _id: null
- totalBoats: integer
-
Number of similar boats returned
- data: SimilarBoat
-
List of similar boats
-
SimilarBoat
Example
{
"_id": "null",
"totalBoats": "integer",
"data": [
{
"_id": "string",
"slug": "string",
"title": "string",
"thumb": "string (url)",
"main_img": "string (url)",
"boataroundExtra": "boolean",
"marina": "string",
"country": "string",
"region": "string",
"city": "string",
"flag": "string",
"currency": "string",
"price": "number",
"totalPrice": "number",
"priceFrom": "number",
"discount": "number",
"period": "integer",
"old_id": "number"
}
]
}
SimilarBoat:
- _id: string
-
Boat id
- slug: string
-
Boat slug
- title: string
-
Boat title
- thumb: string (url)
-
(Deprecated, use main_img instead) URL for boat thumbnail
- main_img: string (url)
-
URL for boat main image
- boataroundExtra: boolean
-
Boat id
- marina: string
-
Boat marina
- country: string
-
Boat country
- region: string
-
Boat region
- city: string
-
Boat city
- flag: string
-
Abbreviation of boat flag name
- currency: string
-
Price currency
- price: number
-
Boat price before discount
- totalPrice: number
-
Boatprice after discount
- priceFrom: number
-
Boat price from per day return when no checkIn and checkOut
- discount: number
-
Price discount
- period: integer
-
Length in days defined by checkIn and checkOut
- old_id: number
-
Boat old_id
Example
{
"_id": "string",
"slug": "string",
"title": "string",
"thumb": "string (url)",
"main_img": "string (url)",
"boataroundExtra": "boolean",
"marina": "string",
"country": "string",
"region": "string",
"city": "string",
"flag": "string",
"currency": "string",
"price": "number",
"totalPrice": "number",
"priceFrom": "number",
"discount": "number",
"period": "integer",
"old_id": "number"
}