Booking Engine
Use this endpoint to fetch real-time room availability, nightly pricing, and property details β the building blocks for a custom booking flow on your own website.
Related API Pages
Endpoint
POST /api/v1/get-new-avilabliltyNote on the URL: The endpoint path contains a deliberate typo (
avilabliltyinstead ofavailability). This is the actual path β copy it exactly as shown.
Example curl Request
curl RequestThis endpoint does not require
X-API-Keyauthentication β it is a public endpoint intended for guest-facing booking flows.
Request Payload
dates
array
Feed us the specific dates you want to check availability for! (Format: YYYY-MM-DD).
property
string
Simply your unique property ID (UUID).
Response
The response includes available rooms with per-date pricing, property details, and an optional price adjustment to apply before displaying prices to guests.
Response Structure
Response Fields
days
array
Available rooms matching the requested dates. One entry per room.
days[].room_id
string
Room UUID. Use this as the room field when creating a booking.
days[].room_name
string
Display name for the room.
days[].room_description
string
Room description text.
days[].date
array
Per-date pricing entries for this room.
days[].date[].date
string
The date in YYYY-MM-DD format.
days[].date[].price
number | false
Price for this date. false means the room is fully booked for that night.
days[].image_fullpath
array
Array of image URLs for the room.
name
string
Property name.
city
string
City the property is in.
country
string
Country the property is in.
postal_code
string
Property postal code.
payment_gateway
object
Payment gateway configuration for this property.
payment_gateway.status
boolean
true if the payment gateway is active.
payment_gateway.currency
string
ISO 4217 currency code (e.g., "gbp").
payment_gateway.options
array
Supported payment options.
state
string
State or region the property is in.
rate
string
Property rating.
phone
string
Property phone number.
description
string
Property description text.
googleMapLink
string
Google Maps URL for the property location.
address
string
Full property address.
website
string
Your beautifully built property website URL.
main-image
string
URL of the property's main cover image.
howToReachUsLink
string
URL with directions to the property (typically a Google Maps link).
price_adjustment
object | null
The net price adjustment configured by the property for their booking engine. null when no adjustment is set or when rules cancel each other out (net = 0%). When present, apply this to each room's per-date price before displaying it to guests.
price_adjustment.type
string
"increase" or "decrease" β the direction of the net adjustment.
price_adjustment.percentage
number
The absolute net percentage to apply. For example, 10 means Β±10% depending on type.
Last updated