Content References API

The Content References API helps you better understand Rapid property content.

Property information (including amenities or services available at property or room level, value adds, and rate amenities) provided in the Rapid Content APIs are represented by numerical IDs. Use the Content References API to self-serve lists of attribute IDs and their meanings.

Reference details

|

Amenities

Amenities represent the features or services available to travelers.

In the Rapid Content APIs, we provide the id, localized name, and the explicit value (when applicable) of each amenity within the amenities object.

Amenities are available at the property, room, and rate plan level and are complimentary unless a surcharge or restriction is specified.

  • Property level: Amenities available to all travelers.
  • Room level: Amenities applicable only to the associated room.
  • Rate level: Amenities applicable only to the associated rate plan.

Look for the amenities_property, amenities_rooms and amenities_rates objects.

Each amenity contains 3 fields:

  • id
  • name
  • has_value

Content API response example:

"amenities": {
    "9": {
        "id": 9,
        "name": "Fitness facilities"
    },
    "2820": {
        "id": 2820,
        "name": "Number of indoor pools -",
        "value": 10
    }
},

Amenity categories

Amenity categories allow the grouping of related amenities for display, search, or filtering.

In the Rapid Content APIs the categories object describes the category that an amenity fits into. This lets you more easily group related amenities for display, search, or filtering.


Content API response example:

{
  "12345": {
    "property_id": "12345",
    ...
    "amenities": {
      "2070": {
        "id": "2070",
        "name": "Dry cleaning/laundry service",
        "categories": [
          "drycleaning_and_laundry_services"
        ]
      }
    }
  }
}

Available categories

  • accessibility
  • accessible_parking
  • accessible_wheelchair
  • air_conditioning
  • airport_transfer
  • all_inclusive
  • bar
  • casino
  • crib
  • dry_cleaning_laundry
  • dryer
  • electric_charging_station
  • free_airport_transfer
  • free_all_meals
  • free_breakfast
  • free_breakfast_1_or_2_guests
  • free_dinner
  • free_lunch
  • free_wifi
  • gym
  • hot_tub
  • kitchen
  • meeting_facility
  • ocean_view
  • parking
  • pets_allowed
  • spa_services
  • swimming_pool
  • washer
  • water_park
  • wifi

Attributes

Attributes represent policies and features applicable to the property and the stay.

In the Rapid Content APIs, we provide the id, localized name, and the explicit value (when applicable) of the attribute within the attributes object.

Attributes are available at the property level and represent policies and features applicable to the property and the stay.

  • general: General policies that apply to the property.
  • pets: Pet policies that apply to the property.

Look for the attributes_general and attributes_pets objects.

Each attribute contains 3 fields:

  • id
  • name
  • has_value

Content API response example:

"attributes": {
    "general": {
        "2549": {
          "id": 2549,
          "name": "No elevators"
        },
        "3357": {
          "id": 3357,
          "name": "Caters to adults only"
        }
    },
    "pets": {
        "51": {
          "id": 51,
          "name": "Pets allowed"
        },
        "2809": {
          "id": 2809,
          "name": "Dogs only"
        }
    }
},

Category

Each property is associated with only one property category which represents the type of property.

In the Rapid Content APIs, we provide both the id and name of the property category within the category object.

Each property is associated with only one property category which represents the type of property being offered.

Look for the category object.

Each category contains 2 fields:

  • id
  • name

Content API response example:

"category": {
    "id": 1,
    "name": "Hotel"
},

The property category list is provided below for quick reference.

idname
0Property
1Hotel
2Motel
3Resort
4Inn
5Bed & Breakfast
6Guesthouse
7Condo
8All-Inclusive Property
9Cabin
10Chalet
11Cottage
12Hostel/Backpacker Accommodation
13Ranch
14Villa
15Lodge
16Apartment
17Private Vacation Home
18Houseboat
20Ryokan
21Tree House Property
22Aparthotel
23Condominium Resort
24Campsite
25Riad
26Hostal
29Country House
30Pension
31Pousada (Portugal)
32Pousada (Brazil)
33Residence
34Affittacamere
36Castle
37Safari/Tentalow
39Palace
40Agritourism Property
41Cruise
42Holiday Park
43Capsule hotel
44Mobile home

Chain references

Property chains represent a parent company which can have multiple brands associated with it.

In the Rapid Content API, we provide a chain reference mapping of all recognized chains.

Each property is associated with only one brand, which has a parent chain.


Content API response example:

"chain": {
      "id": -6,
      "name": "Hyatt Hotels"
    },
    "brand": {
      "id": 2209,
      "name": "Hyatt Place"
    },

Images

Images are organized by category, based on the area of the property depicted in the image.

In the Rapid Content APIs, we provide the category ID in the category field and the category name in the caption field for each property image. Room images also have captions.

Look for the images object.

Each image category contains 2 fields:

  • id
  • name

Content API response example:

"images": [
    {
        "caption": "Featured Image",
        "hero_image": true,
        "category": 3,
        "links": {
            "350px": {
                "method": "GET",
                "href": "https://i.travelapi.com/hotels/1000000/10000/100/1/5a329959_b.jpg"
            },
            "70px": {
                "method": "GET",
                "href": "https://i.travelapi.com/hotels/1000000/10000/100/1/5a329959_t.jpg"
            },
            "1000px": {
                "method": "GET",
                "href": "https://i.travelapi.com/hotels/1000000/10000/100/1/5a329959_z.jpg"
            }
        }
    },
]

Onsite payment types

Onsite payment types represent the forms of payment accepted for charges incurred or due at the property.

In the Rapid Content APIs, we provide the id and localized name of the onsite payment types within the types object, which is in the onsite_payments object.

Onsite payment types are available at the property level and represent forms of payments accepted for charges incurred or due at the property.

Look for the onsite_payment_types object.

Each payment type contains 2 fields:

  • id
  • name

Content API response example:

"onsite_payments": {
    "currency": "USD",
    "types": {
        "171": {
          "id": 171,
          "name": "American Express"
        }
    }
},

Statistics

Statistics represent property-level information such as number of floors or number of rooms.

In the Rapid Content APIs, we provide the id, localized name, and the explicit value (when applicable) of the statistic within the statistics object.

Statistics are available at the property level and represent data such as number of floors and number of rooms.

Look for the statistics object.

Each statistic contains 3 fields:

  • id
  • name
  • value

Content API response example:

"statistics": {
    "52": {
        "id": 52,
        "name": "Total number of rooms -",
        "value": "820"
    },
    "54": {
        "id": 54,
        "name": "Number of floors -",
        "value": "38"
    }
},

Themes

Themes represent the type of traveler typically targeted or vibe of a property.

In the Rapid Content APIs, we provide both the id and localized name of the theme within the themes object.

Themes are available at the property level and represent the type of traveler typically targeted or vibe of a property. A property can be associated with more than one theme but not all properties have a theme.

Look for the themes object.

Each theme contains 2 fields:

  • id
  • name

Content API response example:

"themes": {
    "2337": {
        "id": 2337,
        "name": "Luxury Hotel"
    },
    "2341": {
        "id": 2341,
        "name": "Spa Hotel"
    }
},

Room views

Room views represent the view available from a given room.

In the Rapid Content APIs we provide the id and localized name of the view available from the views object.

Look for the room_views object.

Each views contains 2 fields:

  • id
  • name

Content API response example:

"views": {
          "4146": {
            "id": 4146,
            "name": "Courtyard view"
          }
        },

Spoken languages

Spoken languages represent the languages that are spoken by the property staff.

In the Rapid Content APIs we provide the id and localized name of the language spoken from the spoken_languages object.

Look for the spoken_languages object.

Each language contains 2 fields:

  • id
  • name

Content API response example:

"spoken_languages": {
      "vi": {
        "id": "vi",
        "name": "Vietnamese"
      }
    },
Was this page helpful?
How can we improve this content?
Thank you for helping us improve!