Calendar Block Types

How to read and understand calendar blocks.

Every response, in return for requests for calendar date data, includes a blocks object. Nested inside the object is a list of possible block types. Here is an excerpt of a response:

    {
      "date":"2023-06-14",
      "listingId":"62e17bddae108b003b1f87d7",
      "currency":"USD",
      "price":50,
      "isBasePrice":true,
      "minNights":1,
      "isBaseMinNights":true,
      "status":"available",
      "blocks":{
        "m":false,
        "r":false,
        "b":false,
        "bd":false,
        "sr":false,
        "abl":false,
        "a":false,
        "bw":false,
        "o":false,
        "pt":false,
        "ic":false
      }
      ...

When a date is unavailable or booked or reserved, the relevant block type value will change to true. Here is what it looks like when a date has a reservation. Note that block type r is true.

{
  "date":"2023-06-15",
  "listingId":"62e17bddae108b003b1f87d7",
  "currency":"USD",
  "price":70,
  "isBasePrice":false,
  "minNights":1,
  "isBaseMinNights":true,
  "status":"booked",
  "blocks":{
    "m":false,
    "r":true,
    "b":false,
    "bd":false,
    "sr":false,
    "abl":false,
    "a":false,
    "bw":false,
    "o":false,
    "pt":false,
    "an":true
  },
  ...

Types of Blocks

Block TypeDescription
mManual block.
rReserved date.
bBooked by a reservation.
bdThe calendar date is blocked by default.
srSmart calendar rule block.
ablBlocked as a result of the listing having reached its annual booking limit.
aAn allotment block (this appears on a multi-unit and its units only).
bwBlocked by the booking window (i.e. no booking window for that calendar date).
oBlocked by an owner's reservation.
ptPreparation time block.
icAn iCal imported event from an external calendar
anAdvance notice.

Related Reference Documents