For Central Agents

The API exposes basic data for your own fleet of yachts. For enhanced results featuring detailed rates & bookings information, you will need to upgrade to "Managed" or "Pro" listings.

For Charter Brokers

To gain access to the full listings of thousands of charter yachts, you will need an API subscription.

Authentication

Once you are subscribed, visit the API Connection Details page to retrieve your Authorization Header. You must include this header in every request you make to the API.

The GraphQL Playground is an in-browser GraphQL IDE, which allows you to explore the API & test your queries interactively.

It is the best way to get up and running, and familiarise yourself with the API.

To get started, you need to authenticate by setting your Authorization Header. Click the "Headers" tab at the bottom of the page, and provide your header in a JSON object, for example:

{
    "Authorization": "Basic abc123"
}

For users of version 1 of the Charter Index API, we have made a number of improvements to the API for version 2. Unfortunately some of these required making some breaking changes, which are outlined here.

Note that there are no immediate plans to retire version 1. You may upgrade at your convenience.

Removal of Deprecated Fields

The following fields of Yacht have been removed:

• stabilisers: merged into amenities as STABILISERS.
• airConditioning: merged into amenities as AIR_CONDITIONING.
• electronics: merged into amenities.
• brochureUrl: renamed canonicalUrl.

Renamed fields

• Yacht.cabins is now Yacht.cabinCount.

Removed fields

• Yacht.flagCountryCode has been removed; use Yacht.flagCountry.id.

Better lang & currency argument handling

Previously, queries which could be translated or currency-converted accepted the parameters lang & currency as Strings. These are now typed as the GraphQL enums Language and CurrencyCode to clarify the accepted values.

If you encounter errors such as Enum "Language" cannot represent non-enum value: "en". Did you mean the enum value "en"?, this likely means you just need to remove the quotation marks; for example:

            # Version 1
            yacht(id: "123", lang: "en", currency: "USD") { }
            
            # Version 2
            yacht(id: "123", lang: en, currency: USD) { }
            

The following queries are affected:

• constants
• yacht
• yachtsPaginated

New Enumeration type

We have introduced a new type to represent translated text:

{
  "id": "IDENTIFIER",
  "name": "Translated Name"
}

This gives you access to a consistent id in addition to the translated name, allowing your application to act on these values without relying on a variable string.

For example, these are the possible values of yacht 'categories':

[
  {
    "id": "POWER",
    "name": "Motor"
  },
  {
    "id": "SAIL",
    "name": "Sailing"
  }
]

You will need to update your queries to account for this.

For example:

            # Version 1
            yachts {
              builder
              amenities
            }
            
            # Version 2
            yachts {
              builder {
                id
                name
              }
              amenities {
                id
                name
              }
            }
            
            

The following fields are affected:

Areas

• name
• subAreas

Constants

• areas
• categories
• currencies
• hulls
• subAreas

CrewProfile

• nationality
• languages

Currency

• name
• shortName
• symbol

Yacht

• category
• hull
• construction
• builder
• mcaStatus
• flagCountry
• smoking
• masterCabinLocation
• crewCabinLocation
• accommodationDetails
• amenities
• toys
• divingDetails
• crewLanguage

Stricter array types

In Version 1, arrays were typed with nullable elements; for example [String]. This implies that some items in the array might be null, which is not the case! These variables & arguments are now typed as non-null; for example [String!]. You may be able to safely remove some null-checks :)

This may affect some of your queries / mutations if you are using variables. If you encounter errors such as Variable "$areas" of type "[String]" used in position expecting type "[String!]", you will need to update the types.

For example:

            # Version 1
            query Yachts($includeIds: [String]) {
              yachtsPaginated(includeIds: $includeIds) {}
            }
            
            # Version 2
            query Yachts($includeIds: [String!]) {
              yachtsPaginated(includeIds: $includeIds) {}
            }
            

The following arguments are affected:

yachtsPaginated query:

• includeIds
• name
• hull
• areas
• category

enquire mutation:

• yachtIds

New Date type

Fields & arguments representing dates now have a separate scalar type Date. The values of this field are identical to V1.

This may affect some of your queries / mutations if you are using variables. If you encounter errors such as Variable "$startDate" of type "String!" used in position expecting type "Date!", you will need to update the types.

For example:

            # Version 1
            mutation Enquire($startDate: String!) {
              enquire(startDate: $startDate) {}
            }
            
            # Version 2
            mutation Enquire($startDate: Date!) {
              enquire(startDate: $startDate) {}
            }
            
            

The following arguments are affected:

yachtsPaginated query:

• startDate
• endDate

enquire mutation:

• startDate
• endDate