Skip to main content
Version: 1.0.0

Booking Brain Developer API

The Booking Brain Developer API gives you full programmatic access to holiday rental property search, availability, pricing, booking, and payment — everything you need to build a custom booking experience on top of the Booking Brain platform.

Authentication​

Every request must include an X-API-Key header. Keys are issued per-client and scoped to specific IP addresses and origins.

X-API-Key: bb_sandbox_test_key_do_not_use_in_production

Sandbox keys are available for development and testing. They return real search and property data but will not create actual bookings or process payments.

Rate Limiting​

Each API key has a configurable rate limit. When you exceed it, the API returns 429 Too Many Requests with a Retry-After header indicating how many seconds to wait before retrying.

Pagination​

List endpoints return paginated results. Use page (1-based) and limit query parameters to navigate. Response metadata includes total, page, limit, and totalPages (or equivalent fields).

Error Handling​

All errors follow a consistent shape:

{
  "statusCode": 403,
  "message": "Forbidden",
  "error": "Forbidden"
}

Validation errors (422) return message as an array of human-readable strings.

Typical Booking Flow​

  1. Search — GET /developer/search to find properties
  2. Detail — GET /developer/properties/{id} for full listing info
  3. Availability — GET /developer/properties/{id}/unavailableDates to populate a calendar
  4. Pricing — POST /developer/properties/{id}/get-price to calculate the total
  5. Book — POST /developer/bookings/save to create the reservation
  6. Pay — POST /developer/bookings/processPayment to charge the guest's card

Authentication​

API key issued per client. Include in every request as the X-API-Key header. Sandbox keys (prefixed bb_sandbox_) return real data but cannot create bookings or process payments.

Security Scheme Type:

apiKey

Header parameter name:

X-API-Key