liteAPI

https://docs.liteapi.travel/docs
Admin
liteAPI is a travel API platform that provides seamless access to hotel data, real-time...
Tokens:151,523
Snippets:1,214
Trust Score:5
Update:8 hours ago
Show doc for...
Tokens:
Raw
### Start the example app with npm start

Source: https://docs.liteapi.travel/docs/nodejs-cookbook

Run this command in the project directory to start the Node.js server. After starting, open http://localhost:3000 in your browser to see the app.

```bash
npm start
```

--------------------------------

### Example URL: Home / entry

Source: https://docs.liteapi.travel/docs/password-protected-site-access-id-sig

Example URL for the home/entry page with id and sig parameters.

```text
https://wl-domain/?id=partner-1735680000&sig=YOUR_HEX_SIGNATURE
```

--------------------------------

### Example URL: Checkout

Source: https://docs.liteapi.travel/docs/password-protected-site-access-id-sig

Example URL for the checkout page with existing parameters plus id and sig.

```text
https://wl-domain/booking?offerId=abc123xyz&id=partner-1735680000&sig=YOUR_HEX_SIGNATURE
```

--------------------------------

### Install Project Dependencies

Source: https://docs.liteapi.travel/docs/nodejs-cookbook

Install the required dependencies for the project using npm.

```bash
npm install
```

--------------------------------

### HTML example for displaying cancellation policies

Source: https://docs.liteapi.travel/docs/displaying-hotel-details

HTML markup to display the cancellation policy details, including the cancel time, amount charged, and refundable status. This example is provided under the 'Example' section.

```html
<h2>Cancellation Policies</h2>
<div>
  <h3>Policy</h3>
  <p>Cancel Time: November 11th, 2024, 08:00 AM GMT</p>
  <p>Amount Charged: $712.39 USD</p>
  <p>Refundable: Yes</p>
</div>
```

--------------------------------

### Example URL: Hotel details

Source: https://docs.liteapi.travel/docs/password-protected-site-access-id-sig

Example URL for the hotel details page with existing parameters plus id and sig.

```text
https://wl-domain/hotels/lp4aa75?checkin=2024-09-15&checkout=2024-09-20&id=partner-1735680000&sig=YOUR_HEX_SIGNATURE
```

--------------------------------

### Example URL with xData

Source: https://docs.liteapi.travel/docs/deeplinking-to-whitelabel

Example URL showing how to pass the encoded xData parameter. When a user lands on this URL, the xData is decoded and stored automatically, and checkout will pre-fill guest, holder, and discount information.

```url
https://test.nuitee.link?xData=H4sIAAAAAA...
```

--------------------------------

### Example URL: Hotel listing

Source: https://docs.liteapi.travel/docs/password-protected-site-access-id-sig

Example URL for the hotel listing page with existing parameters plus id and sig.

```text
https://wl-domain/hotels?placeId=ChIJgUbEo8cfqokR5lP9_Wh_DaM&checkin=2024-09-15&checkout=2024-09-20&id=partner-1735680000&sig=YOUR_HEX_SIGNATURE
```

--------------------------------

### occupancies parameter example

Source: https://docs.liteapi.travel/docs/rate-request-parameters-guide

JSON example showing how to specify multiple rooms with adults and children ages for a rate request. The example includes two rooms: one with three adults and two children (ages 5 and 6), and another with one adult and two children (age 2).

```json
"occupancies": [
    {
      "adults": 3
      "children": [
        5,
        6
      ],
    },
    {
      "adults": 1,
      "children": [
        2
      ]
    }
  ]
```

--------------------------------

### Example 1: Browser Redirect

Source: https://docs.liteapi.travel/docs/single-sign-on-deep-link-guide

The browser redirect URL for the email-only signup example, pointing to the magic login endpoint with the token.

```text
https://travel-brand.example/auth/magic-login?token=Zxcv098765...
```

--------------------------------

### Search response with perks example

Source: https://docs.liteapi.travel/docs/perks-and-promotions

Example JSON response from a Search request showing a rate object with a perks array containing multiple perks, and a guestLevel field at the top level.

```json
{
  "data": [
    {
      "hotelId": "lp1897",
      "roomTypes": [
        {
          "offerId": "...",
          "rates": [
            {
              "rateId": "...",
              "name": "Standard King Room",
              "retailRate": {
                "total": [{ "amount": 163.66, "currency": "USD" }]
              },
              "perks": [
                {
                  "perkId": 10,
                  "name": "Daily breakfast for 2",
                  "amount": 40,
                  "currency": "USD",
                  "level": "HOTEL"
                },
                {
                  "perkId": 5,
                  "name": "Late check-out if available",
                  "amount": 20,
                  "currency": "USD",
                  "level": "HOTEL"
                },
                {
                  "perkId": 8,
                  "name": "Room upgrade if available",
                  "amount": 60,
                  "currency": "USD",
                  "level": "HOTEL"
                },
                {
                  "perkId": 6,
                  "name": "Early check-in if available",
                  "amount": 0,
                  "currency": "USD",
                  "level": "HOTEL"
                },
                {
                  "perkId": 2,
                  "name": "$100 Property credit",
                  "amount": 100,
                  "currency": "USD",
                  "level": "HOTEL"
                }
              ]
            }
          ]
        }
      ],
      "guestLevel": 0
    }
  ]
}
```

--------------------------------

### Create hotels list with hidden search bar and one row

Source: https://docs.liteapi.travel/docs/integrate-a-hotels-list-widget

Alternative example where the search bar is hidden and only one row of results is displayed. This is a separate example from the main initialization snippet.

```HTML
<script>
  LiteAPI.init({
    domain: 'whitelabel.nuitee.link'
  });

  LiteAPI.HotelsList.create({
    selector: '#hotels-list',
    placeId: 'ChIJdd4hrwug2EcRmSrV3Vo6llI',
    primaryColor: '#7057F0',
    hasSearchBar: false,
    rows: 1
  });
</script>
```

--------------------------------

### Example JSON Response for Weather Data

Source: https://docs.liteapi.travel/docs/weather-data-api-endpoint

Example weather data for San Francisco (latitude: 37.7749, longitude: -122.4194) for January 3, 2025. The API returns JSON format, and each day in the date range gets its own dailyWeather object.

```json
{
  "weatherData": [
    {
      "dailyWeather": {
        "date": "2025-01-03",
        "units": "metric",
        "cloud_cover": {
          "afternoon": 41.61
        },
        "humidity": {
          "afternoon": 87.67
        },
        "precipitation": {
          "total": 1.92
        },
        "temperature": {
          "min": 14.09,
          "max": 16.75,
          "afternoon": 14.09,
          "night": 16.75,
          "evening": 14.73,
          "morning": 14.4
        },
        "pressure": {
          "afternoon": 1016.84
        },
        "wind": {
          "max": {
            "speed": 6.61,
            "direction": 287.15
          }
        }
      }
    }...
}
```

--------------------------------

### Full HTML example with map widget

Source: https://docs.liteapi.travel/docs/integrate-a-map-widget

Complete HTML file showing SDK inclusion, initialization, and map creation with popup styling, labels, check-in/check-out dates, and filters.

```HTML
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Nuitee Connect Map Example</title>
    <!-- Include Nuitee Connect SDK -->
    <script src="https://components.liteapi.travel/v1.0/sdk.umd.js"></script>
  </head>
  <body>
    <!-- Container for the map -->
    <div id="map" style="height: 500px"></div>

    <script>
      // Initialize Nuitee Connect SDK with your domain
      LiteAPI.init({
        domain: 'whitelabel.nuitee.link',
        deepLinkParams: 'language=fr&currency=EUR',
        labelsOverride: {
          searchAction: 'Search',
          placePlaceholderText: 'Search for a destination',
        },
      });

      // Create the map and render it inside the container
      LiteAPI.Map.create({
        selector: '#map',
        placeId: 'ChIJ5TCOcRaYpBIRCmZHTz37sEQ',
        primaryColor: '#7057F0',
				popup: {
          titleColor: '#0F1042',
          textColor: '#1C0C45',
          backgroundColor: '#ffffff96',
        }
        // Optional: control dates and filter results
        checkin: '2026-05-21',
        checkout: '2026-05-22',
        filters: {
          hotelTypes: [201, 208, 216, 222],
          popularFilters: 'apartments',
        },
      });
    </script>
  </body>
</html>
```

--------------------------------

### Example of Stream Hotel Rates data format

Source: https://docs.liteapi.travel/docs/stream-hotel-rates

Shows the incremental data format of the streamed response. Each line starts with 'data:' and is separated by a newline. The stream ends with 'data: [DONE]'.

```text
data: {"rates":[{"hotelId":"lp19d80","roomTypes":[{...}]},{"hotelId":"lp19d81","roomTypes":[{...}]}]} \n\n
data: {"rates":[{"hotelId":"lp19c91","roomTypes":[{...}]},{"hotelId":"lp19c92","roomTypes":[{...}]}]} \n\n
data: {"rates":[{"hotelId":"lp19eda","roomTypes":[{...}]},{"hotelId":"lp19edb","roomTypes":[{...}]}]} \n\n
data: {"hotels":[{"id":"lp19d80","name":"Resorts Casino Hotel ...},{"id":"lp19d81","name":"Resorts Hotel ...}]}  \n\n
data: [DONE] \n\n
```

--------------------------------

### Initialize SDK and Render Map with LiteAPI.init and LiteAPI.Map.create

Source: https://docs.liteapi.travel/docs/integrate-a-map-widget

Use this script to initialize the LiteAPI SDK with your WhiteLabel domain and render the map inside a specified container. The placeId centers the map on a location, and primaryColor sets the brand color for buttons. Place this script after the SDK loading script from Step 1.

```HTML
<script>
  // Initialize the SDK with your domain
  LiteAPI.init({
    domain: 'whitelabel.nuitee.link'
  });

  // Create and display the map inside the container
  LiteAPI.Map.create({
    selector: '#map',  // The container where the map will be rendered
    placeId: 'ChIJ5TCOcRaYpBIRCmZHTz37sEQ',  // The placeId to center the map (e.g. Barcelona)
    primaryColor: '#7057F0'  // Your brand color (hex code) to use for buttons
  });
</script>
```

--------------------------------

### Full HTML example for search bar integration

Source: https://docs.liteapi.travel/docs/integrate-a-search-bar-widget

Complete HTML file that includes the SDK, initializes LiteAPI with domain and labels, and creates the search bar. The search bar is rendered in a div with id 'search-bar' and clicking the button opens the Whitelabel website.

```HTML
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Nuitee Connect Search Bar Example</title>
    <!-- Include Nuitee Connect SDK -->
    <script src="https://components.liteapi.travel/v1.0/sdk.umd.js"></script>
  </head>
  <body>
    <!-- Container for the search bar -->
    <div id="search-bar" style="width: 100%"></div>

    <script>
      // Initialize Nuitee Connect SDK with your domain
      LiteAPI.init({
        domain: 'whitelabel.nuitee.link',
        deepLinkParams: 'language=fr&currency=EUR',
        labelsOverride: {
          searchAction: 'Search',
          placePlaceholderText: 'Search for a destination',
        },
      });

      // Create the search bar and render it inside the container
      LiteAPI.SearchBar.create({
        selector: '#search-bar', // The container where the search bar will be rendered
        primaryColor: '#7057F0', // Your brand color (hex code) for the button
      });
    </script>
  </body>
</html>
```

--------------------------------

### Initialize SDK and render search bar

Source: https://docs.liteapi.travel/docs/integrate-a-search-bar-widget

Use this script to initialize the SDK with your WhiteLabel domain and create the search bar inside the container. Place this script after the SDK script tag from Step 1. Options include selector (required), primaryColor, openGuestPopup, deepLinkParams, and labelsOverride.

```HTML
<script>
 // Initialize the SDK with your domain
  LiteAPI.init({
    domain: 'whitelabel.nuitee.link'
  });

  // Create the search bar and render it inside the container
  LiteAPI.SearchBar.create({
    selector: '#search-bar', // The container where the search bar will be rendered
    primaryColor: '#7057F0' // Your brand color (hex code) to use for buttons
  });
</script>
```

--------------------------------

### GET /experiences/bookings/{bookingId}

Source: https://docs.liteapi.travel/docs/experiences-reference

Get experience booking. This endpoint returns details of a specific booking.

```APIDOC
## GET /experiences/bookings/{bookingId}

### Description
Get experience booking.

### Method
GET

### Endpoint
/experiences/bookings/{bookingId}

### Parameters
#### Path Parameters
- **bookingId** (string) - Required - The unique identifier of the booking.

### Response
#### Success Response (200)
- **booking** (object) - Booking details.

#### Response Example
{
  "booking": {}
}
```

--------------------------------

### LiteAPI.init

Source: https://docs.liteapi.travel/docs/integrate-a-hotels-list-widget

Initializes the LiteAPI with global configuration, including domain and deep link parameters that apply to all widgets unless overridden.

```APIDOC
## LiteAPI.init

### Description
Initializes the LiteAPI with global configuration, including domain and deep link parameters that apply to all widgets unless overridden.

### Method
init

### Endpoint
LiteAPI.init

### Parameters
#### Options Object
- **domain** (string) - Required - The White Label domain (e.g., 'whitelabel.nuitee.link').
- **deepLinkParams** (string) - Optional - Query string appended to the booking URL (e.g., 'language=fr&currency=EUR').

### Request Example
```javascript
LiteAPI.init({
  domain: 'whitelabel.nuitee.link',
  deepLinkParams: 'language=fr&currency=EUR',
});
```

### Response
No explicit response documented.

### Notes
- deepLinkParams is appended only to the click-through booking URL and does not filter results or change dates.
```

--------------------------------

### GET /experiences/tours/{id}/reviews

Source: https://docs.liteapi.travel/docs/experiences-reference

Get tour reviews. This endpoint returns reviews for a specific tour.

```APIDOC
## GET /experiences/tours/{id}/reviews

### Description
Get tour reviews.

### Method
GET

### Endpoint
/experiences/tours/{id}/reviews

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the tour.

### Response
#### Success Response (200)
- **reviews** (array) - List of reviews for the tour.

#### Response Example
{
  "reviews": []
}
```

--------------------------------

### Full HTML example for hotels list widget

Source: https://docs.liteapi.travel/docs/integrate-a-hotels-list-widget

Complete HTML file that includes the Nuitee Connect SDK, initializes it with a domain and global labels, and creates a hotels list widget with search bar, primary color, rows, dates, and filters.

```HTML
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Nuitee Connect Hotels List Example</title>
    <!-- Include Nuitee Connect SDK -->
    <script src="https://components.liteapi.travel/v1.0/sdk.umd.js"></script>
  </head>
  <body>
    <!-- Container for the hotel list -->
    <div id="hotels-list"></div>

    <script>
      // Initialize Nuitee Connect SDK with your domain
      LiteAPI.init({
        domain: 'whitelabel.nuitee.link',
        deepLinkParams: 'language=fr&currency=EUR',
        labelsOverride: {
          searchAction: 'Search',
          placePlaceholderText: 'Search for a destination',
        },
      });

      // Create the hotels list and render it inside the container
      LiteAPI.HotelsList.create({
        selector: '#hotels-list',
        placeId: 'ChIJdd4hrwug2EcRmSrV3Vo6llI',
        primaryColor: '#7057F0',
        hasSearchBar: true,
        rows: 2,
        // Optional: control dates and filter results
        checkin: '2026-05-21',
        checkout: '2026-05-22',
        filters: {
          hotelTypes: [201, 208, 216, 222],
          popularFilters: 'apartments',
        },
      });
    </script>
  </body>
</html>
```

--------------------------------

### GET /experiences/tours/{id}/availability

Source: https://docs.liteapi.travel/docs/experiences-reference

Get tour availability. This endpoint returns availability information for a specific tour.

```APIDOC
## GET /experiences/tours/{id}/availability

### Description
Get tour availability.

### Method
GET

### Endpoint
/experiences/tours/{id}/availability

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the tour.

### Response
#### Success Response (200)
- **availability** (object) - Availability details for the tour.

#### Response Example
{
  "availability": {}
}
```

--------------------------------

### Example 2: Phone-Only Authentication - Our Response

Source: https://docs.liteapi.travel/docs/single-sign-on-deep-link-guide

Response containing the loginUrl with a magic link token for the phone-only login example.

```json
{
  "loginUrl": "https://travel-brand.example/auth/magic-login?token=Yxcv098765..."
}
```

--------------------------------

### LiteAPI.init with Deep Link Params

Source: https://docs.liteapi.travel/docs/integrate-a-map-widget

Initializes the LiteAPI SDK globally with deep link parameters to append to booking URLs.

```APIDOC
## LiteAPI.init

### Description
Initializes the LiteAPI SDK globally with deep link parameters to append to booking URLs.

### Method
JavaScript SDK method

### Endpoint
LiteAPI.init(options)

### Parameters
#### Options Object
- **domain** (string) - Required - The White Label domain (e.g., 'whitelabel.nuitee.link').
- **deepLinkParams** (string) - Optional - Query string to append to booking URLs (no leading '?').

### Request Example
```html
<script>
  LiteAPI.init({
    domain: 'whitelabel.nuitee.link',
    deepLinkParams: 'language=fr&currency=EUR',
  });
</script>
```

### Response
No explicit response documented.

### Notes
- deepLinkParams is appended only to the click-through booking URL; it does not filter hotels or change dates.
- Use for tracking parameters such as utm_source, affiliate, or clientReference.
```

--------------------------------

### Example 1: Email-Only Authentication - Our Response

Source: https://docs.liteapi.travel/docs/single-sign-on-deep-link-guide

Response containing the loginUrl with a magic link token for the email-only signup example.

```json
{
  "loginUrl": "https://travel-brand.example/auth/magic-login?token=Zxcv098765..."
}
```

--------------------------------

### Example 1: Final Landing Page

Source: https://docs.liteapi.travel/docs/single-sign-on-deep-link-guide

Final landing page URL after successful email-only signup, containing session token and magicLogin=true.

```text
https://travel-brand.example/hotels?token=<session>&magicLogin=true
```

--------------------------------

### Project Structure for LiteAPI Node.js Cookbook

Source: https://docs.liteapi.travel/docs/nodejs-cookbook

Shows the directory layout after setup, including the .env file, server/server.js, and client files (index.html, app.js, styles.css). The client pings server.js for API requests.

```text
project-directory/
├── .env.example
├── .env //That you created in the step above
├── .gitignore
├── README.md
├── package.json
├── package-lock.json
├── node_modules/
├── server/
│   └── server.js
└── client/
    ├── styles.css
    ├── index.html
    └── app.js
```

--------------------------------

### GET /experiences/bookings/{bookingId}/cancel-preview

Source: https://docs.liteapi.travel/docs/experiences-reference

Get experience cancellation quote. This endpoint returns a cancellation quote for a specific booking.

```APIDOC
## GET /experiences/bookings/{bookingId}/cancel-preview

### Description
Get experience cancellation quote.

### Method
GET

### Endpoint
/experiences/bookings/{bookingId}/cancel-preview

### Parameters
#### Path Parameters
- **bookingId** (string) - Required - The unique identifier of the booking.

### Response
#### Success Response (200)
- **cancellationQuote** (object) - Cancellation quote details.

#### Response Example
{
  "cancellationQuote": {}
}
```
Tokens:
Raw