Ruby SDK for LiteAPI travel services.

• Installation
• Configuration
• Static Data
  • List of Countries
  • List of Cities
  • List of Hotels
  • Hotel Details
  • Hotel Reviews
  • Search Places
  • List of Currencies
  • IATA Codes
  • Hotel Facilities
  • Hotel Types
  • Hotel Chains
• Booking Flow
  • Search Rates
    • Full Rates
    • Minimum Rates
  • Book
    • Prebook
    • Book
  • Booking Management
    • Booking List
    • Booking Details
    • Cancel Booking
• Guests & Loyalty
  • Loyalty Program
  • Enable Loyalty
  • Update Loyalty
  • Guest Details
  • Guest Bookings
• Vouchers
  • List Vouchers
  • Voucher Details
  • Create Voucher
  • Update Voucher
  • Update Voucher Status
• Analytics
  • Weekly Analytics
  • Analytics Report
  • Market Analytics
  • Most Booked Hotels
• Error Handling

Add to your Gemfile:

gem 'liteapi'

Then run:

bundle install

require 'liteapi'

# Global configuration
Liteapi.configure do |config|
  config.api_key = ENV['LITEAPI_API_KEY']
end

client = Liteapi::Client.new

# Or pass API key directly
client = Liteapi::Client.new(api_key: 'your_api_key')

For the full list of available parameters for each endpoint, see the official API documentation at docs.liteapi.travel.

This SDK uses Ruby-style snake_case parameter names which are automatically converted to the API's camelCase format. For example, country_code becomes countryCode.

Returns the list of countries available along with their ISO-2 codes.

result = client.countries

Parameters: None

Returns: Array of country objects

Returns a list of city names from a specific country.

result = client.cities(country_code: 'IT')

Parameters:

Returns: Array of city objects

Returns a list of hotels based on search criteria.

result = client.hotels(country_code: 'IT', city_name: 'Rome')

Parameters:

Returns: Array of hotel objects

Returns all static content details for a specific hotel.

result = client.hotel('lp1897')
result = client.hotel('lp1897', language: 'fr')

Parameters:

Returns: Hotel object with full details

Returns reviews for a specific hotel with optional sentiment analysis.

result = client.hotel_reviews(hotel_id: 'lp1897', limit: 100, sentiment: true)

Parameters:

Returns: Array of review objects

Search for places and areas by query text.

result = client.places(query: 'Manhattan')
result = client.places(query: 'Rome', type: 'hotel', language: 'it')

Parameters:

Returns: Array of place objects

Returns all available currency codes.

result = client.currencies

Parameters: None

Returns: Array of currency objects

Returns IATA codes for all available airports.

result = client.iata_codes

Parameters: None

Returns: Array of IATA objects

Returns the list of available hotel facilities.

result = client.hotel_facilities

Parameters: None

Returns: Array of facility objects

Returns the list of available hotel types.

result = client.hotel_types

Parameters: None

Returns: Array of hotel type objects

Returns the list of available hotel chains.

result = client.hotel_chains

Parameters: None

Returns: Array of hotel chain objects

The booking flow consists of: Search → Prebook → Book → Manage

Returns all available rooms with rates and cancellation policies.

result = client.full_rates(
  hotel_ids: ['lp3803c', 'lp1f982', 'lp19b70'],
  checkin: '2025-03-15',
  checkout: '2025-03-16',
  occupancies: [
    { rooms: 1, adults: 2, children: [2, 3] }
  ],
  currency: 'USD',
  guest_nationality: 'US',
  guest_id: 'guest_123'  # optional, for loyalty pricing
)

Parameters:

Occupancy object:

Returns: Hash with hotel rates

Returns only minimum rates per hotel for quick comparison.

result = client.min_rates(
  hotel_ids: ['lp3803c', 'lp1f982'],
  checkin: '2025-03-15',
  checkout: '2025-03-16',
  occupancies: [{ rooms: 1, adults: 2 }],
  currency: 'USD',
  guest_nationality: 'US'
)

Parameters: Same as full_rates (except guest_id)

Returns: Array of minimum rate objects

Confirms room availability and pricing before booking.

result = client.prebook(offer_id: 'offer_abc123')

Parameters:

Returns: Prebook confirmation

Completes the booking with guest and payment information.

result = client.book(
  prebook_id: 'prebook_xyz789',
  guest: {
    first_name: 'John',
    last_name: 'Doe',
    email: 'john.doe@example.com'
  },
  payment: {
    holder_name: 'John Doe',
    card_number: '4111111111111111',
    expire_date: '12/25',
    cvc: '123'
  },
  client_reference: 'my-booking-123'  # optional
)

Parameters:

Guest object:

Payment object:

Returns: Booking confirmation

Returns bookings by client reference.

result = client.bookings(client_reference: 'my-booking-123')

Parameters:

Returns: Array of booking objects

Returns details for a specific booking.

result = client.booking('booking_abc123')

Parameters:

Returns: Full booking object (same as book response)

Cancels an existing booking (subject to cancellation policy).

result = client.cancel_booking('booking_abc123')

Parameters:

Returns: Cancellation result

Returns current loyalty program settings.

result = client.loyalty

Parameters: None

Returns: Loyalty program object

Creates a new loyalty program.

result = client.enable_loyalty(status: 'enabled', cashback_rate: 0.03)

Parameters:

Returns: Loyalty program object

Updates existing loyalty program settings.

result = client.update_loyalty(status: 'enabled', cashback_rate: 0.05)

Parameters: Same as enable_loyalty

Returns: Updated loyalty program object

Retrieves detailed information about a guest.

result = client.guest(123)

Parameters:

Returns: Guest object

Retrieves all bookings for a guest with loyalty information.

result = client.guest_bookings(123)

Parameters:

Returns: Array of booking objects with loyalty data

Retrieves all available vouchers.

result = client.vouchers

Parameters: None

Returns: Array of voucher objects

Retrieves details for a specific voucher.

result = client.voucher(42)

Parameters:

Returns: Voucher object with full details

Creates a new voucher.

result = client.create_voucher(
  voucher_code: 'SUMMER20',
  discount_type: 'percentage',
  discount_value: 20,
  minimum_spend: 100,
  maximum_discount_amount: 50,
  currency: 'USD',
  validity_start: '2025-06-01',
  validity_end: '2025-08-31',
  usages_limit: 100,
  status: 'active'
)

Parameters:

Returns: Creation confirmation

Updates an existing voucher.

result = client.update_voucher(42,
  voucher_code: 'SUMMER25',
  discount_type: 'percentage',
  discount_value: 25,
  # ... all other parameters required
)

Parameters: voucher_id plus all parameters from create_voucher

Returns: Update confirmation

Activates or deactivates a voucher.

result = client.update_voucher_status(42, status: 'inactive')

Parameters:

Returns: Status update confirmation

Fetches weekly analytics data for a date range.

result = client.weekly_analytics(from: '2025-01-01', to: '2025-01-07')

Parameters:

Returns: Weekly analytics object

Fetches a detailed analytics report.

result = client.analytics_report(from: '2025-01-01', to: '2025-01-31')

Parameters: Same as weekly_analytics

Returns: Detailed report object

Fetches market-level analytics data.

result = client.market_analytics(from: '2025-01-01', to: '2025-01-31')

Parameters: Same as weekly_analytics

Returns: Market analytics object

Fetches data on most booked hotels.

result = client.most_booked_hotels(from: '2025-01-01', to: '2025-01-31')

Parameters: Same as weekly_analytics

Returns: Array of hotel objects

The SDK raises specific exceptions for different error types:

begin
  client.hotel('invalid_id')
rescue Liteapi::AuthenticationError => e
  # 401 - Invalid API key
  puts "Auth error: #{e.message}"
  puts "Status: #{e.status}"
rescue Liteapi::NotFoundError => e
  # 404 - Resource not found
  puts "Not found: #{e.message}"
rescue Liteapi::ValidationError => e
  # 422 - Invalid request parameters
  puts "Validation error: #{e.message}"
rescue Liteapi::RateLimitError => e
  # 429 - Too many requests
  puts "Rate limited: #{e.message}"
rescue Liteapi::ServerError => e
  # 5xx - Server error
  puts "Server error: #{e.message}"
rescue Liteapi::APIError => e
  # Other API errors
  puts "API error (#{e.status}): #{e.message}"
  puts "Response: #{e.response}"
end

All API errors include:

• message - Error description
• status - HTTP status code
• code - API error code
• response - Full error response

bundle install
bundle exec rake test

MIT License. See LICENSE.txt.