Host Tools API (Airbnb, VRBO, Booking.com)

https://hosttools.com
Admin
Host Tools API is a comprehensive REST API for Airbnb, VRBO, and Booking.com property management,...
Tokens:27,058
Snippets:99
Trust Score:9.9
Update:7 months ago
Show doc for...
Tokens:
Raw
### Get Reviews using Node.js

Source: https://host-tools.readme.io/reference/reviews

This Node.js example shows how to retrieve reviews for a given listing ID. It utilizes the `axios` library to make an HTTP GET request to the Host Tools API. Ensure you have an active `authToken` and the listing has an Airbnb channel connected.

```javascript
const axios = require('axios');

const getReviews = async (listingID, authToken) => {
  try {
    const response = await axios.get(`https://app.hosttools.com/api/getReviews/${listingID}`, {
      headers: {
        'Authorization': `Bearer ${authToken}`,
        'accept': 'application/json'
      }
    });
    return response.data;
  } catch (error) {
    console.error('Error fetching reviews:', error.response ? error.response.data : error.message);
    throw error;
  }
};

// Example usage:
// const listingId = 'your_listing_id';
// const userAuthToken = 'your_auth_token';
// getReviews(listingId, userAuthToken).then(data => console.log(data)).catch(err => console.error(err));
```

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

### Get Pricing Quote API Request (Node.js)

Source: https://host-tools.readme.io/reference/quotes

This Node.js example shows how to make a POST request to the Get Pricing Quote API using the 'axios' library. It constructs the request URL, sets the necessary headers, and sends a JSON body containing guest information. Remember to replace `listingID` with the actual ID.

```javascript
const axios = require('axios');

const listingID = 'YOUR_LISTING_ID'; // Replace with actual listing ID
const apiKey = 'YOUR_API_KEY'; // Replace with your API key
const authToken = 'YOUR_AUTH_TOKEN'; // Replace with your auth token

const requestBody = {
  guests: {
    children: 0,
    infants: 0,
    pets: 0
  }
};

axios.post(`https://app.hosttools.com/api/getQuote/${listingID}`, requestBody, {
  headers: {
    'accept': 'application/json',
    'content-type': 'application/json',
    'apiKey': apiKey,
    'authToken': authToken
  }
})
.then(response => {
  console.log('Quote:', response.data);
})
.catch(error => {
  console.error('Error fetching quote:', error.response ? error.response.data : error.message);
});
```

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

### Get Reviews using Python

Source: https://host-tools.readme.io/reference/reviews

This Python script uses the `requests` library to make a GET request to the Host Tools API for retrieving reviews. It requires the `listingID` and an `authToken`. The response will be a dictionary containing the reviews, provided the listing has an Airbnb channel connected.

```python
import requests

def get_reviews(listing_id, auth_token):
    url = f"https://app.hosttools.com/api/getReviews/{listing_id}"
    headers = {
        'Authorization': f'Bearer {auth_token}',
        'accept': 'application/json'
    }
    
    try:
        response = requests.get(url, headers=headers)
        response.raise_for_status()  # Raise an exception for bad status codes
        return response.json()
    except requests.exceptions.RequestException as e:
        print(f"Error fetching reviews: {e}")
        return None

# Example usage:
# listing_id = 'your_listing_id'
# auth_token = 'your_auth_token'
# reviews = get_reviews(listing_id, auth_token)
# if reviews:
#     print(reviews)
```

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

### Get Pricing Quote API Request (Ruby)

Source: https://host-tools.readme.io/reference/quotes

This Ruby code snippet shows how to send a POST request to the Get Pricing Quote API using the 'net/http' library. It sets the URL, headers including API key and authentication token, and the JSON payload for guest information. Remember to substitute `listingID`, `YOUR_API_KEY`, and `YOUR_AUTH_TOKEN` with your actual values.

```ruby
require 'net/http'
require 'uri'
require 'json'

listing_id = 'YOUR_LISTING_ID' # Replace with actual listing ID
api_key = 'YOUR_API_KEY'      # Replace with your API key
auth_token = 'YOUR_AUTH_TOKEN' # Replace with your auth token

uri = URI.parse("https://app.hosttools.com/api/getQuote/#{listing_id}")

request = Net::HTTP::Post.new(uri)
request['accept'] = 'application/json'
request['content-type'] = 'application/json'
request['apiKey'] = api_key
request['authToken'] = auth_token

request.body = {
  guests: {
    children: 0,
    infants: 0,
    pets: 0
  }
}.to_json

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end

if response.is_a?(Net::HTTPSuccess)
  puts "Quote: #{JSON.parse(response.body)}"
else
  puts "Error fetching quote: #{response.code} #{response.message}"
  puts "Response body: #{response.body}"
end
```

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

### Get Reviews using Ruby

Source: https://host-tools.readme.io/reference/reviews

This Ruby code snippet illustrates how to make a GET request to the Host Tools API to retrieve reviews for a specific listing. It uses the `httparty` gem for making HTTP requests and requires the `listingID` and `authToken` for successful execution. The listing must have an Airbnb channel connected.

```ruby
require 'httparty'

def get_reviews(listing_id, auth_token)
  url = "https://app.hosttools.com/api/getReviews/#{listing_id}"
  response = HTTParty.get(url, headers: { 'Authorization' => "Bearer #{auth_token}", 'accept' => 'application/json' })
  
  if response.success?
    response.parsed_response
  else
    puts "Error fetching reviews: #{response.code} - #{response.body}"
    nil
  end
end

# Example usage:
# listing_id = 'your_listing_id'
# auth_token = 'your_auth_token'
# reviews = get_reviews(listing_id, auth_token)
# puts reviews if reviews
```

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

### Get Pricing Quote API Request (PHP)

Source: https://host-tools.readme.io/reference/quotes

This PHP code demonstrates how to make a POST request to the Get Pricing Quote API using cURL. It sets the URL, required headers like 'accept', 'content-type', 'apiKey', and 'authToken', and sends a JSON payload containing guest details. Replace the placeholder values for `listingID`, `YOUR_API_KEY`, and `YOUR_AUTH_TOKEN`.

```php
<?php

$listingID = 'YOUR_LISTING_ID'; // Replace with actual listing ID
$apiKey = 'YOUR_API_KEY';      // Replace with your API key
$authToken = 'YOUR_AUTH_TOKEN'; // Replace with your auth token

$url = "https://app.hosttools.com/api/getQuote/{$listingID}";

$data = [
    'guests' => [
        'children' => 0,
        'infants' => 0,
        'pets' => 0
    ]
];

$payload = json_encode($data);

$headers = [
    'accept: application/json',
    'content-type: application/json',
    'apiKey: ' . $apiKey,
    'authToken: ' . $authToken
];

$ch = curl_init($url);

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Error fetching quote: ' . curl_error($ch);
} else {
    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    if ($httpCode >= 200 && $httpCode < 300) {
        echo 'Quote: ' . $response;
    } else {
        echo "Error fetching quote: HTTP Code {$httpCode}";
        echo "\nResponse: " . $response;
    }
}

curl_close($ch);

?>
```

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

### Authenticate API requests with Auth Token

Source: https://host-tools.readme.io/reference/intro

Demonstrates how to include the required Auth Token in the request header for standard API calls. This is mandatory for accessing account-specific data.

```bash
curl --request GET \
     --url https://app.hosttools.com/api/... \
     --header 'accept: application/json' \
     --header 'authToken: {{USERS_AUTH_TOKEN}}'
```

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

### Get User API Request (Ruby)

Source: https://host-tools.readme.io/reference/user-1

This Ruby snippet illustrates how to retrieve user data from the 'Get User' endpoint. It uses the built-in 'Net::HTTP' library to perform the GET request, passing the API key and authentication token in the request headers.

```ruby
require 'net/http'
require 'uri'

uri = URI.parse('https://app.hosttools.com/api/getUser')

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri.request_uri)
request['apiKey'] = 'YOUR_API_KEY'
request['authToken'] = 'YOUR_AUTH_TOKEN'
request['accept'] = 'application/json'

response = http.request(request)

puts "Status: #{response.code}"
puts "Body: #{response.body}"
```

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

### Get User API Request (PHP)

Source: https://host-tools.readme.io/reference/user-1

This PHP snippet demonstrates how to fetch user information using the 'Get User' endpoint. It uses cURL to send the HTTP GET request and includes the necessary headers for authentication and content type.

```php
<?php

$apiKey = 'YOUR_API_KEY';
$authToken = 'YOUR_AUTH_TOKEN';
$url = 'https://app.hosttools.com/api/getUser';

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');

$headers = array();
$headers[] = 'ApiKey: ' . $apiKey;
$headers[] = 'AuthToken: ' . $authToken;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
} else {
    echo $response;
}

curl_close($ch);
?>
```

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

### Get Calendar

Source: https://host-tools.readme.io/reference/calendar-1

Retrieves pricing information for a specific listing within a given date range.

```APIDOC
## GET /api/getCalendar/{listingID}/{startDate}/{endDate}

### Description
Returns pricing of a listing based on a single id for a specified date range.

### Method
GET

### Endpoint
https://app.hosttools.com/api/getCalendar/{listingID}/{startDate}/{endDate}

### Parameters
#### Path Parameters
- **listingID** (string) - Required - _id of listing to fetch
- **startDate** (string) - Required - Start date to fetch
- **endDate** (string) - Required - End date to fetch

#### Header Parameters
- **apiKey** (string) - Optional - Partner API key
- **authToken** (string) - Required - User's authentication token

### Request Example
```bash
curl --request GET \
     --url 'https://app.hosttools.com/api/getCalendar/listingID/startDate/endDate' \
     --header 'accept: application/json' \
     --header 'apiKey: YOUR_API_KEY' \
     --header 'authToken: YOUR_AUTH_TOKEN'
```

### Response
#### Success Response (200)
- **Price response** (object) - Contains pricing details for the specified listing and date range.

#### Error Response (400)
- **Error** (object) - Indicates an error occurred during the request.

#### Rate Limit Response (429)
- **Too many requests** (object) - Indicates that the rate limit has been exceeded.
```

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

### Get Pricing Quote API Request (cURL)

Source: https://host-tools.readme.io/reference/quotes

This cURL request demonstrates how to call the Get Pricing Quote API. It includes the endpoint URL, required headers such as 'accept' and 'content-type', and a JSON payload for guest details. The `listingID` in the URL should be replaced with the actual listing ID.

```shell
curl --request POST \
     --url https://app.hosttools.com/api/getQuote/listingID \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
  "guests": {
    "children": 0,
    "infants": 0,
    "pets": 0
  }
}'
```

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

### Get Reviews using cURL

Source: https://host-tools.readme.io/reference/reviews

This snippet demonstrates how to fetch reviews for a specific listing using a cURL request. It requires the listing ID and an API key for authentication. The endpoint only returns reviews if an Airbnb channel is connected to the listing.

```shell
curl --request GET \
     --url https://app.hosttools.com/api/getReviews/listingID \
     --header 'accept: application/json'
```

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

### Create Reservation API Request

Source: https://host-tools.readme.io/reference/reservations-1

A cURL request example demonstrating how to send a POST request to the Host Tools API to create a new reservation. It includes the necessary headers for JSON content and the structure of the guests object within the request body.

```shell
curl --request POST \
     --url https://app.hosttools.com/api/createReservation \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
  "guests": {
    "children": 0,
    "infants": 0,
    "pets": 0
  },
  "status": "accepted"
}'
```

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

### Get User API Request (Node.js)

Source: https://host-tools.readme.io/reference/user-1

This Node.js snippet shows how to fetch user information using the 'Get User' endpoint. It utilizes the 'node-fetch' library to make the HTTP GET request and includes the required API key and authentication token in the headers.

```javascript
const fetch = require('node-fetch');

const apiKey = 'YOUR_API_KEY';
const authToken = 'YOUR_AUTH_TOKEN';

fetch('https://app.hosttools.com/api/getUser', {
  method: 'GET',
  headers: {
    'apiKey': apiKey,
    'authToken': authToken,
    'accept': 'application/json'
  }
})
  .then(response => {
    if (!response.ok) {
      throw new Error(`HTTP error! status: ${response.status}`);
    }
    return response.json();
  })
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));
```

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

### GET /listings

Source: https://host-tools.readme.io/reference/get_api-getlistings

Retrieve a list of active properties for the authenticated user, optionally filtered by availability dates.

```APIDOC
## GET /listings

### Description
Returns all active listings for the authenticated user. Includes property details, location, and settings. Supports optional date range filtering.

### Method
GET

### Endpoint
/listings

### Parameters
#### Query Parameters
- **startDate** (string) - Optional - The start date for availability filtering (YYYY-MM-DD).
- **endDate** (string) - Optional - The end date for availability filtering (YYYY-MM-DD).

### Request Example
GET /listings?startDate=2023-10-01&endDate=2023-10-07

### Response
#### Success Response (200)
- **listings** (array) - List of property objects.
- **id** (string) - Unique identifier for the listing.
- **name** (string) - Name of the property.

#### Response Example
{
  "listings": [
    {
      "id": "prop_123",
      "name": "Beachfront Villa"
    }
  ]
}
```

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

### GET /api/getReservations/{listingID}/{startDate}/{endDate}

Source: https://host-tools.readme.io/reference/get_api-getreservations-listingid-startdate-enddate

Retrieves a list of reservations for a specific property listing within a defined date range.

```APIDOC
## GET /api/getReservations/{listingID}/{startDate}/{endDate}

### Description
Gets reservations of a listing for a specified date range. Requires authentication via an authToken header.

### Method
GET

### Endpoint
https://app.hosttools.com/api/getReservations/{listingID}/{startDate}/{endDate}

### Parameters
#### Path Parameters
- **listingID** (string) - Required - _id of listing to fetch
- **startDate** (string) - Required - Start date of range (YYYY-MM-DD)
- **endDate** (string) - Required - End date of range (YYYY-MM-DD)

#### Header Parameters
- **authToken** (string) - Required - User's authentication token
- **apiKey** (string) - Optional - Partner API key

### Request Example
GET /api/getReservations/5e1f9b9b9b9b9b9b9b9b9b9b9/2020-01-01/2021-01-01

### Response
#### Success Response (200)
- **reservations** (array) - List of reservation objects
- **userID** (string) - User ID

#### Response Example
{
  "reservations": [],
  "userID": "user_12345"
}
```

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

### GET /api/getCalendar/{listingID}/{startDate}/{endDate}

Source: https://host-tools.readme.io/reference/get_api-getcalendar-listingid-startdate-enddate

Retrieves the pricing and availability calendar for a specific listing within a given date range. Requires authentication via an API key and user token.

```APIDOC
## GET /api/getCalendar/{listingID}/{startDate}/{endDate}

### Description
Returns pricing and availability of a listing based on its ID for a specified date range.

### Method
GET

### Endpoint
`/api/getCalendar/{listingID}/{startDate}/{endDate}`

### Parameters
#### Path Parameters
- **listingID** (string) - Required - The unique identifier of the listing.
- **startDate** (string) - Required - The start date for the calendar query (YYYY-MM-DD format).
- **endDate** (string) - Required - The end date for the calendar query (YYYY-MM-DD format).

#### Query Parameters
None

#### Header Parameters
- **apiKey** (string) - Optional - Partner API key for authentication.
- **authToken** (string) - Required - User's authentication token.

### Request Example
```
GET https://app.hosttools.com/api/getCalendar/5e1f9b9b9b9b9b9b9b9b9b9b9/2020-01-01/2021-01-01
Host: app.hosttools.com
apiKey: YOUR_API_KEY
authToken: YOUR_AUTH_TOKEN
```

### Response
#### Success Response (200)
- **userID** (string) - The ID of the user associated with the listing.
- **listingID** (string) - The ID of the listing.
- **currency** (string) - The currency of the pricing information (ISO format).
- **prices** (object) - An array of price objects for each day.
  - **date** (string) - The date in YYYY-MM-DD format.
  - **blocked** (boolean) - Indicates if the date is blocked.
  - **Airbnb** (object) - Pricing and booking details for Airbnb.
    - **price** (number) - The price set on Airbnb.
    - **minNights** (number) - Minimum nights required for booking on Airbnb.
    - **blockCheckin** (boolean) - Whether check-in is blocked on Airbnb.
    - **blockCheckout** (boolean) - Whether check-out is blocked on Airbnb.
  - **HomeAway** (object) - Pricing and booking details for HomeAway.

#### Response Example (200 OK)
```json
{
  "userID": "5e7a6c0b0f2c9c0017b0b0b0",
  "listingID": "5e7a6c0b0f2c9c0017b0b0b1",
  "currency": "USD",
  "prices": [
    {
      "date": "2020-03-20T00:00:00.000Z",
      "blocked": false,
      "Airbnb": {
        "price": 100,
        "minNights": 2,
        "blockCheckin": true,
        "blockCheckout": true
      },
      "HomeAway": {
        "price": 110,
        "minNights": 1,
        "blockCheckin": false,
        "blockCheckout": false
      }
    }
  ]
}
```

#### Error Response (400 Bad Request)
- **message** (string) - A description of the error.

#### Error Response Example (400 Bad Request)
```json
{
  "message": "Invalid listing ID provided."
}
```

#### Error Response (429 Too Many Requests)
Indicates that the rate limit has been exceeded.
```

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

### Get Reviews

Source: https://host-tools.readme.io/reference/get_api-getreviews-listingid

Retrieves reviews for a specific listing. This endpoint only returns reviews if the listing has an Airbnb channel connected.

```APIDOC
## GET /api/getReviews/{listingID}

### Description
Returns reviews for a specific listing. Only returns reviews if the listing has an Airbnb channel connected.

### Method
GET

### Endpoint
/api/getReviews/{listingID}

### Parameters
#### Path Parameters
- **listingID** (string) - Required - _id of listing to fetch reviews for

#### Query Parameters
None

#### Header Parameters
- **apiKey** (string) - Optional - Partner API key
- **authToken** (string) - Required - User's authentication token

### Request Example
```json
{
  "listingID": "5e1f9b9b9b9b9b9b9b9b9b9b9"
}
```

### Response
#### Success Response (200)
- **count** (number) - Total number of reviews available
- **reviews** (array) - Array of review objects
- **listingID** (string) - ID of the listing these reviews belong to

#### Response Example
```json
{
  "count": 42,
  "reviews": [
    {
      "comments": "Amazing stay! The host was very responsive and the place was exactly as described.",
      "rating": 5,
      "createdAt": "2024-01-15T10:30:00.000Z",
      "name": "Sarah M.",
      "profilePicture": "https://example.com/profile.jpg"
    }
  ],
  "listingID": "5e1f9b9b9b9b9b9b9b9b9b9b9"
}
```

#### Error Response (400)
- **message** (string) - Error message

#### Error Response (429)
- Too many requests
```

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

### Get Pricing Quote API Request (Python)

Source: https://host-tools.readme.io/reference/quotes

This Python script utilizes the 'requests' library to call the Get Pricing Quote API. It defines the endpoint, headers including API key and authentication token, and the JSON payload for guest details. Ensure you replace placeholders like `listingID`, `YOUR_API_KEY`, and `YOUR_AUTH_TOKEN`.

```python
import requests
import json

listing_id = 'YOUR_LISTING_ID'  # Replace with actual listing ID
api_key = 'YOUR_API_KEY'  # Replace with your API key
auth_token = 'YOUR_AUTH_TOKEN'  # Replace with your auth token

url = f"https://app.hosttools.com/api/getQuote/{listing_id}"

headers = {
    'accept': 'application/json',
    'content-type': 'application/json',
    'apiKey': api_key,
    'authToken': auth_token
}

payload = {
    "guests": {
        "children": 0,
        "infants": 0,
        "pets": 0
    }
}

try:
    response = requests.post(url, headers=headers, data=json.dumps(payload))
    response.raise_for_status()  # Raise an exception for bad status codes
    print("Quote:", response.json())
except requests.exceptions.RequestException as e:
    print(f"Error fetching quote: {e}")
    if hasattr(e, 'response') and e.response is not None:
        print(f"Response data: {e.response.text}")
```

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

### Authenticate API requests with API Key

Source: https://host-tools.readme.io/reference/intro

Shows the request structure for partners using an API Key. This method requires both the API Key and the user's Auth Token in the headers to access data with higher rate limits.

```bash
curl --request GET \
     --url https://app.hosttools.com/api/... \
     --header 'accept: application/json' \
     --header 'apiKey: {{API_KEY}}' \
     --header 'authToken: {{USERS_AUTH_TOKEN}}'
```

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

### Get Reviews using PHP

Source: https://host-tools.readme.io/reference/reviews

This PHP function fetches reviews for a given listing ID using cURL. It sets the necessary headers, including the authentication token. The function returns the JSON response or an error message if the request fails. Ensure the listing has an Airbnb channel connected.

```php
<?php

function getReviews($listingID, $authToken) {
    $url = "https://app.hosttools.com/api/getReviews/{$listingID}";
    
    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_HTTPHEADER, array(
        'Authorization: Bearer ' . $authToken,
        'accept: application/json'
    ));
    
    $response = curl_exec($ch);
    
    if (curl_errno($ch)) {
        echo 'Curl error: ' . curl_error($ch);
        curl_close($ch);
        return false;
    }
    
    curl_close($ch);
    return json_decode($response, true);
}

// Example usage:
// $listingId = 'your_listing_id';
// $userAuthToken = 'your_auth_token';
// $reviews = getReviews($listingId, $userAuthToken);
// if ($reviews) {
//     print_r($reviews);
// }

?>
```

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

### GET /reservations/{id}

Source: https://host-tools.readme.io/reference/get_api-getreservations-listingid-startdate-enddate

Retrieves the detailed information for a specific reservation, including verification status, incident URLs, and financial rate components.

```APIDOC
## GET /reservations/{id}

### Description
Retrieves the full details of a reservation, including guidebook links, verification status, and a breakdown of all financial components like fees and taxes.

### Method
GET

### Endpoint
/reservations/{id}

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

### Request Example
GET /reservations/69a20bf39617fcbd7366b29c

### Response
#### Success Response (200)
- **guideBookURL** (string) - URL of the guidebook
- **verificationURL** (string) - URL of the verification
- **verificationStatus** (string) - Status of the verification (signed, approved)
- **incidentURL** (string) - URL of the incident
- **rates** (array) - Breakdown of fees, taxes, and pricing components
- **posts** (array) - Reservation posts/messages

#### Response Example
{
  "guideBookURL": "https://example.com/guidebook",
  "verificationURL": "https://example.com/verification",
  "verificationStatus": "signed",
  "incidentURL": "https://example.com/incident",
  "rates": [
    {
      "type": "fee",
      "amount": 25,
      "name": "Cleaning fee",
      "paidToHost": true,
      "paidBy": "guest"
    }
  ],
  "posts": []
}
```

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

### GET /api/getListings

Source: https://host-tools.readme.io/reference/get_api-getlistings

Retrieves a list of all active listings for the authenticated user, with optional date-based availability filtering.

```APIDOC
## GET /api/getListings

### Description
Returns all active listings for the authenticated user. Each listing includes property details, location information, and current settings. If both startDate and endDate query parameters are provided, the endpoint will filter listings to only return those that are available for the specified date range.

### Method
GET

### Endpoint
https://app.hosttools.com/api/getListings

### Parameters
#### Header Parameters
- **apiKey** (string) - Optional - Partner API key
- **authToken** (string) - Required - User's authentication token

#### Query Parameters
- **startDate** (string) - Optional - Check-in date for availability filtering (YYYY-MM-DD format). Must be used with endDate.
- **endDate** (string) - Optional - Check-out date for availability filtering (YYYY-MM-DD format). Must be used with startDate.

### Request Example
GET /api/getListings?startDate=2024-03-20&endDate=2024-03-25

### Response
#### Success Response (200)
- **listings** (array) - List of property objects
- **userID** (string) - The unique identifier for the user

#### Response Example
{
  "listings": [],
  "userID": "user_12345"
}
```

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

### Retrieve Listing Details via cURL

Source: https://host-tools.readme.io/reference/listings-1

Fetches detailed information for a specific listing by its ID. Requires the listingID path parameter and authentication headers.

```Shell
curl --request GET \
     --url https://app.hosttools.com/api/getListing/listingID \
     --header 'accept: application/json' \
     --header 'apiKey: YOUR_API_KEY' \
     --header 'authToken: YOUR_AUTH_TOKEN'
```

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

### GET /api/getReviews/{listingID}

Source: https://host-tools.readme.io/reference/reviews

Retrieves reviews for a specific listing. This endpoint only returns reviews if the listing has an Airbnb channel connected.

```APIDOC
## GET /api/getReviews/{listingID}

### Description
Returns reviews for a specific listing. Only returns reviews if the listing has an Airbnb channel connected.

### Method
GET

### Endpoint
https://app.hosttools.com/api/getReviews/{listingID}

### Parameters
#### Path Parameters
- **listingID** (string) - required - _id of listing to fetch reviews for

#### Headers
- **apiKey** (string) - optional - Partner API key
- **authToken** (string) - required - User's authentication token

### Request Example
```json
{
  "example": "curl --request GET \
     --url https://app.hosttools.com/api/getReviews/listingID \
     --header 'accept: application/json' \
     --header 'authorization: Bearer YOUR_AUTH_TOKEN'"
}
```

### Response
#### Success Response (200)
- **Reviews response** (object) - The response containing reviews for the listing.

#### Error Response (400)
- **Error** (object) - Details about the error.

#### Error Response (429)
- **Too many requests** (object) - Indicates that the rate limit has been exceeded.

#### Response Example
```json
{
  "example": "{\"reviews\": [{\"id\": \"review123\", \"rating\": 5, \"comment\": \"Great stay!\"}]}"
}
```
```

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

### Define Get Reviews Endpoint in OpenAPI

Source: https://host-tools.readme.io/reference/get_api-getreviews-listingid

This snippet defines the /api/getReviews/{listingID} endpoint within an OpenAPI 3.0.0 specification. It requires authentication via headers and returns a structured list of reviews for listings connected to an Airbnb channel.

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.5.0",
    "title": "Host Tools API Reference"
  },
  "paths": {
    "/api/getReviews/{listingID}": {
      "get": {
        "summary": "Get Reviews",
        "parameters": [
          { "name": "apiKey", "in": "header", "required": false, "schema": { "type": "string" } },
          { "name": "authToken", "in": "header", "required": true, "schema": { "type": "string" } },
          { "name": "listingID", "in": "path", "required": true, "schema": { "type": "string" } }
        ],
        "responses": {
          "200": { "description": "Reviews response" },
          "400": { "description": "Error" },
          "429": { "description": "Too many requests" }
        }
      }
    }
  }
}
```

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

### POST /api/getQuote/{listingID}

Source: https://host-tools.readme.io/reference/quotes

Calculates a pricing quote for a potential reservation. This includes availability checking, base pricing, fees, taxes, and a total cost breakdown with detailed line items.

```APIDOC
## POST /api/getQuote/{listingID}

### Description
Calculates a pricing quote for a potential reservation including availability checking, base pricing, fees, taxes, and total cost breakdown with detailed line items.

### Method
POST

### Endpoint
https://app.hosttools.com/api/getQuote/{listingID}

### Parameters
#### Path Parameters
- **listingID** (string) - Required - _id of listing to get quote for

#### Query Parameters
None

#### Headers
- **apiKey** (string) - Optional - Partner API key
- **authToken** (string) - Required - User's authentication token

#### Request Body
- **startDate** (string) - Required - Check-in date in YYYY-MM-DD format
- **endDate** (string) - Required - Check-out date in YYYY-MM-DD format
- **guests** (object) - Required - Number of guests
  - **children** (integer) - Optional - Number of children
  - **infants** (integer) - Optional - Number of infants
  - **pets** (integer) - Optional - Number of pets

### Request Example
```json
{
  "startDate": "2024-01-01",
  "endDate": "2024-01-05",
  "guests": {
    "children": 1,
    "infants": 0,
    "pets": 0
  }
}
```

### Response
#### Success Response (200)
- **quote** (object) - Quote response details
  - **basePrice** (number) - Base price for the stay
  - **fees** (number) - Total fees
  - **taxes** (number) - Total taxes
  - **totalCost** (number) - Total cost of the reservation
  - **lineItems** (array) - Detailed breakdown of costs
    - **item** (string) - Description of the cost item
    - **amount** (number) - Amount for the cost item

#### Error Response (400)
- **error** (string) - Error message

#### Unavailable Dates Response (409)
- **unavailableDates** (array) - Array of dates that are unavailable
- **quote** (object) - Quote data for available dates within the requested range

#### Rate Limit Response (429)
- **error** (string) - Error message indicating rate limit exceeded

#### Response Example (200)
```json
{
  "quote": {
    "basePrice": 500.00,
    "fees": 50.00,
    "taxes": 25.00,
    "totalCost": 575.00,
    "lineItems": [
      {
        "item": "Nightly Rate",
        "amount": 400.00
      },
      {
        "item": "Cleaning Fee",
        "amount": 50.00
      },
      {
        "item": "Service Fee",
        "amount": 50.00
      },
      {
        "item": "Occupancy Tax",
        "amount": 25.00
      }
    ]
  }
}
```
```

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

### POST /reservations

Source: https://host-tools.readme.io/reference/post_api-createreservation

Creates a new reservation record with guest details, status, and financial information.

```APIDOC
## POST /reservations

### Description
Creates a new reservation entry including guest details, pricing, and scheduling preferences.

### Method
POST

### Endpoint
/reservations

### Parameters
#### Request Body
- **infants** (number) - Optional - Number of infant guests (min: 0, default: 0)
- **pets** (number) - Optional - Number of pets (min: 0, default: 0)
- **status** (string) - Optional - Initial status of the reservation (inquiry, pending, accepted; default: accepted)
- **notes** (string) - Optional - Internal notes for the reservation
- **checkInTime** (number) - Optional - Custom check-in time (0-23 hours)
- **checkOutTime** (number) - Optional - Custom check-out time (0-23 hours)
- **preferredLocale** (string) - Optional - Guest's preferred language locale
- **hostPayout** (number) - Optional - Amount to be paid to host
- **guestPrice** (number) - Optional - Total amount paid by guest

### Request Example
{
  "infants": 0,
  "pets": 0,
  "status": "accepted",
  "notes": "Guest celebrating anniversary",
  "checkInTime": 15,
  "checkOutTime": 11,
  "preferredLocale": "en",
  "hostPayout": 450,
  "guestPrice": 500
}

### Response
#### Success Response (200)
- **message** (string) - Success confirmation

#### Response Example
{
  "message": "Reservation created successfully"
}
```

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

### Get User API Request (cURL)

Source: https://host-tools.readme.io/reference/user-1

This snippet demonstrates how to make a GET request to the 'Get User' endpoint using cURL. It includes the URL and necessary headers for authentication and content type.

```shell
curl --request GET \
     --url https://app.hosttools.com/api/getUser \
     --header 'accept: application/json'
```

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

### Get User API Request (Python)

Source: https://host-tools.readme.io/reference/user-1

This Python snippet shows how to retrieve user data from the 'Get User' endpoint. It uses the 'requests' library to make the HTTP GET request, including the API key and authentication token in the request headers.

```python
import requests

api_key = 'YOUR_API_KEY'
auth_token = 'YOUR_AUTH_TOKEN'
url = 'https://app.hosttools.com/api/getUser'

headers = {
    'apiKey': api_key,
    'authToken': auth_token,
    'accept': 'application/json'
}

response = requests.get(url, headers=headers)

if response.status_code == 200:
    print(response.json())
else:
    print(f"Error: {response.status_code}")
    print(response.text)
```

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

### GET /api/getListing/{listingID}

Source: https://host-tools.readme.io/reference/listings-1

Retrieves detailed information for a specific property listing using its unique identifier.

```APIDOC
## GET /api/getListing/{listingID}

### Description
Returns detailed information for a specific listing including property details, amenities, policies, and current configuration settings.

### Method
GET

### Endpoint
https://app.hosttools.com/api/getListing/{listingID}

### Parameters
#### Path Parameters
- **listingID** (string) - Required - The unique ID of the listing to fetch.

#### Headers
- **apiKey** (string) - Optional - Partner API key.
- **authToken** (string) - Required - User's authentication token.

### Request Example
```bash
curl --request GET \
     --url https://app.hosttools.com/api/getListing/listingID \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
- **Listing** (object) - Detailed listing information object.

#### Error Responses
- **400** (Bad Request) - Invalid request parameters.
- **429** (Too Many Requests) - Rate limit exceeded.
```

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

### POST /api/getQuote/{listingID}

Source: https://host-tools.readme.io/reference/post_api-getquote-listingid

Calculates a pricing quote for a potential reservation including availability checking, base pricing, fees, taxes, and total cost breakdown.

```APIDOC
## POST /api/getQuote/{listingID}

### Description
Calculates a pricing quote for a potential reservation including availability checking, base pricing, fees, taxes, and total cost breakdown with detailed line items.

### Method
POST

### Endpoint
https://app.hosttools.com/api/getQuote/{listingID}

### Parameters
#### Path Parameters
- **listingID** (string) - Required - _id of listing to get quote for

#### Request Headers
- **apiKey** (string) - Optional - Partner API key
- **authToken** (string) - Required - User's authentication token

#### Request Body
- **startDate** (string) - Required - Check-in date (YYYY-MM-DD)
- **endDate** (string) - Required - Check-out date (YYYY-MM-DD)
- **guests** (object) - Required - Object containing adults, children, infants, and pets counts

### Request Example
{
  "startDate": "2024-03-20",
  "endDate": "2024-03-25",
  "guests": {
    "adults": 2,
    "children": 0,
    "infants": 0,
    "pets": 0
  }
}

### Response
#### Success Response (200)
- **listingID** (string) - ID of the listing
- **currency** (string) - Currency code in ISO format
- **reservation** (object) - Reservation details including dates and guest counts
- **basePrice** (number) - The base price for the stay
- **total** (number) - Total cost of the reservation
- **lineItems** (array) - Detailed breakdown of fees and taxes

#### Response Example
{
  "listingID": "5e1f9b9b9b9b9b9b9b9b9b9b9",
  "currency": "USD",
  "reservation": {
    "startDate": "2024-03-20",
    "endDate": "2024-03-25",
    "nights": 5,
    "guests": { "adults": 2, "children": 0, "infants": 0, "pets": 0 }
  },
  "basePrice": 500.00,
  "total": 550.00,
  "lineItems": []
}
```

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

### Get User API

Source: https://host-tools.readme.io/reference/user-1

Retrieves the basic information of the currently authenticated user, including their userID, email, first name, and last name.

```APIDOC
## GET /api/getUser

### Description
Returns the current authenticated user's basic information including userID, email, first name, and last name.

### Method
GET

### Endpoint
https://app.hosttools.com/api/getUser

### Parameters
#### Headers
- **apiKey** (string) - Optional - Partner API key
- **authToken** (string) - Required - User's authentication token

### Request Example
```json
{
  "example": "Not applicable for GET request body"
}
```

### Response
#### Success Response (200)
- **userID** (string) - The unique identifier for the user.
- **email** (string) - The user's email address.
- **firstName** (string) - The user's first name.
- **lastName** (string) - The user's last name.

#### Response Example
```json
{
  "userID": "123e4567-e89b-12d3-a456-426614174000",
  "email": "user@example.com",
  "firstName": "John",
  "lastName": "Doe"
}
```

#### Error Responses
- **400** - Bad Request
- **429** - Too Many Requests
```

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

### Reservation API

Source: https://host-tools.readme.io/reference/changelog

Programmatically creates internal reservations with complete guest details, pricing information, and status management.

```APIDOC
## POST /api/createReservation

### Description
Programmatically creates internal reservations. Requires full guest details, pricing information, and status management.

### Method
POST

### Endpoint
/api/createReservation

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **reservationDetails** (object) - Required - Contains all details for creating the reservation. (See `CreateReservation` schema for full details)
  - **listingID** (string) - Required.
  - **guestDetails** (object) - Required.
  - **pricing** (object) - Required.
  - **status** (string) - Required.

### Request Example
```json
{
  "reservationDetails": {
    "listingID": "listing456",
    "guestDetails": {
      "firstName": "Alice",
      "lastName": "Smith",
      "email": "alice.smith@example.com",
      "phone": "123-456-7890"
    },
    "pricing": {
      "totalPrice": 875,
      "currency": "USD"
    },
    "status": "confirmed"
  }
}
```

### Response
#### Success Response (200 or 201)
- **reservationID** (string) - The unique identifier for the created reservation.
- **status** (string) - The status of the created reservation.

#### Response Example
```json
{
  "reservationID": "res789",
  "status": "confirmed"
}
```
```

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

### POST /api/setListing/{listingID}

Source: https://host-tools.readme.io/reference/changelog

Updates listing details such as the upsell URL for promotional guest messaging.

```APIDOC
## POST /api/setListing/{listingID}

### Description
Updates listing attributes like the upsell URL.

### Method
POST

### Endpoint
/api/setListing/{listingID}

### Request Body
- **upsellURL** (string) - Optional - Promotional link for guests.
```

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

### GET /api/getWebhook

Source: https://host-tools.readme.io/reference/get_api-getwebhook

Retrieves the configured webhook URL for the authenticated user.

```APIDOC
## GET /api/getWebhook

### Description
Returns the webhook url that is set for the user's apiKey.

### Method
GET

### Endpoint
https://app.hosttools.com/api/getWebhook

### Parameters
#### Header Parameters
- **apiKey** (string) - Optional - Partner API key
- **authToken** (string) - Required - User's authentication token

### Request Example
GET /api/getWebhook
Headers: {
	"authToken": "your_auth_token"
}

### Response
#### Success Response (200)
- **url** (string) - The webhook URL or null if not set

#### Response Example
{
	"url": "https://example.com/webhook"
}
```

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

### GET /api/getReservation/{reservationID}

Source: https://host-tools.readme.io/reference/get_api-getreservation-reservationid

Retrieves the details of a specific reservation using its unique identifier.

```APIDOC
## GET /api/getReservation/{reservationID}

### Description
Gets a single reservation by ID. This endpoint requires authentication via an auth token.

### Method
GET

### Endpoint
https://app.hosttools.com/api/getReservation/{reservationID}

### Parameters
#### Path Parameters
- **reservationID** (string) - Required - _id of reservation to fetch

#### Header Parameters
- **apiKey** (string) - Optional - Partner API key
- **authToken** (string) - Required - User's authentication token

### Request Example
GET /api/getReservation/5e1f9b9b9b9b9b9b9b9b9b9b

### Response
#### Success Response (200)
- **_id** (string) - Reservation ID
- **userID** (string) - User ID for this reservation
- **startDate** (string) - Start date in UTC
- **endDate** (string) - End date in UTC

#### Response Example
{
  "_id": "5e7a6c0b0f2c9c0017b0b0b0",
  "userID": "5e7a6c0b0f2c9c0017b0b0b0",
  "startDate": "2022-05-20T00:00:00.000Z",
  "endDate": "2022-05-20T00:00:00.000Z"
}
```
Tokens:
Raw