Icon on api and code symbol

Build an amazing user journey with Bookster.

Use Bookster's API to create a bespoke, unique and effective booking experience for your guests.

Register for your API key
graphic angled element

Overview

Using Bookster's API you can build a custom user journey through your website for your guests.

Use our API to:

  • Render pre-built components
  • Poll live availability
  • Poll / export bookings
  • Poll / export listing data

See our full list of functions

Accessing The Bookster API

To get started - Register to create a Bookster account. Once you've created an account, go the your user settings and tick the 'Developer' setting to enable the API.

Once the 'Developer' setting is enabled - our API docs are also available when logged into Bookster under the API section.

Book now button

Place "Book now" button or link onto a web page.

Bookster -> [Property name] -> Calendar widget

Calendar widget

Place an availability and booking calendar on a website.

Bookster -> [Property name] -> Calendar widget

Branding

Add your own look and feel to the checkout process.

The colours and header image can be set to match your own branding:

Bookster -> Settings -> "Edit"

WordPress plugin

Instant Booking from a WordPress website

Add an availability search form to your WordPress website.

The form starts the guest journey across to the Bookster Search Engine.

Check out the plugin on wordpress.org.

Check out the plugin on wordpress.org.

Availability

Read Out Availability via REST API (JSON)

Get a high level view of the availability (e.g. any bookings and blocks combined) of the property

Example Response

[
  {
    "productRef": "property",
    "availability": [
      {
        "startInclusive": "2025-01-01",
        "endExclusive": "2026-05-12",
        "available": false
      },
      {
        "startInclusive": "2026-05-12",
        "endExclusive": "2026-05-23",
        "available": true
      },
      {
        "startInclusive": "2026-05-23",
        "endExclusive": "2026-05-28",
        "available": false
      },
      {
        "startInclusive": "2026-05-28",
        "endExclusive": "2026-06-14",
        "available": true
      },
      {
        "startInclusive": "2026-06-14",
        "endExclusive": "2026-06-22",
        "available": false
      },
      {
        "startInclusive": "2026-06-22",
        "endExclusive": "2029-01-02",
        "available": true
      },
      {
        "startInclusive": "2029-01-02",
        "endExclusive": "2036-01-01",
        "available": false
      }
    ]
  }
]

Read Out Availability via iCal

Use iCal get availability out of Bookster.

Bookster -> [Property name] -> Availability

Example: https://ical.booksterhq.com/system/channel/ical/308/115680.ics.

Use this URL to programatically read the availability of any Bookster holiday rental property.

Read Availability Into Bookster via iCal

Get availability into Bookster using iCal calendar format.

Bookster -> [Property name] -> Channel Manager

Each Bookster property can read an iCalendar (.ics) formatted file. Add a property specific iCalendar URL in the Channel Manager.

Bookster will check the iCalendar (ics) URL:

  • periodically; and
  • before accepting a booking.

Pricing

Pricing Length Of Stay (LoS) via REST API (JSON)

Get a consolidated view of the pricing of a property.

A CSV string representing the price for all possible stays + party sizes.

The CSV is as follows: date,partysize,price-for-1-night,price-for-2-nights,...

Any zero value for a price means this length of stay is not possible. If the CSV ends then any further stay is not possible.

Prices for the next 18 months and stays up to 30 nights are included.

Prices are in the property's primary currency, rounded to the nearest major unit.

Example Response

[
  "2026-05-12,5,0,1168,1681,2195,2708,3222,3735,4249,4848,5447,6046,6646,7159,7673,8186,8700,9213,9727,10241,10754,11268,11781,12295,12808,13322,13835,14349,14863,15376,16118",
  "2026-05-13,5,0,1168,1681,2195,2708,3222,3735,4335,4934,5533,6132,6646,7159,7673,8186,8700,9213,9727,10241,10754,11268,11781,12295,12808,13322,13835,14349,14863,15604,16346",
  "2026-05-14,5,0,1168,1681,2195,2708,3222,3821,4420,5019,5618,6132,6646,7159,7673,8186,8700,9213,9727,10241,10754,11268,11781,12295,12808,13322,13835,14349,15091,15833,16574"
]

Bookings

Poll and export booking data.

Export via iCal

Bookster -> Bookings -> Actions -> Calendar feed…

The iCalendar feed contains Check IN and Check OUT events for the next 30 days.

Each event can contain the following booking information:

  • Name
  • Email
  • Phone
  • Party size
  • Total
  • Outstanding balance
  • Damage deposit

Export REST API (JSON)

Use a RESTful API to pull out bookings in JSON format.

Example Response (Multiple Bookings)

{
  "meta":{
    "count":1,
    "total_count":1,
    "page":1,
    "total_pages":1
  },
  "data":[
    {
      "id":"123456",
      "state":"confirmed",
      "created_on":1778511667,
      "created_on_2":"Mon, 11 May 2026",
      "created_on_3":"15:01:07",
      "customer_forename":"Jimmy",
      "customer_surname":"Flutenstafferson",
      "customer_email":"This email address is being protected from spambots. You need JavaScript enabled to view it.",
      "start_inclusive":1778889600,
      "start_inclusive_2":"Sat, 16 May 2026",
      "end_exclusive":1779494400,
      "end_exclusive_2":"Sat, 23 May 2026",
      "currency":"GBP",
      "value":4000,
      "balance":2000,
      "balance_due":1778803200,
      "balance_due_2":"Fri, 15 May 2026",
      "party_size":6,
      "entry_id":"123456",
      "entry_name":"The Old Farmhouse",
      "syndicate_id":"123456",
      "syndicate_name":"booksterhq.com"
    }
  ]
}

Example Response (Single Booking)

{
  "id":1234,
  "state":"confirmed",
  "created_on":1778511667,
  "created_on_2":"Mon, 11 May 2026",
  "created_on_3":"15:01:07",
  "last_updated":1778511667,
  "last_updated_2":"Mon, 11 May 2026",
  "last_updated_3":"15:01:07",
  "customer_title":"Mr",
  "customer_forename":"Bill",
  "customer_surname":"Hicks",
  "customer_email":"This email address is being protected from spambots. You need JavaScript enabled to view it.",
  "customer_company":"bill hicks and co",
  "customer_street":"16 Rutland Square",
  "customer_town_city":"Edinburgh",
  "customer_region":"Midlothian",
  "customer_country":"GB",
  "customer_postal_code":"EH1 2BB",
  "customer_tel_day":"0845 86 212 86",
  "customer_tel_evening":"555 2368",
  "customer_tel_mobile":"07123 456 789",
  "party_size":3,
  "start_inclusive":1778889600,
  "start_inclusive_2":"Sat, 16 May 2026",
  "end_exclusive":1779494400,
  "end_exclusive_2":"Sat, 23 May 2026",
  "currency":"GBP",
  "value":330,
  "balance":330,
  "balance_due":1778803200,
  "balance_due_2":"Fri, 15 May 2026",
  "housekeeping-notes":[
    "Master Bedroom: twin beds",
    "Restock the dishwasher tablets",
    "Leave key under mat"
  ],
  "entry_id":567890,
  "entry_name":"The Farmhouse",
  "syndicate_id":712,
  "syndicate_name":"Airbnb",
  "lines":[
    {
      "type":"product",
      "name":"Electric Pitch",
      "ref":"my-internal-product-reference",
      "rate_group_ref":"my-internal-rate-group-reference",
      "value":280,
      "quantity":1
    },
    {
      "type":"extra",
      "name":"Additional persons (over 2)",
      "ref":"my-internal-extra-reference-1",
      "value":30,
      "quantity":1
    },
    {
      "type":"extra",
      "name":"Dogs",
      "ref":"my-internal-extra-reference-2",
      "value":20,
      "quantity":1
    },
    {
      "type":"extra",
      "name":"Tent",
      "ref":"my-internal-extra-reference-3",
      "value":0,
      "quantity":1
    }
  ],
  "party":[
    {
      "type":"adult",
      "title":"Mr",
      "forename":"Bill",
      "surname":"Hicks",
      "gender":"unknown",
      "age":0
    },
    {
      "type":"adult",
      "title":"Mrs",
      "forename":"Willamena",
      "surname":"Hicks",
      "gender":"unknown",
      "age":0
    },
    {
      "type":"adult",
      "title":"Mr",
      "forename":"Thirdwheel",
      "surname":"Hicks",
      "gender":"unknown",
      "age":0
    }
  ]
}

Export via Excel

Download bookings to an Excel compatible spreadsheet format.

Bookster -> Bookings -> Actions -> Export to Excel

Properties

Use property data directly from a Bookster Website in JSON form to build / update listings dynamically.

List & search find.json

Use find.json to:

  • export all properties
  • filter on facilities or availability searches

Example: https://demo.booksterhq.com/find.json

Note: you must first set up a Bookster Website to export property data via JSON.

{
  "meta": {
    "type": "property",
    "total_count": 3
  },
  "data": [
    {
      "id": 115680,
      "created_on": "2015-11-09",
      "updated_on": "2016-07-12",
      "name": "House by the river",
      "price": {
          "currency": "GBP",
          "cost": 140,
          "saving": 0
      }
    },
    {
      "id": 115653,
      "created_on": "2015-11-03",
      "updated_on": "2015-11-10",
      "name": "House in the valley",
      "price": {
        "currency": "GBP",
        "cost": 350,
        "saving": 0
      }
    },
    {
      "id": 115616,
      "created_on": "2015-10-27",
      "updated_on": "2016-07-06",
      "name": "House on the hill",
      "price": {
        "currency": "GBP",
        "cost": 864,
        "saving": 0
      }
    }
  ]
}

Use the same GET args used on Bookster websites searching e.g.

Facilities: facilities/102-wifi
Properties with Wifi
Availability: availability/2026-12-06-until-2026-12-13-for-2
Properties available to book arriving 2026-12-06, departing 2026-12-13 for 2 people
Location: geoloc/within-50-miles-of-56.041918,-2.820786
Properties within X miles of a lat / lon

Single property details view.json

Example: https://demo.booksterhq.com/view.json/115680-house-by-the-river

  {
    "id": 115680,
    "name": "House by the river",
    "importRef": "",
    "created": 1447082911,
    "updated": 1468329782,
    "elements": {
        "address": {
            "street": "123 Riverside Road",
            "town": "Rivertown",
            "county": "Lothian",
            "region": "Scotland",
            "postcode": "EH1 2BB",
            "country": "United Kingdom"
        },
        "num_bedrooms": "4",
        "catering_options": [
            "self catered"
        ],
        "check_in_ends": "17:00",
        "check_in_starts": "13:00",
        "check_out_time": "10:00",
        "description": "A lovely holiday rental by the river!",
        "directions": "Turn left off the main road when arriving from town, you'll see the Kirk after going under the bridge and the house is on the right hand side.",
        "exterior_description": "An 18th century stone cottage with a beautiful drive.",
        "facilities": {
            "dishwasher": true,
            "tumble_drier": true,
            "fridge_freezer": true,
            "oven": true,
            "linen_provided": true,
            "hair_dryer": true,
            "hi_chair": true,
            "satellite_cable": true,
            "television": true,
            "wireless_internet": true,
            "balcony": true
        },
        "geoloc": [
            55.895952,
            -3.307909
        ],
        "greatfor": {
            "countryside": true,
            "family": true,
            "secluded": true,
            "romantic": true
        },
        "tourist_attractions": "The area nearby is a vibrant place full of wildlife and great natural features. Just up the (insanely steep - be warned if you are cycling) hill, there are the foothills of the Pentlands which surround Rivertown, including some lovely (flatish) walks that suit all abilities (assuming you can get up the initial hill - but you can just take the car!)",
        "recreation": {
            "boat_launch": true,
            "cycle_hire": true,
            "fishing": true,
            "golf": true,
            "horse_riding": true,
            "winter_sports": true,
            "shops": true,
            "bars": true,
            "restaurants": true,
            "health_spa": true,
            "boat_hire": true,
            "boat_mooring": true,
            "car_hire": true,
            "cycle_paths": true,
            "parking": true,
            "playground": true
        },
        "parking_details": "There is ample parking for up to six cars.",
        "gallery": [
            {
                "title": "Sunset",
                "description": "",
                "copyright": "",
                "source": "https:\/\/cdn.tribalogic.net\/uploads\/d4\/402106.jpg",
                "width": 3752,
                "height": 2627,
                "size": 1801821
            },
            {
                "title": "The river",
                "description": "",
                "copyright": "",
                "source": "https:\/\/cdn.tribalogic.net\/uploads\/35\/402102.jpg",
                "width": 4341,
                "height": 3036,
                "size": 2602573
            },
            {
                "title": "A lovely view of the river",
                "description": "\"The River Cam from the Green Dragon Bridge\" by FinlayCox143 - Own work. Licensed under CC BY-SA 3.0 via Commons - https:\/\/commons.wikimedia.org\/wiki\/File:The_River_Cam_from_the_Green_Dragon_Bridge.jpg#\/media\/File:The_River_Cam_from_the_Green_Dragon_Bridge.jpg",
                "copyright": "Licensed under CC BY-SA 3.0 via Commons",
                "source": "https:\/\/cdn.tribalogic.net\/uploads\/8a\/402121.jpg",
                "width": 3999,
                "height": 2799,
                "size": 2428949
            },
            {
                "title": "The river on St Patrick's Day",
                "description": "\"Loboc river\" by Qaalvin - Own work. Licensed under CC BY-SA 3.0 via Commons - https:\/\/commons.wikimedia.org\/wiki\/File:Loboc_river.png#\/media\/File:Loboc_river.png",
                "copyright": "Licensed under CC BY-SA 3.0 via Commons",
                "source": "https:\/\/cdn.tribalogic.net\/uploads\/03\/402125.jpg",
                "width": 766,
                "height": 536,
                "size": 171607
            }
        ],
        "price_range_grain": "nightly",
        "location": [
            [
                "Europe",
                "UK & Eire",
                "Scotland",
                "Lothian"
            ]
        ],
        "sleeping_arrangements": "Four double bedrooms\r\nTwo sofa beds can be set up if required",
        "sleeps_additional": 4,
        "sleeps_basic": 8
    }
}