Build Away with the

HomeAway Developer API

With access to listing information and owners and traveler accounts this is truly a whole API.


Get started

Build with HomeAway


Listing Info
Access to over a million vacation rental listings
User Accounts
HomeAway users can grant your app access to their info
Messaging
Communicate through our secure notification system
Scale
100+ integration partners, 100+ business development partners


HomeAway Developer API

The HomeAway API is RESTful web service that was designed to be easy to use. The base URI to access all resources is https://ws.homeaway.com/public and all responses are returned as JSON. This API supports internationalization wherein the client can pass the Locale requested via the standard HTTP header or as an optional parameter 'locale'. The remainder of this page provides documentation for the available APIs and how to access them.

Getting Started

In order to begin utilizing the developer API, you need to have the following information available to you and complete the following steps:

Access Policy

Every account will start in the Test Mode Tier which includes strict rate limits (1 TPS), and user-based tokens are limited to the owner of the application. These permissions should enable you enough functionality to build a functional proof of concept.

Once your app is functional and ready for review, please submit a review request using the Product Review Request Form. During the review, we will discuss the app functionality, marketing plans, and any additional business development requirements. After the review process is complete, we will increase the rate limits and remove the Test Mode restrictions.

Test Mode Tier

All new clients begin in the Test Mode Tier. This tier has a 1 TPS rate limit, and only allows user-based tokens that are linked to the owner of the application.

An important part of any code development is being able to test your code before you are ready to release it into the world. Since some of our APIs require a user to possess an owner account with HomeAway, you will need one as well in order to properly test your application's functionality. In order to help developers without an owner account on hand, we have created a fake listing with rates, availability, conversations, and reservations linked to each developer's account that can be used while building a proof of concept application. This listing is not live on the HomeAway website, but you can interact with it through the API the same way you would use a real listing.

In order to use this fake data, use the 3-legged OAuth flow and log in as yourself. The authorization page should give you the option to log in as a traveler or an owner. Unless you have a real owner account on HomeAway, you must login as a traveler. Once the handshake is completed,the token you recieve is the token you should use when making a test mode request.

Concepts

Conversations

A converstaion is a collection of messages between users that are grouped together to form a single conversation thread.

Listings

A Listing is an advertisement for a vacation rental. The listing contains details of the rental property that are presented to travelers such as the physical location and attributes of the property.

Unit

A Unit describes a single rentable unit of a vacation rental property

Reviews

A traveler's description of their experience staying at a HomeAway property.

Locales

Some of the APIs give you the option of specifying a locale on the request, so the data returned will be in the language of your choice. There are 3 ways to specify locale on an API request:

  • 'locale' query parameter

  • 'X-HomeAway-DisplayLocale' header

  • 'Accept-Language' header

The 'locale' query parameter has the highest precedence, followed by the 'X-HomeAway-DisplayLocale' header, and then the 'Accept-Language' header. E.g. If you specify ?locale='fr_FR' and X-HomeAway-DisplayLocale: 'en_US', then the API will choose 'fr_FR' as the request locale and send back French text.

Requesting a token

In order to begin utilizing the platform APIs, your application must be authenticated and authorized to access domain resources. The platform utilizes the following protocols for authentication and authorization:

All API calls require authentication, those that require 3-legged OAuth are indicated in their documentation.

To authenticate, your client will need to send a request to the OAuth server. Send this request by making a POST to

https://ws.homeaway.com/oauth/token

with a standard Basic Auth header, where the username is your client id and the password is your client secret. If you are building this header manually, it should look something like this:

Authorization: Basic NTVhODQ4NjItZmE0ZS0xMWU0LWEzMjItMTY5N2Y5MjVlYzdiOjg1MzBmNDZjLWZhNGUtMTFlNC1hMzIyLTE2OTdmOTI1ZWM3Yg==

where the credentials are a base-64 encoded string of your client's id and secret: '<clientId>:<clientSecret>'. You can retrieve your client id and secret by visiting the My Clients page.

Note: If you do not base-64 encode the client id:secret pair, the request will fail. Additionally, the client id and secret should never be hard coded into code that is provided to end users (mobile applications, etc).

If the OAuth server successfully authenticates your client based on the credentials query parameter, the response will return:

{
        "token_type":"BEARER", //auth type used in Authorization header
        "access_token":"345nlGldfgnGjdfgi56n4gn34tADFBNDFdfopbndfpbDERBN", //the token value
        "refresh_token":"Nzc1ZmRlZDEtMDMwZC00NWExLWI2YzMtNWE0MGJhMDAwZGYw", //the refresh token value
        "expires_in":86400 //seconds until this token expires
    }

For all subsequent API calls that do not require additional authentication, you must include the 'Authorization' header with the token_type ("Bearer") and the token value, e.g.

Authorization: Bearer 345nlGldfgnGjdfgi56n4gn34tADFBNDFdfopbndfpbDERBN

Providing this information in subsequent requests will allow the application to gain access to all authorized resources. If the authorization header is not provided, client requests will fail and receive a HTTP response code of 401. The authorization token will remain valid until the token expiration time has elapsed. During this time, the application will have access to authorized resources that do not require a logged in user. Once the token has expired, all subsequent API calls that utilize the token will receive a HTTP response code of 401. When receiving this status code, the application will need initiate a request to the OAuth server to obtain a new authorization token. Doing so will allow the application continued access to the platform APIs.

Requesting a User-based Token and 3-legged OAuth

The platform provides APIs that allow applications to interact with a user's HomeAway data (e.g. an owner's listings, posting a traveler review, etc.). In order to utilize these APIs your application will need to take additional steps to gain authorization. Those APIs that require this form of authorization are marked as such in their documentation. Once a token has been generated for a particular user the token will remain active until it either expires, or the user revokes client access. If the token has expired or been revoked, your application must follow these steps again to acquire a new user based token. To get this token, you will need to redirect the user into HomeAway's 3-legged OAuth flow and handle the subsequent calls to your client.

Step 1: Redirect the user

When the user makes a request to your application that will require user-specific data, redirect them to

https://ws.homeaway.com/oauth/authorize?client_id=55a84862-fa4e-11e4-a322-1697f925ec7b

with the 'client_id' query parameter set to your applications's client id. The user will then be authenticated using HomeAway's user-management system and given an option to grant your application access to their data. If the user accepts, your application will receive a request with the authentication code that the client will use in the rest of the process as outlined below.

Step 2: Handle the authorization request

In the event the user denies access to your app, all access to these APIs for that user will not be authorized. In the event the user approves access to your app, your application will receive a request to the redirect url of your client and a query parameter, 'code'.

E.g. If the client's redirect url is "https://example.com/auth", then the client server should be able to handle a request to "https://example.com/auth?code=..." The value of this parameter is what you will use in your request to the OAuth server in order to verify that a user has logged in to use the client.

NOTE: If the client does not have a redirect url, users will instead be redirected to https://www.homeaway.com/platform/defaultRedirect where they will have to copy/paste the code value from that page into the application. For example the user will be redirected to https://www.homeaway.com/platform/defaultRedirect?code=<CODE-VALUE>. This value will be text that is displayed to the user once the page loads.

You can find the client's redirect url by visiting the My Clients page.

Step 3: Send code and client creds to the OAuth server

Once a code has been obtained, the client can request a user-based token from the OAuth server. The client will need to send a POST request to

https://ws.homeaway.com/oauth/token

with both a Basic Auth header and a body indicating the value of the code you got from homeaway.

Basic Auth

Add a standard Basic Auth header (same as described in the 2-legged flow) where the username is your client id and the password is your client secret. If you are building this header manually, it should look something like this:

Authorization: Basic NTVhODQ4NjItZmE0ZS0xMWU0LWEzMjItMTY5N2Y5MjVlYzdiOjg1MzBmNDZjLWZhNGUtMTFlNC1hMzIyLTE2OTdmOTI1ZWM3Yg==

where the credentials are a base-64 encoded string of your client's id and secret: '<clientId>:<clientSecret>'. You can retrieve your client id and secret by visiting the My Clients page.

Note: If you do not base-64 encode the client id:secret pair, the request will fail. Additionally, the client id and secret should never be hard coded into code that is provided to end users (mobile applications, etc).

Request Body

The body of your request should have the Content-Type application/x-www-form-urlencoded, and should look like:

code=ST-534-aWqWz0mHwpR4fidkxZUW-cas.homeaway.com

where the 'code' param is the code value you received from HomeAway.

If the OAuth server successfully authenticates your client based on the credentials query parameter and the authentication code, the response will be:

{
        "token_type":"BEARER", //auth type used in Authorization header
        "access_token":"345nlGldfgnGjdfgi56n4gn34tADFBNDFdfopbndfpbDERBN", //the token value
        "refresh_token":"Nzc1ZmRlZDEtMDMwZC00NWExLWI2YzMtNWE0MGJhMDAwZGYw", //the refresh token value
        "expires_in":86400, //seconds until this token expires
        "email":"bob.smith@homeaway.com" //this is the email of the user that granted access
    }
    

Step 4: Include the token in 'Authorization' on all requests for that user

For all subsequent API calls that require the authenticated user, you must include the 'Authorization' header with authMethod ("Bearer") and the token value, e.g.

Authorization: Bearer 345nlGldfgnGjdfgi56n4gn34tADFBNDFdfopbndfpbDERBN

Providing this information in subsequent requests will allow the application to gain access to all authorized resources for that user. If the authorization header is not provided, client requests will fail and receive a HTTP response code of 401. The authorization token will remain valid until the token expiration time has elapsed. Once the token has expired, all subsequent API calls that utilize the token will receive a HTTP response code of 401. When receiving this status code, the application will need initiate the 3-legged OAuth handshake to the OAuth server to obtain a new authorization token. Doing so will allow the application continued access to the platform APIs.

Token Expiration and Refresh Tokens

Most of the tokens issued by the OAuth service should last around 6 months before they expire. When that happens, any requests using that token value in the Authorization header will result in a 401 from the API service. If the token has only expired, and it has not been revoked by either the resource owner (the user associated with a user-based token) or the system, you can retrieve a fresh token with the same access scopes and resource owner of the expired token using a refresh token, assuming that the client's credentials match those on the token.

All access tokens issued by the OAuth server should have a 'refresh_token' value associated with them, which is given on the token response. To refresh the token, send a POST with Content-Type: application/x-www-form-urlencoded to

https://ws.homeaway.com/oauth/token

with a Basic Auth header that encodes your client credentials and the 'refresh_token' parameter which should be equal to the refresh_token value of the access token you want to refresh.

Basic Auth

Add a standard Basic Auth header (same as described in the 2-legged flow) where the username is your client id and the password is your client secret. If you are building this header manually, it should look something like this:

Authorization: Basic NTVhODQ4NjItZmE0ZS0xMWU0LWEzMjItMTY5N2Y5MjVlYzdiOjg1MzBmNDZjLWZhNGUtMTFlNC1hMzIyLTE2OTdmOTI1ZWM3Yg==

where the credentials are a base-64 encoded string of your client's id and secret: '<clientId>:<clientSecret>'. You can retrieve your client id and secret by visiting the My Clients page.

Note: If you do not base-64 encode the client id:secret pair, the request will fail. Additionally, the client id and secret should never be hard coded into code that is provided to end users (mobile applications, etc).

Request Body

The body of your request should have the Content-Type application/x-www-form-urlencoded, and should look like:

refresh_token=Nzc1ZmRlZDEtMDMwZC00NWExLWI2YzMtNWE0MGJhMDAwZGYw

If the OAuth server matches your client with the client associated with the refresh_token value, and the corresponding access token has expired, you will get a fresh token with the same access:

{
        "token_type":"BEARER", //auth type used in Authorization header
        "access_token":"MjRiN2E5YWItYTJlOS00Mzk1LWE4MWQtMmM0NTM4NDI2NzM0", //the token value
        "refresh_token":"ODU2MjA1NzktNmZiMi00MDZhLTg4YzMtMjg5YjM3NzBkM2I5", //the refresh token value
        "expires_in":86400, //seconds until this token expires
        "email":"bob.smith@homeaway.com" //this is the email of the user that granted access
    }
    

NOTE: There are 3 main reasons why the OAuth server might refuse the refresh token request.

The token was revoked - If the user has manually revoked access or the token was revoked by the system for some reason, then the token does not qualify for a refresh

The client's access scopes no longer match the scopes on the token - If your client's access scopes have been modified, and there is an attempt to refresh an expired token that was issued before the client was updated, the OAuth server will return a 403 (Forbidden) status code to indicate that the client no longer has access to that token. Your client scopes are updated when it is promoted/demoted between the access tiers (E.g. moving from Test Mode to Tier 2 after the app review process)

The token hasn't expired yet - If you attempt to refresh a token that has not expired, the OAuth server will simply return the unexpired token instead of creating a fresh one.

For more information on OAuth 2.0 and refresh tokens, you can read the official RFC spec here.


POST /public/submitReview

Supports locale query param / header? no

Requires user-based token? no

Creates a review for the given listing and unit and returns the ID. A successful creation returns a 202 status code and a review id. The review can be fetched via getReviewById for validation but will not appear in any associated collections for 30 days.Also, a valid user must be logged into HomeAway.

This operation allows the client to submit a review from a traveler about their experience staying at the vacation rental. The review submitted must go through the standard HomeAway review process and may not appear immediately within the list of reviews for the listing. It is recommended that the link to submitting a review be placed off of the details page of the listing and unit in question.

NOTE: Due to HomeAway's SEO policy, reviews that are less than 30 days old will not appear in any collections of the API responses. In order to view a review you have created, you can use the listingReview endpoint to fetch any review by id. This means you should store the id of the reviews you create if you wish to view them before the 30-day wait period has expired.

The following fields in the request entity must be supplied:

Name Description Required?
headline A short summary about the stay. yes
body The body of the review. yes
locale The locale that the review was written in. yes
arrivalDate The date of arrival for the stay in the YYYY-MM-DD format yes
rating An overall rating for the stay between 1 and 5 yes
listingId A listing id as supplied by this public API yes
unitId The unit Id within the listing that the review is for yes

See GET /public/listing on how to obtain the listingId and unitId.


Resource URL

https://ws.homeaway.com/public/submitReview

Response Info

Type:

ListingUnitReview

Example:

{
  "arrivalDate": "2016-04-07T00:00:00.000Z",
  "reviewerName": "Cade Parker",
  "body": "This place soooooooooooo cool.",
  "headline": "Excellent property",
  "helpfulCount": 6,
  "unhelpfulCount": 1,
  "reviewLocale": "en",
  "reviewId": "238a4c38-4bce-47fd-b6f9-31cac27963d6"
}

GET /public/myListings

Supports locale query param / header? yes (optional)

Requires user-based token? no

Returns a paginated summary of the owner's listings.

This operation will return a page of listings that belong to the logged in user. This means that a user must have authenticated with HomeAway and already be an owner with listings.

The result returned will contain a next and previous page url to allow the user to page through their defined listings. Additionally, the result payload also contains all of the available filter and sort urls that are available for use.


Resource URL

https://ws.homeaway.com/public/myListings

Query Parameters

Name Description Required?
filterProductType Filter result by the subscription type of the listing: sub|ppb no
filterStatus Filter result by the enabled status of the listing: ENABLED|DISABLED no
pageSize The size of the page to return no
sortBy Sort (format [field:ASC|DESC,field:ASC|DESC,...]) result by one or more of the following: status|updated|firstLive|subscriptionEnd|subscriptionStart|tierCode|productType no
page The page of the listing set. no
addressContains Filter results by a word contained in the address no

Response Info

Type:

OwnerListingPaginator

Example:

{
   "filters": [
      {
         "name": "ListingStatus",
         "links": [
            {
               "name": "ENABLED",
               "url": "https://ws.homeaway.com/public/myListings?locale=en&page=1&pageSize=30&filterStatus=ENABLED"
            },
            {
               "name": "DISABLED",
               "url": "https://ws.homeaway.com/public/myListings?locale=en&page=1&pageSize=30&filterStatus=DISABLED"
            }
         ]
      },
      {
         "name": "ListingProductType",
         "links": [
            {
               "name": "subscription",
               "url": "https://ws.homeaway.com/public/myListings?locale=en&page=1&pageSize=30&filterProductType=sub"
            },
            {
               "name": "ppb",
               "url": "https://ws.homeaway.com/public/myListings?locale=en&page=1&pageSize=30&filterProductType=ppb"
            }
         ]
      }
   ],
   "entries": [
      {
         "lastUpdated": "2015-09-04T15:27:07.493Z",
         "listingId": "100000",
         "externalId": "123-abc",
         "status": "ENABLED",
         "propertyName": "Clarksville Cottage",
         "productType": "PAY_PER_BOOKING_V2",
         "sourceSite": "HOMEAWAY_US",
         "location": {
            "addressLine1": "1011 W 5th St",
            "addressLine2": "Ste. 300",
            "addressLine3": null,
            "addressLine4": null,
            "addressLine5": null,
            "country": "US",
            "postalCode": "78703",
            "additionalAddressLine1": null,
            "displayLatitude": 30.270348,
            "displayLongitude": -97.755169,
            "addressIsValid": true
         },
         "subscriptionStartDate": "2014-07-02T15:21:12.293Z",
         "units": [
            {
               "name": "unit_4185157",
               "unitNumber": 4185157,
               "status": "ENABLED",
               "externalId": "unit-xyz"
            }
         ]
      }
   ],
   "page": 1,
   "pageSize": 30,
   "size": 1,
   "sortBy": [
      {
         "name": "status",
         "urlAsc": "https://ws.homeaway.com/public/myListings?locale=en&page=1&pageSize=30&sortBy=status%7CASC",
         "urlDesc": "https://ws.homeaway.com/public/myListings?locale=en&page=1&pageSize=30&sortBy=status%7CDESC"
      },
      {
         "name": "updated",
         "urlAsc": "https://ws.homeaway.com/public/myListings?locale=en&page=1&pageSize=30&sortBy=updated%7CASC",
         "urlDesc": "https://ws.homeaway.com/public/myListings?locale=en&page=1&pageSize=30&sortBy=updated%7CDESC"
      },
      {
         "name": "firstLive",
         "urlAsc": "https://ws.homeaway.com/public/myListings?locale=en&page=1&pageSize=30&sortBy=firstLive%7CASC",
         "urlDesc": "https://ws.homeaway.com/public/myListings?locale=en&page=1&pageSize=30&sortBy=firstLive%7CDESC"
      },
      {
         "name": "subscriptionEnd",
         "urlAsc": "https://ws.homeaway.com/public/myListings?locale=en&page=1&pageSize=30&sortBy=subscriptionEnd%7CASC",
         "urlDesc": "https://ws.homeaway.com/public/myListings?locale=en&page=1&pageSize=30&sortBy=subscriptionEnd%7CDESC"
      },
      {
         "name": "subscriptionStart",
         "urlAsc": "https://ws.homeaway.com/public/myListings?locale=en&page=1&pageSize=30&sortBy=subscriptionStart%7CASC",
         "urlDesc": "https://ws.homeaway.com/public/myListings?locale=en&page=1&pageSize=30&sortBy=subscriptionStart%7CDESC"
      },
      {
         "name": "tierCode",
         "urlAsc": "https://ws.homeaway.com/public/myListings?locale=en&page=1&pageSize=30&sortBy=tierCode%7CASC",
         "urlDesc": "https://ws.homeaway.com/public/myListings?locale=en&page=1&pageSize=30&sortBy=tierCode%7CDESC"
      },
      {
         "name": "productType",
         "urlAsc": "https://ws.homeaway.com/public/myListings?locale=en&page=1&pageSize=30&sortBy=productType%7CASC",
         "urlDesc": "https://ws.homeaway.com/public/myListings?locale=en&page=1&pageSize=30&sortBy=productType%7CDESC"
      }
   ]
}

GET /public/myReservations

Supports locale query param / header? no

Requires user-based token? no

Returns a paginated list of the current and future reservations for the given listing from oldest to newest.

This operation will return a page of reservations for the listingId passed in that belong to the logged in user. This means that a user must have authenticated with HomeAway and already be an owner with listings.

The result returned will contain a next and previous page url to allow the user to page through their defined listings. Additionally, the result payload also contains all of the available filter and sort urls that are available for use.


Resource URL

https://ws.homeaway.com/public/myReservations

Query Parameters

Name Description Required?
lastName Last name of traveler to filter on no
endDate Upper bound date of the reservations to find in the format yyyy-MM-dd no
pageSize The size of the page to return no
listingId The listingId of the listing to get the reservations for. yes
firstName First name of traveler to filter on no
referenceNumber Reference number to filter on no
deginDate Lower bound date of the reservations to find in the format yyyy-MM-dd no
includeOrders A flag that specifies whether or not the response should include the reservation payment orders.NOTE: There will be a significant performance impact if includeOrders=true, so we recommend that you only set this flag when you really need the payment info. no
showCancelled By default, this endpoint filters out cancelled reservations. When this flag is 'true' myReservations will return cancelled reservations in the results. no
sortBy Sort (format [field:ASC|DESC,field:ASC|DESC,...]) result by one or more of the following: availabilityStatus|beginDate|paymentStatus no
page The page of the listing set. no
availabilityStatus Status to filter on no
email Email of traveler to filter on no
paymentStatus PaymentStatus to filter on no

Response Info

Type:

ListingReservationsPaginator

Example:

{
  "filters": [
    {
      "name": "availabilityStatus",
      "links": [
        {
          "name": "RESERVE",
          "url": "https://ws.homeaway.com/public/myReservations?listingId=4070610&page=1&pageSize=2&availabilityStatus=RESERVE"
        },
        {
          "name": "EXTERNAL_SOR",
          "url": "https://ws.homeaway.com/public/myReservations?listingId=4070610&page=1&pageSize=2&availabilityStatus=EXTERNAL_SOR"
        },
        {
          "name": "UNAVAILABLE",
          "url": "https://ws.homeaway.com/public/myReservations?listingId=4070610&page=1&pageSize=2&availabilityStatus=UNAVAILABLE"
        },
        {
          "name": "HOLD",
          "url": "https://ws.homeaway.com/public/myReservations?listingId=4070610&page=1&pageSize=2&availabilityStatus=HOLD"
        }
      ]
    },
    {
      "name": "paymentStatus",
      "links": [
        {
          "name": "PARTIAL_PAID",
          "url": "https://ws.homeaway.com/public/myReservations?listingId=4070610&page=1&pageSize=2&paymentStatus=PARTIAL_PAID"
        },
        {
          "name": "EXTERNAL_SOR",
          "url": "https://ws.homeaway.com/public/myReservations?listingId=4070610&page=1&pageSize=2&paymentStatus=EXTERNAL_SOR"
        },
        {
          "name": "UNPAID",
          "url": "https://ws.homeaway.com/public/myReservations?listingId=4070610&page=1&pageSize=2&paymentStatus=UNPAID"
        },
        {
          "name": "PAID",
          "url": "https://ws.homeaway.com/public/myReservations?listingId=4070610&page=1&pageSize=2&paymentStatus=PAID"
        },
        {
          "name": "OVERPAID",
          "url": "https://ws.homeaway.com/public/myReservations?listingId=4070610&page=1&pageSize=2&paymentStatus=OVERPAID"
        }
      ]
    }
  ],
  "entries": [
    {
      "active": true,
      "availabilityStatus": "RESERVE",
      "checkinTime": "16",
      "checkoutTime": "11",
      "adults": 2,
      "children": 0,
      "pets": 0,
      "locale": "en_US",
      "reservationDates": {
        "beginDate": "2016-03-24",
        "endDate": "2016-03-27"
      },
      "reservationPaymentStatus": "UNPAID",
      "reservationReferenceNumber": "HA-PC0S1P",
      "status": "CONFIRMED",
      "travelerNote": "I believe there will be 12 of us.  We will bring additional towels and inflatable beds if necessary.",
      "contact": {
        "active": true,
        "city": "Baton Rouge",
        "firstName": "FN+f4c2626e19ff49918cb73659f1e1a50f",
        "lastName": "LN+f4c2626e19ff49918cb73659f1e1a50f",
        "state": "LA"
      },
      "orders": [
        {
          "currency": "USD",
          "orderItems": [
            {
              "name": "cleaning",
              "preTaxAmount": {
                "amount": "75.00",
                "currency": "USD"
              },
              "quoteItemType": "Fee",
              "totalAmount": {
                "amount": "0.00",
                "currency": "USD"
              },
              "feeType": "MISC"
            },
            {
              "name": "refundableDamageDeposit",
              "preTaxAmount": {
                "amount": "1500.00",
                "currency": "USD"
              },
              "quoteItemType": "Deposit",
              "totalAmount": {
                "amount": "0.00",
                "currency": "USD"
              },
              "feeType": "DEPOSIT"
            },
            {
              "name": "rentalAmount",
              "preTaxAmount": {
                "amount": "900.00",
                "currency": "USD"
              },
              "quoteItemType": "Rental_Amount",
              "totalAmount": {
                "amount": "0.00",
                "currency": "USD"
              },
              "feeType": "RENTAL"
            }
          ],
          "paymentSchedule": {
            "paymentScheduleItems": [
              {
                "amount": {
                  "amount": "514.50",
                  "currency": "USD"
                },
                "dueDate": "2016-01-06",
                "refundable": false,
                "status": "PAID",
                "paymentLineItems": [
                  {
                    "description": "Quote Payment",
                    "type": "PAYMENT",
                    "amount": 514.5,
                    "paymentTransactionItemGuid": "305d1a467729494bb0b14f0dab50910b",
                    "status": "COMPLETED",
                    "paymentDate": "2016-01-06",
                    "active": true
                  }
                ]
              },
              {
                "amount": {
                  "amount": "2014.50",
                  "currency": "USD"
                },
                "dueDate": "2016-03-09",
                "refundable": false,
                "status": "SENT",
                "paymentLineItems": [
                  {
                    "description": "Quote Payment",
                    "type": "PAYMENT",
                    "amount": 514.5,
                    "status": "PENDING",
                    "active": true
                  },
                  {
                    "description": "Deposit",
                    "type": "PAYMENT",
                    "amount": 1500,
                    "status": "PENDING",
                    "active": true
                  }
                ]
              }
            ]
          },
          "reservationCancellationPolicy": {
            "cancellationPolicyItems": [
              {
                "amount": null,
                "deadline": "2016-02-23",
                "percentPenalty": 0
              }
            ]
          },
          "reservationOrderState": "ACTIVE",
          "rawReservationOrderGuid": "f943d63e-9bd1-4f3a-a75a-ac3df1fc57e2"
        }
      ]
    }
  ],
  "nextPage": "https://ws.homeaway.com/public/myReservations?listingId=4070610&page=2&pageSize=2&sortBy=",
  "page": 1,
  "pageSize": 2,
  "size": 36,
  "listingId": "4070610",
  "sortBy": [
    {
      "name": "availabilityStatus",
      "urlAsc": "https://ws.homeaway.com/public/myReservations?listingId=4070610&page=1&pageSize=2&sortBy=availabilityStatus%7CASC",
      "urlDesc": "https://ws.homeaway.com/public/myReservations?listingId=4070610&page=1&pageSize=2&sortBy=availabilityStatus%7CDESC"
    },
    {
      "name": "beginDate",
      "urlAsc": "https://ws.homeaway.com/public/myReservations?listingId=4070610&page=1&pageSize=2&sortBy=beginDate%7CASC",
      "urlDesc": "https://ws.homeaway.com/public/myReservations?listingId=4070610&page=1&pageSize=2&sortBy=beginDate%7CDESC"
    },
    {
      "name": "paymentStatus",
      "urlAsc": "https://ws.homeaway.com/public/myReservations?listingId=4070610&page=1&pageSize=2&sortBy=paymentStatus%7CASC",
      "urlDesc": "https://ws.homeaway.com/public/myReservations?listingId=4070610&page=1&pageSize=2&sortBy=paymentStatus%7CDESC"
    }
  ]
}

GET /public/quote

Supports locale query param / header? yes (optional)

Requires user-based token? no

Generates an up to date quote and booking url

NOTE: Not all units have enough rate information to generate a quote, and not all units are quotable for any given stay period (arrivalDate - departureDate). If a unit is not quotable at the time of the request for any reason, this operation will respond with a status code of 400 (Bad Request) and small description of the reason (e.g UnknownCurrency, StayPrecedesUnitAvailability, InvalidStay, InsufficientPriorNotification, MaximumStayViolation, UnitNotAvailableForBooking, MinimumStayViolation, TooManyProperties, ChangeoverDayException, RateCoverageException, InvalidRateData, NoRateDataFound, UnknownRateAlgorithm).


Resource URL

https://ws.homeaway.com/public/quote

Query Parameters

Name Description Required?
pets The number of a certain type of pet (multiple values supported). Values should be formatted as '<type>:<count of that type>' The allowed values for <type> are 'Cat', 'Dog', and 'Other'. E.g. /quote?...&pets="Dog:1"&pets="Cat:2" no
adultsCount The number of adults being booked for the stay yes
unitId The id of the unit being booked for the stay yes
departureDate The departure date in the form yyyy-MM-dd yes
listingId The listing id to be booked as retrieved from the search operation yes
currencyCode The currency to generate the quote in (optional defaults to USD) no
arrivalDate The arrival date in the form yyyy-MM-dd yes
childrenCount The optional number of children being booked for the stay no

Response Info

Type:

QuoteDetails

Example:

{
   "listingId": "100000",
   "unitId": "386884",
   "bookingUrl": "https://homeaway.com/td/tc/checkout/121.100000.386884?arrivalDate=10/02/2015&departureDate=10/10/2015&petIncluded=false&adultsCount=2&childrenCount=0&propertyId=100000&unitLink=/units/0000/d742a786-84f1-4279-9760-21aeb01cdb36",
   "checkinDate": "2015-10-02T05:00:00.000Z",
   "checkoutDate": "2015-10-10T05:00:00.000Z",
   "currencyCode": "USD",
   "occupancy": {
      "adultCount": 2,
      "childCount": 0
   },
   "quoteTotals": {
      "total": {
         "amount": "3457.14",
         "currency": "USD"
      },
      "subtotal": {
         "amount": "3457.14",
         "currency": "USD"
      },
      "ownerAmount": null,
      "totalTax": {
         "taxAmount": {
            "amount": "0.00",
            "currency": "USD"
         }
      }
   },
   "fees": [
      {
         "feeType": "RENTAL_AMOUNT",
         "amount": {
            "amount": "3457.14",
            "currency": "USD"
         }
      },
      {
         "feeType":"Fee",
         "name":"Cleaning fee",
         "taxes":null,
         "amount":{
            "amount":"11.00",
            "currency":"USD"
         }
      }
   ],
   "payments": [
      {
         "amount": {
            "amount": "3457.14",
            "currency": "USD"
         },
         "includes": [
            {
               "feeType": "RENTAL_AMOUNT",
               "amount": {
                  "amount": "3457.14",
                  "currency": "USD"
               }
            }
         ],
         "dueDate": "2015-10-02T05:00:00.000Z"
      }
   ]
}

POST /public/addMessage

Supports locale query param / header? yes (optional)

Requires user-based token? no

Add a Message to a Conversation

This operation allows the client to add a new message to an existing conversation thread. The message text must be provided in the body of your request:

{
    message: "Thanks for your inquiry. I'll get back to you shortly!"
}

The message will be added to a conversation based on the conversationId query param. See GET /public/conversation on how to obtain the conversationId.


Resource URL

https://ws.homeaway.com/public/addMessage

Query Parameters

Name Description Required?
conversationId The Conversation UUID to add the Message to. yes

Response Info

Type:

ConversationMessage

Example:

{  
   "id":"15cc9bcd-7705-4601-847a-5257bec47050",
   "typeKey":"REPLIED",
   "from":{  
      "firstName":"John",
      "lastName":"Doe",
      "role":"OWNER",
      "phone": "5125551234"
   },
   "date": "2015-09-24T23:58:38.350Z",
   "message":"Yes, I am available for those dates.  Do you have any pets?",
   "attachments":[  

   ],
   "attributes":[  

   ]
}

GET /public/myInbox

Supports locale query param / header? yes (optional)

Requires user-based token? no

Load the Owner's Inbox for the logged-in User

This operation will retrieve the owner's HomeAway inbox, with the optional ability to sort, filter, and search by string.

The result you should get back from this API is a list of inbox entries that are summaries of a conversation. They will have some info about the conversation, as well as the last message. In order to get the full conversation (all messages, attachments, etc) use the conversationUrl provided in each entry.


Resource URL

https://ws.homeaway.com/public/myInbox

Query Parameters

Name Description Required?
pageSize The size of a page of results no
unrepliedOnly A flag indicating that the inbox should be populated by only unreplied conversations no
sort The field by which to Sort Conversations. The supported values for this param are: received, travelerName, stayDate, created no
beforeDate Conversations will not be included in the results unless they were created on or before this date. Use yyyy-MM-dd as the format no
archived A flag indicating that the inbox should be populated by only archived conversations no
search A string to search for. no
inquiries A flag indicating the inbox should be populated by only inquiries no
afterDate Conversations will not be included in the results unless they were created on or after this date. Use yyyy-MM-dd as the format no
reservations A flag indicating the inbox should be populated by only reservations no
asTraveler A flag that indicates whether the inbox should render for an owner or a traveler; defaults to owner. no
sortOrder The order to sort by, ASC or DESC. no
unreadOnly A flag indicating that the inbox should be populated by only unread conversations no
page The page of the result set no
sortReservationRequestsInline If True, in the default Inbox view, sort Reservation Requests inline rather than at the top. no
status The conversation status by which to filter the inbox. The supported values for this param are: BLOCKED_RESERVATION, BOOKING, CANCELLED, INQUIRY, PAYMENT_REQUEST_SENT, POST_STAY, QUOTE_SENT, REPLIED, RESERVATION, RESERVATION_DOWNLOADABLE, RESERVATION_REQUEST, RESERVATION_REQUEST_DECLINED, RESERVATION_REQUEST_EXPIRED, STAYING, TENTATIVE_RESERVATION, UNKNOWN, RECALCULATE no

Response Info

Type:

Inbox

Example:

{  
   "entries":[
      {
         "conversationUrl":"https://ws.homeaway.com/public/conversation?id=79177a67-d22a-4b9c-86fb-93044baaf8fb",
         "id":"79177a67-d22a-4b9c-86fb-93044baaf8fb",
         "lastMessage": {
            "id": "b73bc586-9df2-447b-8520-1caf18c2fdf1",
            "typeKey": "REPLIED",
            "from": {
               "firstName": "John",
               "lastName": "Doe",
               "role": "OWNER",
               "phone": "5125551234"
            },
            "date": "2015-09-24T23:58:38.350Z",
            "message": "I think I can squeeze you in for those dates.  What time will you be in town?",
            "attachments": [],
            "attributes": []
         },
         "listingUrl":"https://ws.homeaway.com/public/listing?id=100000",
         "status": "POST_STAY",
         "stayEndDate": "2015-07-09T05:00:00.000Z",
         "stayStartDate": "2015-07-07T05:00:00.000Z",
         "flexibleDates": false,
         "unreadMessages": false,
         "numAdults": 2,
         "numChildren": 2,
         "correspondent": {
            "firstName": "Jane",
            "lastName": "Smith",
            "role": "TRAVELER",
            "phone": "(512) 555-8888"
         },
         "inquiryComments": "Hi John, my family is planning to be in town from July 7-9.  Are you available?",
         "inquirySource": "HomeAway.com",
         "reservationReferenceNumber": "HA-f52c48",
         "archived": false,
         "lastMessageReceivedDate": "2015-07-31T17:57:12.280Z",
         "created": "2015-06-19T20:04:42.393Z",
         "ownerResponded": true,
         "ownerMarkedSpam": false
      },
      {  
         "conversationUrl":"https://ws.homeaway.com/public/conversation?id=a26b2d80-e03a-4a16-8004-6af2741f95d2",
         "id":"a26b2d80-e03a-4a16-8004-6af2741f95d2",
         "lastMessage":{  
            "id":"9152f8a8-b042-4c22-92a9-be029f7f4355",
            "typeKey":"REPLIED_AVAILABLE",
            "from":{  
               "firstName":"John",
               "lastName":"Doe",
               "role":"OWNER",
               "phone": "5125551234"
            },
            "date": "2014-02-24T23:58:38.350Z",
            "message":"Yes, there is a poolhouse stocked with towels and toys for the kids.  Will you be bringing anyone else?",
            "attachments": [],
            "attributes":[]
         },
         "listingUrl":"https://ws.homeaway.com/public/listing?id=100000",
         "status":"RESERVATION_REQUEST",
         "stayEndDate":"2014-02-23T00:00:00.000Z",
         "stayStartDate":"2014-02-21T00:00:00.000Z",
         "unreadMessages":false,
         "numAdults":0,
         "numChildren":0,
         "correspondent":{  
            "firstName":"Tom",
            "lastName":"Jones",
            "role":"TRAVELER",
            "phone": "512 555 4321"
         },
         "reservationSource": "HomeAway.com",
         "reservationReferenceNumber":"HA-8fc598",
         "archived":false,
         "lastMessageReceivedDate":"2014-02-04T19:25:11.757Z",
         "created":"2014-02-04T19:25:11.717Z",
         "ownerMarkedSpam":false
      },
      {  
         "conversationUrl":"https://ws.homeaway.com/public/conversation?id=3dd286fb-b6e4-4cba-972c-da3726f17dba",
         "id":"3dd286fb-b6e4-4cba-972c-da3726f17dba",
         "lastMessage":{  
            "id":"38b3a15f-41fb-40bb-9a87-1cfb40472eb0",
            "typeKey":"RESERVATION_REQUEST",
            "from":{  
               "firstName":"Sam",
               "lastName":"Smith",
               "role":"TRAVELER",
               "phone": "512 555-7890"
            },
            "date": "2014-02-24T23:58:38.350Z",
            "message":"We were hoping to stay longer than that... what about the week after?",
            "attachments": [],
            "attributes": []
         },
         "listingUrl":"https://ws.homeaway.com/public/listing?id=100000",
         "status":"RESERVATION_REQUEST",
         "stayEndDate":"2018-03-19T00:00:00.000Z",
         "stayStartDate":"2018-03-17T00:00:00.000Z",
         "unreadMessages":false,
         "numAdults":0,
         "numChildren":0,
         "correspondent":{  
            "firstName":"Sam",
            "lastName":"Smith",
            "role":"TRAVELER",
            "phone": "512 555-7890"
         },
         "reservationSource": "VRBO.com",
         "reservationReferenceNumber":"HA-2d5f38",
         "expirationDateTime":"2014-02-21T20:42:25.860Z",
         "archived":false,
         "lastMessageReceivedDate":"2014-02-20T20:42:33.253Z",
         "created":"2014-02-20T20:42:25.860Z",
         "ownerMarkedSpam":false
      }
   ],
   "nextPage":"https://ws.homeaway.com/public/myInbox?page=2&pageSize=3",
   "pageSize":3,
   "size":1108,
   "page":1
}

GET /public/me

Supports locale query param / header? no

Requires user-based token? no

Returns information about the logged in user.


Resource URL

https://ws.homeaway.com/public/me

Response Info

Type:

User

Example:

{
  "firstName": "Jim ",
  "lastName": "Bob",
  "emailAddress": "jbob@example.com",
  "id": "983b9be9-89f9-49ad-b329-92821c842c72",
  "accounts": [
    {
      "accountType": "HOMEAWAY",
      "advertiser": {
        "site": "HOMEAWAY_US",
        "advertiserNumber": 804203
      }
    },
    {
      "accountType": "TRAVELER"
    }
  ]
}

GET /public/search

Supports locale query param / header? yes (optional)

Requires user-based token? no

Search for listings

This operation allows for arbitrary search operations against the HomeAway search engine. The listings returned are filtered expose the listings we've chosen to publish through our API.

  • When performing a query the text passed into the q parameter can contain multiple words that describe the criteria for listings.
    For example: "Austin sleeps 6" tells the search engine to find listings in Austin that has accommodations for six.

  • The result returned from a search will contain additional pre-formatted search refinement links that can be exposed to the user. Each of these links will contain a label as well as the link itself. There are refinement links for the region the listing is in, number of bedrooms, number of bathrooms etc. You should not try and construct the refinement links yourself, and just use what is supplied as the content of the links may change over time.

  • Using any of the additional optional parameters documented below will provide additional filtering of the results returned from the query.

  • If at all possible, a locale should be provided. This will cause the search to be executed in that locale, and most if not all of the search result text and refinement labels will be be returned in that locale.

  • The prevPage and nextPage values returned in the result will contain either a null or a url to the page in question


Resource URL

https://ws.homeaway.com/public/search

Query Parameters

Name Description Required?
maxNightlyPrice Maximum nightly price to search no
minSleeps Minimum number of sleeps to search no
availabilityStart Date formatted as yyyy-MM-dd to indicate the earliest available date (lower bound) in the search (optional) no
minBathrooms Minimum number of bathrooms to search no
pageSize The size of a page of results. Must be an integer between 1 and 30, inclusive. NOTE: The maximumrecord number you can reach is 5000. I.e. (page * pageSize) must be less than 5000, otherwisethis endpoint will return status code 416 (Requested Range Not Satisfiable) no
maxBedrooms Maximum number of bedrooms to search no
maxBathrooms Maximum number of bathrooms to search no
centerPointLongitude Uses a proximity search to limit results to listings located within a max distance from a specific location, must be sent with centerPointLatitude and distanceInKm no
imageSize Size of the image to return the URL fo must be one of: SMALL, MEDIUM, LARGE no
minBedrooms Minimum number of bedrooms to search no
maxSleeps Maximum number of sleeps to search no
availabilityEnd Date formatted as yyyy-MM-dd to indicate the latest available date (upper bound) in the search no
refine Refine the search with the given comma delimited refinements (optional comes from a search refinement) no
sort Sort the results <field:asc|desc> where field is one of (availabilityUpdated, bathrooms, bedrooms, prices, travelerReviewCount, averageRating) no
upperRightLongitude Adds a geographical bounding box constraint to the search. Only listings located within this bounding box will be returned in the results, must be sent with lowerLeftLongitude, upperRightLatitude and upperRightLongitude no
minNightlyPrice Minimum nightly price to search no
distanceInKm Uses a proximity search to limit results to listings located within a max distance from a specific location, must be sent with centerPointLatitude and centerPointLongitude no
q The query to search for listings with, for example 'austin sleeps 6' no
minPrice Minimum rental price for a given stay. (NOTE: Both availabilityStart and availabilityEnd must be used along with this parameter. Otherwise, the search endpoint will return a 400 status code.) no
lowerLeftLatitude Adds a geographical bounding box constraint to the search. Only listings located within this bounding box will be returned in the results, must be sent with lowerLeftLongitude, upperRightLatitude and upperRightLongitude no
page The page of the result set. Must be an integer between 1 and 300, inclusive. NOTE: The maximumrecord number you can reach is 5000. I.e. (page * pageSize) must be less than 5000, otherwisethis endpoint will return status code 416 (Requested Range Not Satisfiable) no
maxPrice Maximum rental price for a given stay. (NOTE: Both availabilityStart and availabilityEnd must be used along with this parameter. Otherwise, the search endpoint will return a 400 status code.)" no
upperRightLatitude Adds a geographical bounding box constraint to the search. Only listings located within this bounding box will be returned in the results, must be sent with lowerLeftLongitude, upperRightLatitude and upperRightLongitude no
lowerLeftLongitude Adds a geographical bounding box constraint to the search. Only listings located within this bounding box will be returned in the results, must be sent with lowerLeftLongitude, upperRightLatitude and upperRightLongitude no
centerPointLatitude Uses a proximity search to limit results to listings located within a max distance from a specific location, must be sent with centerPointLongitude and distanceInKm no

Response Info

Type:

ListingSearchPaginator

Example:

{
  "nextPage": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&page=2",
  "pageSize": 1,
  "pageCount": 29653,
  "page": 1,
  "size": 29653,
  "refinements": [
    {
      "key": "regions_title",
      "fieldName": "region",
      "options": [
        {
          "url": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&refine=region:7116",
          "count": 29643,
          "title": "Austin"
        },
        {
          "url": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&refine=region:28216",
          "count": 7,
          "title": "Bastrop"
        },
        {
          "url": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&refine=region:7119",
          "count": 6062,
          "title": "Lake Travis"
        }
      ]
    },
    {
      "key": "bedrooms_title",
      "fieldName": "Bedrooms",
      "options": [
        {
          "url": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&refine=Bedrooms:Studio",
          "count": 12356,
          "title": "Studio"
        },
        {
          "url": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&refine=Bedrooms:1",
          "count": 16885,
          "title": "1"
        },
        {
          "url": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&refine=Bedrooms:2",
          "count": 50,
          "title": "2"
        },
        {
          "url": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&refine=Bedrooms:3",
          "count": 309,
          "title": "3"
        },
        {
          "url": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&refine=Bedrooms:4",
          "count": 23,
          "title": "4"
        },
        {
          "url": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&refine=Bedrooms:5",
          "count": 12,
          "title": "5"
        },
        {
          "url": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&refine=Bedrooms:6",
          "count": 18,
          "title": "6+"
        }
      ]
    },
    {
      "key": "sleeps_title",
      "fieldName": "Sleeps",
      "options": [
        {
          "url": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&refine=Sleeps:1",
          "count": 29653,
          "title": "1+"
        },
        {
          "url": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&refine=Sleeps:2",
          "count": 29648,
          "title": "2+"
        },
        {
          "url": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&refine=Sleeps:3",
          "count": 29623,
          "title": "3+"
        },
        {
          "url": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&refine=Sleeps:4",
          "count": 29596,
          "title": "4+"
        },
        {
          "url": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&refine=Sleeps:5",
          "count": 15041,
          "title": "5+"
        },
        {
          "url": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&refine=Sleeps:6",
          "count": 15025,
          "title": "6+"
        },
        {
          "url": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&refine=Sleeps:7",
          "count": 305,
          "title": "7+"
        },
        {
          "url": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&refine=Sleeps:8",
          "count": 300,
          "title": "8+"
        },
        {
          "url": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&refine=Sleeps:9",
          "count": 48,
          "title": "9+"
        },
        {
          "url": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&refine=Sleeps:10",
          "count": 41,
          "title": "10+"
        },
        {
          "url": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&refine=Sleeps:11",
          "count": 26,
          "title": "11+"
        },
        {
          "url": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&refine=Sleeps:12",
          "count": 25,
          "title": "12+"
        },
        {
          "url": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&refine=Sleeps:13",
          "count": 18,
          "title": "13 or more"
        }
      ]
    },
    {
      "key": "bathrooms_title",
      "fieldName": "Bathrooms",
      "options": [
        {
          "url": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&refine=Bathrooms:1",
          "count": 29240,
          "title": "1+"
        },
        {
          "url": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&refine=Bathrooms:2",
          "count": 59,
          "title": "2+"
        },
        {
          "url": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&refine=Bathrooms:3",
          "count": 312,
          "title": "3+"
        },
        {
          "url": "https://ws.homeaway.com/public/search?q=austin&minPrice=100.0&availabilityEnd=2016-05-04&availabilityStart=2016-04-22&pageSize=1&locale=en&refine=Bathrooms:4",
          "count": 33,
          "title": "4+ bathrooms"
        }
      ]
    }
  ],
  "entries": [{
    "listingId": "4136413",
    "headline": "Autogenerated by GCIT: HomeAway НфмёДшау",
    "description": "HomeAway НфмёДшауVoluptatem et natus illum nam aut voluptatem placeat. Doloribus et nobis quasi et beatae amet quibusdam. Modi odit culpa. Est alias distinctio. Et dolore voluptatem et numquam deleniti. Pariatur nostrum iste. Amet quasi sit tempor...",
    "accommodations": "1 BR, 1.0BA, Sleeps 6",
    "minStayRange": {
      "minStayHigh": 1,
      "minStayLow": 1
    },
    "thumbnail": {
      "height": 74,
      "imageSize": "SMALL",
      "secureUri": "https://imagesus-ssl.homeaway.com/mda01/32baeb39-007a-49b3-8e14-708f5c9cc8d5.1.1",
      "uri": "http://imagesus.homeaway.com/mda01/32baeb39-007a-49b3-8e14-708f5c9cc8d5.1.1",
      "width": 133
    },
    "priceQuote": {
      "amount": 1200,
      "averageNightly": 100,
      "currencyUnits": "USD",
      "rent": 1200
    },
    "priceRanges": [{
      "currencyUnits": "USD",
      "from": 100,
      "periodType": "NIGHTLY-WEEKDAY",
      "to": 100
    }],
    "location": {
      "lat": 30.270278,
      "lng": -97.755162,
      "city": "Austin",
      "state": "TX",
      "country": "US"
    },
    "regionPath": "Austin area > Austin Apartment #4136413",
    "reviewCount": 0,
    "reviewAverage": 0,
    "bookWithConfidence": true,
    "detailsUrl": "https://ws.homeaway.com/public/listing?id=4136413",
    "bathrooms": 1,
    "bedrooms": 1,
    "listingUrl": "https://ws.homeaway.com/vacation-rental/p4136413"
  }]
}

GET /public/conversation

Supports locale query param / header? yes (optional)

Requires user-based token? no

Load Conversation content, including Messages, for a selected Conversation

This operation allows the client to get a conversation thread.


Resource URL

https://ws.homeaway.com/public/conversation

Query Parameters

Name Description Required?
id The Conversation UUID to load. yes

Response Info

Type:

InboxConversation

Example:

{  
   "id":"15cc9bcd-7705-4601-847a-5257bec47050",
   "conversationUrl":"https://ws.homeaway.com/public/conversation?id=15cc9bcd-7705-4601-847a-5257bec47050",
   "owner":{  
      "firstName":"John",
      "lastName":"Doe",
      "role":"OWNER",
      "phone": "5125551234"
   },
   "traveler":{  
      "firstName":"Jane",
      "lastName":"Smith",
      "role":"TRAVELER",
      "phone": "512-555-7878"
   },
   "listingUrl": "https://ws.homeaway.com/public/listing?id=100000",
   "status":"RESERVATION_REQUEST",
   "messages":[
      {  
         "id":"4c1310ec-52ff-4c28-a2ca-a9f4c7ae143f",
         "typeKey":"REPLIED",
         "from":{  
            "firstName":"Jane",
            "lastName":"Smith",
            "role":"TRAVELER",
            "phone": "512-555-7878"
         },
         "date":"2015-09-24T23:58:38.350Z",
         "message":"Great!  My husband and I are going to be in town for the winter festival and we have two dogs.",
         "attachments":[  

         ],
         "attributes":[  

         ]
      },
      {  
         "id":"53721649-3ae8-430e-96c2-bae4a2a6cc90",
         "typeKey":"OWNER_RESPONDED_NOTIFICATION",
         "attachments": [

         ],
         "attributes":[

         ]
      },
      {  
         "id":"2cd33563-90b9-4e87-b632-89635c1aca53",
         "typeKey":"REPLIED",
         "from":{  
            "firstName":"John",
            "lastName":"Doe",
            "role":"OWNER",
            "phone": "5125551234"
         },
         "date":"2015-06-22T14:16:13.097Z",
         "message":"I'm available for those dates.  There is a large backyard and the neighborhood is a lovely place for walks.",
         "attachments":[  

         ],
         "attributes":[  

         ]
      },
      {  
         "id":"05bf4d12-d987-44d5-84be-3268acd7e31b",
         "typeKey":"RESERVATION_REQUEST",
         "from":{  
            "firstName":"Jane",
            "lastName":"Smith",
            "role":"TRAVELER",
            "phone": "512-555-7878"
         },
         "date":"2015-06-19T20:04:42.553Z",
         "message":"Hi, we were looking to stay from the 6-8th of February.  Does your property have room for dogs to run around?",
         "attachments":[  

         ],
         "attributes":[  

         ]
      }
   ],
   "checkinDate":"2018-02-06T00:00:00.000Z",
   "checkoutDate":"2018-02-08T00:00:00.000Z",
   "inquirySource": "HomeAway.com",
   "reservation":{  
      "active":true,
      "availabilityStatus":"HOLD",
      "checkinTime":"16",
      "checkoutTime":"11",
      "adults":0,
      "children":0,
      "pets":0,
      "locale":"en_US",
      "ownerNote":"Guest is bringing two dogs.",
      "reservationDates":{  
         "beginDate":"2018-02-05",
         "endDate":"2018-02-07"
      },
      "reservationPaymentStatus":"UNPAID",
      "reservationReferenceNumber":"HA-79177a",
      "status":"UNCONFIRMED_BY_OWNER",
      "contact":{  
         "active":true,
         "address":{
            "rel": null,
            "addressLine1": "1011 W. 5th St.",
            "addressLine2": "SUITE 300",
            "addressLine3": null,
            "addressLine4": null,
            "addressLine5": null,
            "additionalAddressLine1": null,
            "address1": "1011 W. 5th St.",
            "address2": "SUITE 300",
            "address3": null,
            "city": null,
            "stateProvince": null,
            "subdivision": null,
            "country": "TX",
            "postalCode": "78703",
            "primary": null,
            "addressIndex": null,
            "addressTypeId": null
         },
         "cell":null,
         "city":null,
         "companyName":null,
         "countryCode":null,
         "email":"jane-smith@example.com",
         "fax":null,
         "firstName":"Jane",
         "home":null,
         "lastName":"Smith",
         "phone":null,
         "state":null
      }
   },
   "invoiceExists":true,
   "reviewRequestSent":false,
   "created":"2014-02-04T19:16:54.260Z",
   "numAdults":0,
   "numChildren":0,
   "ownerResponded":true,
   "ownerMarkedSpam":false
}

GET /public/listing

Supports locale query param / header? yes (optional)

Requires user-based token? no

Given a listing id, return details about the listing.

This operation allows the client to get a listing. The id that must be passed to this operation, must be that of a listing id found via the search operation.

The default behavior of this operation is to provide minimal information for the listing. In order to retrieve more details about the listing, you must specify at least one value for the 'q' query param. To specify more than one value just add another 'q' query param. E.g. /public/listing?listingId=100000&q=DETAILS&q=LOCATION. Here is the list of allowed values.

Name Description
AVAILABILITY Returns the availability of the listing represented as a group of strings in where each character in each string represents the status of the listing on a day during the specified date range. A default value is provided for dates outside of the date range. Along with the availability, the other strings are used to give information on different traits about the listing.
  • For the availability string, the possible character values are 'Y' = available and 'N' = not available.
  • For the changeOver string, the possible character values are 'X' = no action possible, 'C' = check-in/out, 'O' = check-out only, 'I' = check-in only.
  • For the stayIncrement string, the possible character values are 'D' = Day, 'M' = Month, 'W' = Week, 'Y' = Year
DETAILS Returns specific details about the listing, such as the descriptions, unit type, number of rooms, features, etc.
LOCATION Returns a lat/long pair that represents the location/region of the listing.
PHOTOS Returns a list of thumbnails and photos of the listing. Each photo can have 3 sizes. Small, medium, and large.
RATES Returns a list of rates for multiple date ranges. Each rate period can have multiple rates based on the rate type, e.g, NIGHTLY_WEEKDAY, WEEKLY, MONTHLY, etc.
REVIEWS Returns the top 10 reviews for the listing. This payload should also contain links to the /public/listingReviews API for the listing if there are more than 10 reviews. NOTE: Due to HomeAway's SEO policy, reviews that are less than 30 days old will not appear in any collections of the API responses. In order to view a review you have created, you can use the listingReview endpoint to fetch any review by id. This means you should store the id of the reviews you create if you wish to fetch them before the 30-day wait period has expired.
SITES Returns a list of the sites the listing is published on. Each entry is a Link object, where the 'rel' field represents the site name, and the 'href' field is a link to the live property page on that particular site. If there is no value for 'href', then there is no deterministic listing URL for that site.

Resource URL

https://ws.homeaway.com/public/listing

Query Parameters

Name Description Required?
q Use the q parameter to fetch specific listing details.Valid options are AVAILABILITY, DETAILS, LOCATION, PHOTOS, RATES, REVIEWS, and SITES If no value is given, the listing is returned with minimal content. no
id The id of the listing. yes

Response Info

Type:

ListingAd

Example:

{
  "listingId": "6592159",
  "listingUrl": "https://www.homeaway.com/vacation-rental/p6592159",
  "sourceLocale": "es",
  "sourceLocaleName": "spanish",
  "adContent": {
    "description": "The apartment has been completely renovated with the finest materials. It is located in a typical old building in Madrid with corrala. \n\nLess than five minutes walk from the Gran Vía and tourist attractions of the city (Plaza Mayor, Puerta del Sol, Madrid de los Austrias) and with excellent communications with the city and surrounding areas. \n\nThe apartment has 3 bedrooms. The master bedroom has its own bathroom and two bedrooms have two single beds each. There is a second bathroom and toilet. \n\nThe living room is double with dining area with table for 6 people and possible extension for 8 and a living area with two sofas. The kitchen is fully equipped with fridge, freezer, oven, microwave, hob and breakfast table. \n\nThe apartment is ideal for visiting Madrid walk with family or group or spend a few days enjoying the theaters and shows offered in Madrid.",
    "headline": "Spacious luxury apartment close to Gran Via"
  },
  "features": [
    {
      "count": 1,
      "category": "LOCATION_TYPE",
      "description": "town",
      "localizedName": "Town"
    }
  ],
  "location": {
    "lat": 40.4255485534668,
    "lng": -3.7075681686401367
  },
  "sites": [
    {
      "href": "https://www.homeaway.dk/feriehus/p6592159",
      "rel": "HOMEAWAY_DK"
    },
    {
      "href": "https://www.fewo-direkt.de/ferienwohnung-ferienhaus/p6592159",
      "rel": "HOMEAWAY_DE"
    },
    {
      "href": "https://www.homeaway.gr/p6592159",
      "rel": "HOMEAWAY_GR"
    },
    {
      "href": "https://www.vrbo.com/p6592159",
      "rel": "VRBO"
    },
    {
      "href": "https://www.homeaway.es/p6592159",
      "rel": "HOMEAWAY_ES"
    },
    {
      "href": "https://www.homeaway.fi/loma-asunto/p6592159",
      "rel": "HOMEAWAY_FI"
    },
    {
      "href": "https://www.abritel.fr/location-vacances/p6592159",
      "rel": "ABRITEL"
    },
    {
      "href": "https://www.homeaway.it/affitto-vacanze/p6592159",
      "rel": "HOMEAWAY_IT"
    },
    {
      "href": "https://www.homeaway.nl/vakantiewoning/p6592159",
      "rel": "HOMEAWAY_NL"
    },
    {
      "href": "https://www.homeaway.no/feriebolig/p6592159",
      "rel": "HOMEAWAY_NO"
    },
    {
      "href": "https://www.aluguetemporada.com.br/imovel/p6592159",
      "rel": "HOMEAWAY_BR"
    },
    {
      "href": "https://www.homeaway.se/semesterhus/p6592159",
      "rel": "HOMEAWAY_SE"
    }
  ],
  "photos": {
    "photos": [
      {
        "caption": "sitting area with TV set",
        "small": {
          "dimension": {
            "height": 100,
            "width": 134
          },
          "uri": "http://imagesus.homeaway.com/mda01/305eee9b-d1e5-492e-beda-6922a4e21f13.1.1"
        },
        "medium": {
          "dimension": {
            "height": 270,
            "width": 361
          },
          "uri": "http://imagesus.homeaway.com/mda01/305eee9b-d1e5-492e-beda-6922a4e21f13.1.9"
        },
        "large": {
          "dimension": {
            "height": 663,
            "width": 1000
          },
          "uri": "http://imagesus.homeaway.com/mda01/305eee9b-d1e5-492e-beda-6922a4e21f13.1.10"
        },
        "originalDimension": {
          "height": 663,
          "width": 1000
        }
      },
      {
        "caption": "Living-room",
        "small": {
          "dimension": {
            "height": 100,
            "width": 134
          },
          "uri": "http://imagesus.homeaway.com/mda01/aa5586b7-7f3a-4d4e-b44e-b8c3951b3e36.1.1"
        },
        "medium": {
          "dimension": {
            "height": 270,
            "width": 361
          },
          "uri": "http://imagesus.homeaway.com/mda01/aa5586b7-7f3a-4d4e-b44e-b8c3951b3e36.1.9"
        },
        "large": {
          "dimension": {
            "height": 663,
            "width": 1000
          },
          "uri": "http://imagesus.homeaway.com/mda01/aa5586b7-7f3a-4d4e-b44e-b8c3951b3e36.1.10"
        },
        "originalDimension": {
          "height": 663,
          "width": 1000
        }
      },
      {
        "caption": "living-room",
        "small": {
          "dimension": {
            "height": 100,
            "width": 134
          },
          "uri": "http://imagesus.homeaway.com/mda01/6c5623d9-b612-485e-8a00-e9c1bee45743.1.1"
        },
        "medium": {
          "dimension": {
            "height": 270,
            "width": 361
          },
          "uri": "http://imagesus.homeaway.com/mda01/6c5623d9-b612-485e-8a00-e9c1bee45743.1.9"
        },
        "large": {
          "dimension": {
            "height": 663,
            "width": 1000
          },
          "uri": "http://imagesus.homeaway.com/mda01/6c5623d9-b612-485e-8a00-e9c1bee45743.1.10"
        },
        "originalDimension": {
          "height": 663,
          "width": 1000
        }
      },
      {
        "caption": "dining area",
        "small": {
          "dimension": {
            "height": 100,
            "width": 134
          },
          "uri": "http://imagesus.homeaway.com/mda01/2646c896-8b79-4f1e-874b-56c32d83e63b.1.1"
        },
        "medium": {
          "dimension": {
            "height": 270,
            "width": 361
          },
          "uri": "http://imagesus.homeaway.com/mda01/2646c896-8b79-4f1e-874b-56c32d83e63b.1.9"
        },
        "large": {
          "dimension": {
            "height": 663,
            "width": 1000
          },
          "uri": "http://imagesus.homeaway.com/mda01/2646c896-8b79-4f1e-874b-56c32d83e63b.1.10"
        },
        "originalDimension": {
          "height": 663,
          "width": 1000
        }
      },
      {
        "caption": "dining table",
        "small": {
          "dimension": {
            "height": 100,
            "width": 134
          },
          "uri": "http://imagesus.homeaway.com/mda01/39ed2cce-2bf0-4726-a059-207d7b0b3b42.1.1"
        },
        "medium": {
          "dimension": {
            "height": 270,
            "width": 361
          },
          "uri": "http://imagesus.homeaway.com/mda01/39ed2cce-2bf0-4726-a059-207d7b0b3b42.1.9"
        },
        "large": {
          "dimension": {
            "height": 663,
            "width": 1000
          },
          "uri": "http://imagesus.homeaway.com/mda01/39ed2cce-2bf0-4726-a059-207d7b0b3b42.1.10"
        },
        "originalDimension": {
          "height": 663,
          "width": 1000
        }
      },
      {
        "caption": "main bedroom",
        "small": {
          "dimension": {
            "height": 100,
            "width": 134
          },
          "uri": "http://imagesus.homeaway.com/mda01/62e4200c-47a5-4528-9daa-caa390a6de8d.1.1"
        },
        "medium": {
          "dimension": {
            "height": 270,
            "width": 361
          },
          "uri": "http://imagesus.homeaway.com/mda01/62e4200c-47a5-4528-9daa-caa390a6de8d.1.9"
        },
        "large": {
          "dimension": {
            "height": 663,
            "width": 1000
          },
          "uri": "http://imagesus.homeaway.com/mda01/62e4200c-47a5-4528-9daa-caa390a6de8d.1.10"
        },
        "originalDimension": {
          "height": 663,
          "width": 1000
        }
      },
      {
        "small": {
          "dimension": {
            "height": 100,
            "width": 134
          },
          "uri": "http://imagesus.homeaway.com/mda01/9c553f68-8f63-492b-825b-dd23bb654c50.1.1"
        },
        "medium": {
          "dimension": {
            "height": 270,
            "width": 361
          },
          "uri": "http://imagesus.homeaway.com/mda01/9c553f68-8f63-492b-825b-dd23bb654c50.1.9"
        },
        "large": {
          "dimension": {
            "height": 663,
            "width": 1000
          },
          "uri": "http://imagesus.homeaway.com/mda01/9c553f68-8f63-492b-825b-dd23bb654c50.1.10"
        },
        "originalDimension": {
          "height": 663,
          "width": 1000
        }
      },
      {
        "small": {
          "dimension": {
            "height": 100,
            "width": 134
          },
          "uri": "http://imagesus.homeaway.com/mda01/00f712bc-fa5b-41a9-8171-18d4aca0ab5a.1.1"
        },
        "medium": {
          "dimension": {
            "height": 270,
            "width": 361
          },
          "uri": "http://imagesus.homeaway.com/mda01/00f712bc-fa5b-41a9-8171-18d4aca0ab5a.1.9"
        },
        "large": {
          "dimension": {
            "height": 663,
            "width": 1000
          },
          "uri": "http://imagesus.homeaway.com/mda01/00f712bc-fa5b-41a9-8171-18d4aca0ab5a.1.10"
        },
        "originalDimension": {
          "height": 663,
          "width": 1000
        }
      },
      {
        "small": {
          "dimension": {
            "height": 100,
            "width": 66
          },
          "uri": "http://imagesus.homeaway.com/mda01/b871c0c8-95a0-4712-a709-82f439e88ca1.1.1"
        },
        "medium": {
          "dimension": {
            "height": 270,
            "width": 178
          },
          "uri": "http://imagesus.homeaway.com/mda01/b871c0c8-95a0-4712-a709-82f439e88ca1.1.9"
        },
        "large": {
          "dimension": {
            "height": 768,
            "width": 508
          },
          "uri": "http://imagesus.homeaway.com/mda01/b871c0c8-95a0-4712-a709-82f439e88ca1.1.10"
        },
        "originalDimension": {
          "height": 1000,
          "width": 662
        }
      },
      {
        "small": {
          "dimension": {
            "height": 100,
            "width": 66
          },
          "uri": "http://imagesus.homeaway.com/mda01/86d6177d-7b45-4a40-bf21-c97005055aa7.1.1"
        },
        "medium": {
          "dimension": {
            "height": 270,
            "width": 178
          },
          "uri": "http://imagesus.homeaway.com/mda01/86d6177d-7b45-4a40-bf21-c97005055aa7.1.9"
        },
        "large": {
          "dimension": {
            "height": 768,
            "width": 508
          },
          "uri": "http://imagesus.homeaway.com/mda01/86d6177d-7b45-4a40-bf21-c97005055aa7.1.10"
        },
        "originalDimension": {
          "height": 1000,
          "width": 662
        }
      },
      {
        "caption": "en-suite bathroom",
        "small": {
          "dimension": {
            "height": 100,
            "width": 66
          },
          "uri": "http://imagesus.homeaway.com/mda01/a14fbd64-6e4b-4fd6-843c-2cae4be83e8b.1.1"
        },
        "medium": {
          "dimension": {
            "height": 270,
            "width": 178
          },
          "uri": "http://imagesus.homeaway.com/mda01/a14fbd64-6e4b-4fd6-843c-2cae4be83e8b.1.9"
        },
        "large": {
          "dimension": {
            "height": 768,
            "width": 508
          },
          "uri": "http://imagesus.homeaway.com/mda01/a14fbd64-6e4b-4fd6-843c-2cae4be83e8b.1.10"
        },
        "originalDimension": {
          "height": 1000,
          "width": 662
        }
      },
      {
        "caption": "Bedroom 2",
        "small": {
          "dimension": {
            "height": 100,
            "width": 134
          },
          "uri": "http://imagesus.homeaway.com/mda01/cc65a2a1-e086-46c1-ad0c-985fc36a7a5b.1.1"
        },
        "medium": {
          "dimension": {
            "height": 270,
            "width": 361
          },
          "uri": "http://imagesus.homeaway.com/mda01/cc65a2a1-e086-46c1-ad0c-985fc36a7a5b.1.9"
        },
        "large": {
          "dimension": {
            "height": 663,
            "width": 1000
          },
          "uri": "http://imagesus.homeaway.com/mda01/cc65a2a1-e086-46c1-ad0c-985fc36a7a5b.1.10"
        },
        "originalDimension": {
          "height": 663,
          "width": 1000
        }
      },
      {
        "caption": "Bedroom 2",
        "small": {
          "dimension": {
            "height": 100,
            "width": 134
          },
          "uri": "http://imagesus.homeaway.com/mda01/f7975eca-8af8-46f1-a76a-014708b798c5.1.1"
        },
        "medium": {
          "dimension": {
            "height": 270,
            "width": 361
          },
          "uri": "http://imagesus.homeaway.com/mda01/f7975eca-8af8-46f1-a76a-014708b798c5.1.9"
        },
        "large": {
          "dimension": {
            "height": 663,
            "width": 1000
          },
          "uri": "http://imagesus.homeaway.com/mda01/f7975eca-8af8-46f1-a76a-014708b798c5.1.10"
        },
        "originalDimension": {
          "height": 663,
          "width": 1000
        }
      },
      {
        "caption": "bedroom 3",
        "small": {
          "dimension": {
            "height": 100,
            "width": 134
          },
          "uri": "http://imagesus.homeaway.com/mda01/4507fa88-b822-4963-ad3f-2a3da99a42b4.1.1"
        },
        "medium": {
          "dimension": {
            "height": 270,
            "width": 361
          },
          "uri": "http://imagesus.homeaway.com/mda01/4507fa88-b822-4963-ad3f-2a3da99a42b4.1.9"
        },
        "large": {
          "dimension": {
            "height": 663,
            "width": 1000
          },
          "uri": "http://imagesus.homeaway.com/mda01/4507fa88-b822-4963-ad3f-2a3da99a42b4.1.10"
        },
        "originalDimension": {
          "height": 663,
          "width": 1000
        }
      },
      {
        "caption": "bedroom 3",
        "small": {
          "dimension": {
            "height": 100,
            "width": 134
          },
          "uri": "http://imagesus.homeaway.com/mda01/b633c03f-33d4-4eab-b21e-a7591f790343.1.1"
        },
        "medium": {
          "dimension": {
            "height": 270,
            "width": 361
          },
          "uri": "http://imagesus.homeaway.com/mda01/b633c03f-33d4-4eab-b21e-a7591f790343.1.9"
        },
        "large": {
          "dimension": {
            "height": 663,
            "width": 1000
          },
          "uri": "http://imagesus.homeaway.com/mda01/b633c03f-33d4-4eab-b21e-a7591f790343.1.10"
        },
        "originalDimension": {
          "height": 663,
          "width": 1000
        }
      },
      {
        "caption": "bedroom 3",
        "small": {
          "dimension": {
            "height": 100,
            "width": 134
          },
          "uri": "http://imagesus.homeaway.com/mda01/5538bbff-98fc-4207-bec1-60126275f33b.1.1"
        },
        "medium": {
          "dimension": {
            "height": 270,
            "width": 361
          },
          "uri": "http://imagesus.homeaway.com/mda01/5538bbff-98fc-4207-bec1-60126275f33b.1.9"
        },
        "large": {
          "dimension": {
            "height": 663,
            "width": 1000
          },
          "uri": "http://imagesus.homeaway.com/mda01/5538bbff-98fc-4207-bec1-60126275f33b.1.10"
        },
        "originalDimension": {
          "height": 663,
          "width": 1000
        }
      },
      {
        "caption": "kitchen",
        "small": {
          "dimension": {
            "height": 100,
            "width": 134
          },
          "uri": "http://imagesus.homeaway.com/mda01/c05225d1-a45a-4537-bddb-d9d6998a5652.1.1"
        },
        "medium": {
          "dimension": {
            "height": 270,
            "width": 361
          },
          "uri": "http://imagesus.homeaway.com/mda01/c05225d1-a45a-4537-bddb-d9d6998a5652.1.9"
        },
        "large": {
          "dimension": {
            "height": 663,
            "width": 1000
          },
          "uri": "http://imagesus.homeaway.com/mda01/c05225d1-a45a-4537-bddb-d9d6998a5652.1.10"
        },
        "originalDimension": {
          "height": 663,
          "width": 1000
        }
      },
      {
        "caption": "kitchen",
        "small": {
          "dimension": {
            "height": 100,
            "width": 134
          },
          "uri": "http://imagesus.homeaway.com/mda01/f0b45dcb-2244-4e20-9b6f-258b7bc27f65.1.1"
        },
        "medium": {
          "dimension": {
            "height": 270,
            "width": 361
          },
          "uri": "http://imagesus.homeaway.com/mda01/f0b45dcb-2244-4e20-9b6f-258b7bc27f65.1.9"
        },
        "large": {
          "dimension": {
            "height": 663,
            "width": 1000
          },
          "uri": "http://imagesus.homeaway.com/mda01/f0b45dcb-2244-4e20-9b6f-258b7bc27f65.1.10"
        },
        "originalDimension": {
          "height": 663,
          "width": 1000
        }
      },
      {
        "caption": "kitchen",
        "small": {
          "dimension": {
            "height": 100,
            "width": 134
          },
          "uri": "http://imagesus.homeaway.com/mda01/76dcdc2b-b328-408a-b16e-060437c0740c.1.1"
        },
        "medium": {
          "dimension": {
            "height": 270,
            "width": 361
          },
          "uri": "http://imagesus.homeaway.com/mda01/76dcdc2b-b328-408a-b16e-060437c0740c.1.9"
        },
        "large": {
          "dimension": {
            "height": 663,
            "width": 1000
          },
          "uri": "http://imagesus.homeaway.com/mda01/76dcdc2b-b328-408a-b16e-060437c0740c.1.10"
        },
        "originalDimension": {
          "height": 663,
          "width": 1000
        }
      },
      {
        "caption": "Hall",
        "small": {
          "dimension": {
            "height": 100,
            "width": 66
          },
          "uri": "http://imagesus.homeaway.com/mda01/c6b9063e-8574-44a6-9cfd-c851e1cb1b3b.1.1"
        },
        "medium": {
          "dimension": {
            "height": 270,
            "width": 178
          },
          "uri": "http://imagesus.homeaway.com/mda01/c6b9063e-8574-44a6-9cfd-c851e1cb1b3b.1.9"
        },
        "large": {
          "dimension": {
            "height": 768,
            "width": 508
          },
          "uri": "http://imagesus.homeaway.com/mda01/c6b9063e-8574-44a6-9cfd-c851e1cb1b3b.1.10"
        },
        "originalDimension": {
          "height": 1000,
          "width": 662
        }
      },
      {
        "caption": "shower room 2",
        "small": {
          "dimension": {
            "height": 100,
            "width": 66
          },
          "uri": "http://imagesus.homeaway.com/mda01/0e60bb70-0f9d-4e86-9426-f43b58151ad3.1.1"
        },
        "medium": {
          "dimension": {
            "height": 270,
            "width": 178
          },
          "uri": "http://imagesus.homeaway.com/mda01/0e60bb70-0f9d-4e86-9426-f43b58151ad3.1.9"
        },
        "large": {
          "dimension": {
            "height": 768,
            "width": 508
          },
          "uri": "http://imagesus.homeaway.com/mda01/0e60bb70-0f9d-4e86-9426-f43b58151ad3.1.10"
        },
        "originalDimension": {
          "height": 1000,
          "width": 662
        }
      },
      {
        "small": {
          "dimension": {
            "height": 100,
            "width": 66
          },
          "uri": "http://imagesus.homeaway.com/mda01/393cd801-b796-45a6-b18e-a4a2a898895d.1.1"
        },
        "medium": {
          "dimension": {
            "height": 270,
            "width": 178
          },
          "uri": "http://imagesus.homeaway.com/mda01/393cd801-b796-45a6-b18e-a4a2a898895d.1.9"
        },
        "large": {
          "dimension": {
            "height": 768,
            "width": 508
          },
          "uri": "http://imagesus.homeaway.com/mda01/393cd801-b796-45a6-b18e-a4a2a898895d.1.10"
        },
        "originalDimension": {
          "height": 1000,
          "width": 662
        }
      },
      {
        "small": {
          "dimension": {
            "height": 100,
            "width": 66
          },
          "uri": "http://imagesus.homeaway.com/mda01/fc3d6fa9-f8d3-49de-af8e-1f01d06ad989.1.1"
        },
        "medium": {
          "dimension": {
            "height": 270,
            "width": 178
          },
          "uri": "http://imagesus.homeaway.com/mda01/fc3d6fa9-f8d3-49de-af8e-1f01d06ad989.1.9"
        },
        "large": {
          "dimension": {
            "height": 768,
            "width": 508
          },
          "uri": "http://imagesus.homeaway.com/mda01/fc3d6fa9-f8d3-49de-af8e-1f01d06ad989.1.10"
        },
        "originalDimension": {
          "height": 1000,
          "width": 662
        }
      }
    ],
    "thumbnails": [
      {
        "photo": {
          "caption": "sitting area with TV set",
          "small": {
            "dimension": {
              "height": 100,
              "width": 134
            },
            "uri": "http://imagesus.homeaway.com/mda01/305eee9b-d1e5-492e-beda-6922a4e21f13.1.1"
          },
          "medium": {
            "dimension": {
              "height": 270,
              "width": 361
            },
            "uri": "http://imagesus.homeaway.com/mda01/305eee9b-d1e5-492e-beda-6922a4e21f13.1.9"
          },
          "large": {
            "dimension": {
              "height": 663,
              "width": 1000
            },
            "uri": "http://imagesus.homeaway.com/mda01/305eee9b-d1e5-492e-beda-6922a4e21f13.1.10"
          },
          "originalDimension": {
            "height": 663,
            "width": 1000
          }
        },
        "unitNumber": 2052470
      }
    ]
  },
  "units": [
    {
      "unitNumber": 2052470,
      "unitContent": {
        "area": 115,
        "areaUnit": "METERS_SQUARED",
        "bathrooms": [
          {
            "amenities": [
              {
                "count": 1,
                "category": "AMENITY",
                "description": "Toilet",
                "localizedName": "toilet"
              }
            ],
            "name": "Toilet 1",
            "roomSubType": "NO_TUB_OR_SHOWER"
          },
          {
            "amenities": [
              {
                "count": 1,
                "category": "AMENITY",
                "description": "Shower",
                "localizedName": "shower"
              }
            ],
            "name": "Shower room 1",
            "roomSubType": "SHOWER_INDOOR_OR_OUTDOOR"
          },
          {
            "amenities": [
              {
                "count": 1,
                "category": "AMENITY",
                "description": "Shower",
                "localizedName": "shower"
              }
            ],
            "name": "Shower room 2",
            "roomSubType": "SHOWER_INDOOR_OR_OUTDOOR"
          }
        ],
        "bedrooms": [
          {
            "amenities": [],
            "name": "Bedroom 1",
            "roomSubType": "BEDROOM"
          },
          {
            "amenities": [],
            "name": "Bedroom 2",
            "roomSubType": "BEDROOM"
          },
          {
            "amenities": [],
            "name": "Bedroom 3",
            "roomSubType": "BEDROOM"
          }
        ],
        "maxSleep": 6,
        "maxSleepInBeds": 4,
        "numberOfBathrooms": 3,
        "numberOfBedrooms": 3,
        "propertyType": "apartment",
        "features": [
          {
            "count": 1,
            "category": "GENERAL",
            "description": "air-conditioning",
            "localizedName": "Air Conditioning"
          },
          {
            "count": 1,
            "category": "GENERAL",
            "description": "linen provided",
            "localizedName": "Linens Provided"
          },
          {
            "count": 1,
            "category": "KITCHEN",
            "description": "dish washer",
            "localizedName": "Dishwasher"
          },
          {
            "count": 1,
            "category": "KITCHEN",
            "description": "fridge",
            "localizedName": "Refrigerator"
          },
          {
            "count": 1,
            "category": "KITCHEN",
            "description": "freezer",
            "localizedName": "Freezer"
          },
          {
            "count": 1,
            "category": "KITCHEN",
            "description": "hob",
            "localizedName": "Stove"
          },
          {
            "count": 1,
            "category": "KITCHEN",
            "description": "oven",
            "localizedName": "Oven"
          },
          {
            "count": 1,
            "category": "KITCHEN",
            "description": "microwave",
            "localizedName": "Microwave"
          },
          {
            "count": 1,
            "category": "GENERAL",
            "description": "washing machine",
            "localizedName": "Washing Machine"
          },
          {
            "count": 1,
            "category": "ENTERTAINMENT",
            "description": "tv",
            "localizedName": "Television"
          },
          {
            "count": 1,
            "category": "ENTERTAINMENT",
            "description": "stereo system",
            "localizedName": "Stereo"
          },
          {
            "count": 1,
            "category": "OUTSIDE",
            "description": "balcony",
            "localizedName": "Balcony"
          },
          {
            "count": 1,
            "category": "SUITABILITY",
            "description": "pets not allowed",
            "localizedName": "pets not allowed"
          },
          {
            "count": 1,
            "category": "DINING",
            "description": "dining room",
            "localizedName": "Dining Room"
          },
          {
            "count": 1,
            "category": "SUITABILITY",
            "description": "children welcome",
            "localizedName": "children welcome"
          },
          {
            "count": 1,
            "category": "GENERAL",
            "description": "internet access",
            "localizedName": "Internet"
          },
          {
            "count": 1,
            "category": "SUITABILITY",
            "description": "non smoking only",
            "localizedName": "non smoking only"
          },
          {
            "count": 1,
            "category": "GENERAL",
            "description": "wireless broadband",
            "localizedName": "Wireless Internet"
          },
          {
            "count": 1,
            "category": "KITCHEN",
            "description": "coffeemaker",
            "localizedName": "Coffee Maker"
          },
          {
            "count": 1,
            "category": "GENERAL",
            "description": "HasElevator",
            "localizedName": "Elevator"
          },
          {
            "count": 1,
            "category": "GENERAL",
            "description": "Living room",
            "localizedName": "Living Room"
          },
          {
            "count": 1,
            "category": "KITCHEN",
            "description": "Full Kitchen",
            "localizedName": "Kitchen"
          },
          {
            "count": 1,
            "category": "SUITABILITY",
            "description": "Handicapped Accessible (may have limitations)",
            "localizedName": "limited accessibility"
          },
          {
            "count": 1,
            "category": "KITCHEN",
            "description": "Kettle",
            "localizedName": "Kettle"
          }
        ]
      },
      "reviewSummary": {
        "reviewCount": 1,
        "averageRating": 4,
        "oneStarReviewCount": 0,
        "twoStarReviewCount": 0,
        "threeStarReviewCount": 0,
        "fourStarReviewCount": 1,
        "fiveStarReviewCount": 0,
        "guestbookReviewCount": 0
      },
      "unitReviewContent": {
        "size": 1,
        "page": 1,
        "entries": [
          {
            "arrivalDate": "2015-09-24T00:00:00.000Z",
            "reviewerName": "",
            "body": "appartement agréable ,très bien situé avec une station de métro au pas de la porte .Location propre ,bonne literie .Espace tout à fait correct pour 6 personnes.\nLa rue est assez bruyante la nuit .Un petit bémol  dans l'équipement: une minuscule cafetière obligeant à faire le café en 2 ou 3 fois .\nLocation à recommander .bonne impression générale.",
            "headline": "7/10",
            "helpfulCount": 0,
            "unhelpfulCount": 0,
            "reviewLocale": "fr_FR"
          }
        ]
      },
      "ratePeriods": [
        {
          "dateRange": {
            "beginDate": "2014-01-25",
            "endDate": "2014-03-13"
          },
          "minimumStay": 7,
          "rates": {
            "weekly": {
              "currency": "EUR",
              "amount": 750
            }
          }
        },
        {
          "dateRange": {
            "beginDate": "2014-03-22",
            "endDate": "2014-04-09"
          },
          "minimumStay": 7,
          "rates": {
            "weekly": {
              "currency": "EUR",
              "amount": 750
            }
          }
        },
        {
          "dateRange": {
            "beginDate": "2014-04-11",
            "endDate": "2014-04-20"
          },
          "minimumStay": 7,
          "rates": {
            "weekly": {
              "currency": "EUR",
              "amount": 900
            }
          }
        },
        {
          "dateRange": {
            "beginDate": "2014-04-22",
            "endDate": "2014-06-29"
          },
          "minimumStay": 7,
          "rates": {
            "weekly": {
              "currency": "EUR",
              "amount": 850
            }
          }
        },
        {
          "dateRange": {
            "beginDate": "2014-07-01",
            "endDate": "2014-08-30"
          },
          "minimumStay": 7,
          "rates": {
            "weekly": {
              "currency": "EUR",
              "amount": 900
            }
          }
        },
        {
          "dateRange": {
            "beginDate": "2014-09-01",
            "endDate": "2014-12-17"
          },
          "minimumStay": 7,
          "rates": {
            "weekly": {
              "currency": "EUR",
              "amount": 750
            }
          }
        },
        {
          "dateRange": {
            "beginDate": "2014-12-19",
            "endDate": "2015-01-05"
          },
          "minimumStay": 7,
          "rates": {
            "weekly": {
              "currency": "EUR",
              "amount": 1200
            }
          }
        }
      ],
      "unitAvailability": {
        "availabilityDefault": "Y",
        "changeOverDefault": "C",
        "dateRange": {
          "beginDate": "2015-10-16",
          "endDate": "2018-10-15"
        },
        "maxStayDefault": 0,
        "minPriorNotifyDefault": 1,
        "minStayDefault": 0,
        "stayIncrementDefault": "D",
        "unitAvailabilityConfiguration": {
          "availability": "NNNNNNNNNYNNNNNNNYYYNNNNNNNYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYNNNNNNNYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYNNNNNNNNNNNNYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY",
          "availableUnitCount": null,
          "changeOver": "XXXXXXXXXXOXXXXXXIOOOXXXXXXICCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCOOOOOOOXXXXXXICCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCOOOXXXXXXXXXXXICCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC",
          "maxStay": "0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0",
          "minPriorNotify": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1",
          "minStay": "3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3",
          "stayIncrement": "DDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD"
        }
      }
    }
  ]
}

GET /public/listingReviews

Supports locale query param / header? no

Requires user-based token? no

Returns a page of reviews for the specified listing and unit

This operation will return a page of reviews. Typically this operation is entered from the details of a listing. If the listing has more than the first page of reviews available, then it will contain a next page url. That url will leverage this operation to fetch the next page of reviews.

The result returned from this operation will return the list of reviews as well as previous and next page urls.

NOTE: Reviews less than 30 days old will not show up in the collection.


Resource URL

https://ws.homeaway.com/public/listingReviews

Query Parameters

Name Description Required?
pageSize The number of reviews to return per page no
unitId The id of the unit being booked for the stay yes
page The page number to fetch no
listingId The listing id to be booked as retrieved from the search operation yes

Response Info

Type:

UnitReviewPaginator

Example:

{  
   "nextPage":"https://ws.homeaway.com/public/listingReviews?listingId=100000&unitId=386884&pageSize=2&page=2",
   "pageSize":2,
   "size":23,
   "page":1,
   "entries":[  
      {  
         "arrivalDate":"2009-01-04T00:00:00.000Z",
         "reviewerName":"Jane Smith",
         "body":"We were in town for a festival and stayed here for two nights.  Place was great!",
         "headline":"Had a great time",
         "helpfulCount":0,
         "unhelpfulCount":0,
         "reviewLocale":"en_US"
      },
      {  
         "arrivalDate":"2010-12-17T00:00:00.000Z",
         "reviewerName":"Nick",
         "body":"We enjoyed a great week here, really couldn't have been more impressed with the house. It absolutely feels like the owners have put a lot of effort into making it feel like a home from home. Bedrooms are spacious and well appointed, living areas are clean, comfortable and  superbly decorated.\r\n\r\nIts a great location too, the neighbourhood is very friendly, and its a ten minute drive into downtown Austin.\r\n",
         "headline":"Look no further!",
         "helpfulCount":1,
         "unhelpfulCount":1,
         "reviewLocale":"en_US"
      }
   ]
}

GET /public/listingReview

Supports locale query param / header? no

Requires user-based token? no

Returns a listing review for the given id


Resource URL

https://ws.homeaway.com/public/listingReview

Query Parameters

Name Description Required?
id The id of the review. yes

Response Info

Type:

ListingUnitReview

Example:

{
  "arrivalDate": "2016-04-07T00:00:00.000Z",
  "reviewerName": "Cade Parker",
  "body": "This place soooooooooooo cool.",
  "headline": "Excellent property",
  "helpfulCount": 6,
  "unhelpfulCount": 1,
  "reviewLocale": "en",
  "reviewId": "238a4c38-4bce-47fd-b6f9-31cac27963d6"
}