Skip to content

README.md

Latest commit

聽

History

History
73 lines (54 loc) 路 2.05 KB

README.md

File metadata and controls

73 lines (54 loc) 路 2.05 KB
Raw

Hospitable Python SDK Documentation

Overview

The Hospitable Python SDK provides a comprehensive interface to the Hospitable Public API v2, allowing you to manage vacation rental properties, reservations, calendars, guest messaging, and reviews programmatically.

Table of Contents

Key Features

  • Properties Management: List, search, and manage vacation rental properties
  • Reservations: Access booking data across all connected platforms
  • Calendar Management: Update pricing and availability
  • Guest Messaging: Send and receive messages with rate limiting
  • Reviews: Access and respond to guest reviews
  • Webhooks: Real-time event notifications
  • OAuth2 & PAT Support: Both vendor OAuth and personal access tokens

Installation

pip install hospitable-python

Quick Example

from hospitable import HospitableClient

# Initialize with Personal Access Token
client = HospitableClient(token="your_pat_token")

# Get all properties
properties = client.properties.list()

# Get reservations for a property
reservations = client.reservations.list(
    properties=["property-uuid"],
    start_date="2024-01-01",
    end_date="2024-12-31"
)

# Update calendar pricing
client.properties.update_calendar("property-uuid", [
    {
        "date": "2024-03-15",
        "price": {"amount": 15000},  # $150.00
        "available": True,
        "min_stay": 2
    }
])

API Versions

  • Current: v2 (recommended)
  • Deprecated: v1 (sunset: February 3rd, 2025)

The SDK automatically uses API v2 endpoints and handles versioning transparently.

Support