yt24-sdk-python 1.0.0

Official Python SDK for the YourTransfer24 REST JSON API Platform

yt24-sdk-python

Official Python SDK for the YourTransfer24 REST JSON API Platform. Provides clean access to API authentication, profile data, bookings, booking status, vehicles, companies, coverage, availability, quotes, and logs. Fully aligned with the official YourTransfer24 API documentation.

---

Installation

pip install yt24-sdk-python

---

Initialization

from yt24_sdk import (
    YT24Client,
    ProfileAPI,
    BookingsAPI,
    AvailabilityAPI,
    QuoteAPI,
    VehiclesAPI,
    CompaniesAPI,
    CoverageAPI,
    LogsAPI
)

client = YT24Client("YOUR_API_KEY", environment="sandbox")

# API Modules
profile = ProfileAPI(client)
bookings = BookingsAPI(client)
availability = AvailabilityAPI(client)
quote = QuoteAPI(client)
vehicles = VehiclesAPI(client)
companies = CompaniesAPI(client)
coverage = CoverageAPI(client)
logs = LogsAPI(client)

---

API Usage

1. Profile

# Get profile
profile_data = profile.get_profile()

# Update profile
profile.update_profile({
    "first_name": "John",
    "last_name": "Doe"
})

2. Bookings

List, Get, Create, Confirm, Update Status

This section uses the complete booking payload exactly as defined in the official YourTransfer24 API documentation.

# List bookings
bookings.list()

# With filters
bookings.list({"limit": 20, "page": 2})

# Get booking
bookings.get(123)

# Create booking (FULL REAL PAYLOAD)
booking_data = {
    "pickup_location": "Airport",
    "dropoff_location": "Hotel",
    "date": "2025-01-20",
    "passengers": 3,
    "luggage": 2,
    "vehicle_type": "Sedan",
    "flight_number": "AA123",
    "arrival_time": "14:30",
    "child_seats": 1,
    "notes": "Customer prefers front seat",
    "customer": {
        "first_name": "John",
        "last_name": "Doe",
        "email": "[e-mail]",
        "phone": "[phone]"
    }
}

# Create booking
response = bookings.create(booking_data)

# Retrieve booking
booking = bookings.get(response["id"])

# Confirm booking
bookings.confirm(response["id"])

# Update booking status
bookings.update_status(response["id"], { "status": "confirmed" })

3. Availability

availability.check({
    "pickup_location": "Airport",
    "dropoff_location": "Hotel",
    "date": "2025-01-20"
})

4. Quote

quote.get_quote({
    "pickup_location": "Airport",
    "dropoff_location": "Hotel",
    "passengers": 2
})

5. Vehicles

# List vehicles
vehicles.list()

# Vehicle details
vehicles.get(5)

6. Companies

# Company list
companies.list()

# Company details
companies.get(12)

7. Coverage

# Coverage zones
coverage.list()

8. Logs

# Logs with filters
logs.list({"booking_id": 123})

---

Error Handling

YourTransfer24 API returns structured error responses:

{
  "error": true,
  "type": "validation_error",
  "message": "Pickup location is required",
  "err_key": "YT24_400_01"
}

Capturing Errors

try:
    bookings.create({})
except Exception as err:
    print(err.status)     # HTTP status code
    print(err.err_key)    # YourTransfer24 error key
    print(err.args[0])    # Error message

The SDK returns errors exactly as provided by the YourTransfer24 API. No modifications, wrappers, or internal transformations are applied.

---

Project Structure

yt24-sdk-python/
│── README.md
│── LICENSE
│── pyproject.toml
└── yt24_sdk/
    ├── __init__.py
    ├── client.py
    ├── profile.py
    ├── bookings.py
    ├── availability.py
    ├── quote.py
    ├── vehicles.py
    ├── companies.py
    ├── coverage.py
    ├── logs.py

---

License

MIT License © YourTransfer24