Content API search and response filtering

Easily search and filter the Content API response for more targeted results.

Partners can use the search and filter functionality for Rapid Content to control what property information they receive in the Content response. This allows partners to streamline their data from Rapid and access only the information they need for their customers, meaning reduced costs and more flexibility.

Search

Search for properties offering a particular amenity or service to guests, e.g. look for properties offering enhanced sustainability features.

Rapid partners are able to search by property-level elements including:

• category_id - Categories
• all_inclusive - All inclusive status
• attribute_id - Attributes
• amenity_id - Property level Amenities
• spoken_language_id - Spoken Languages

Note: This functionality does not include specific room or rate plan elements.

Rapid 3 Request Example: In this example we're using the new amenity_id search parameter to limit which properties are returned.

curl -X GET "https://test.ean.com/v3/properties/content\
?language=en-US\
&supply_source=expedia\
&amenity_id=115\
&include=property_id\
&property_id=1337\
&property_id=1" \
 -H "accept: application/json, application/json"\
 -H "accept-encoding: gzip"\
 -H "authorization: EAN apikey=abcd1234,signature=090a77e7ddd7779980231,timestamp=1697664047"\
 -H "user-agent: TravelNow/3.30.112"

Rapid 3 Response Example: In this response, we can see that only property 1337 is returned, because property 1 does not have amenity id 115 available.

{
  "1337": {
    "property_id": "1337"
  }
}

For a full list of available attributes, amenities, spoken languages, and categories see the content reference lists.

Filter

Request a portion of the Rapid Content response without receiving full property details. Partners are able to request only the top-level section(s) of the Content API response needed. This can be requested via the include parameter and results will include only the property_id and requested sections per property.

Available sections for filtering currently include the below.

Note: This list should not be considered exhaustive as the filter functionality will also apply to any new top level sections added in the future.

• property_id
• name
• address
• ratings
• location
• phone
• fax
• category
• rank
• business_model
• checkin
• checkout
• fees
• policies
• attributes
• amenities
• images
• onsite_payments
• rooms
• rates
• dates
• descriptions
• statistics
• airports
• themes
• all_inclusive
• tax_id
• chain
• brand
• spoken_languages
• multi_unit
• payment_registration_recommended
• supply_source
• vacation_rental_details

Rapid 3 Request Example: In this example we're using the new values of name and amenities in the include parameter.

curl -X GET "https://test.ean.com/v3/properties/content\
?language=en-US\
&supply_source=expedia\
&include=name\
&include=amenities\
&property_id=1337" \
 -H "accept: application/json, application/json"\
 -H "accept-encoding: gzip"\
 -H "authorization: EAN apikey=abcd1234,signature=090a77e7ddd7779980231,timestamp=1697664047"\
 -H "user-agent: TravelNow/3.30.112"

Rapid 3 Response Example: In this response, we can see that property_id, name, and amenities are included in the response. property_id is always included in the response, and does not need to be specified as an include request parameter unless it is the only field desired in the response. (Note: list of amenities truncated to keep the example concise)

{
  "1337": {
    "property_id": "1337",
    "name": "Hyatt Regency Paris Etoile",
    "amenities": {
      "8": {
        "id": "8",
        "name": "Elevator"
      },
      "43": {
        "id": "43",
        "name": "Concierge services"
      },
      "115": {
        "id": "115",
        "name": "Bicycle rentals nearby"
      },
      "361": {
        "id": "361",
        "name": "Breakfast available (surcharge)"
      },
      ...
    }
  }
}