Retrieve hotel reviews by IDs

ETG API V3

Content API

🆕

The Sandbox environment is available exclusively to new partners who begin their integration in Q4 2025.

https://api.worldota.net/api/content/v1/hotel_reviews_by_ids

In this call can get reviews on the requested hotel IDs.

ℹ️

Use this call instead of call Retrieve hotel reviews’ dump.
Use this call after Retrieve hotels content by IDs.

Sandbox limitations

⚠️

Use only field values, IDs, API keys, and any static content from the sandbox environment within the sandbox. Do not use sandbox data in test or production environments, and do not mix data or configuration between different environments.

Request example

ℹ️

Only one of HIDs or IDs can be specified in the request.

curl --user '<KEY_ID>:<API_KEY>' 'https://api.worldota.net/api/content/v1/hotel_reviews_by_ids/' \
--header 'Content-Type: application/json' \
--data '{
    "language": "en",
    "hids": [6905392]
}'

curl --user '<KEY_ID>:<API_KEY>' 'https://api.worldota.net/api/content/v1/hotel_reviews_by_ids/' \
--header 'Content-Type: application/json' \
--data '{
  "ids": [
      "hostellerie_du_marais"
    ]
  "language": "en"
}'

Request body

Expand this| Collapse this

hids [Int]

A list of unique hotel IDs in the new numeric format.

ℹ️

Each ID is an integer no longer than 10 digits.
We are gradually migrating all clients to use this format.
Use the hids field from the call Retrieve hotel IDs by filter.

ids [String]

A list of unique hotel IDs in the legacy string format.

language String required

The language.

ℹ️

Use the value field from the call Retrieve filter values.

Response

Expand this| Collapse this

id String

The unique hotel ID in the legacy string format.

hid Int

The unique hotel IDs in the new numeric format.

review [Object]

A list of user reviews about the hotel.

id int

Unique review identifier.

review_plus String

Positive comment, highlighting what the guest liked during their stay.

review_minus String

Negative comment, describing what the guest disliked during their stay.

created String

Date and time when the review was submitted.

author String

Name of the guest who left the review.

adults Int

Number of adults staying in the room for the reviewed booking.

children Int

Number of children staying in the room for the reviewed booking.

room_name String

The name and description of the room that was booked.

nights Int

Number of nights the guest stayed.

images [String]

The list of the URLs for the hotel images.

ℹ️

The recommended method for displaying these images in our UI (e.g., direct linking to the provided URLs).
We do not block users arbitrarily; restrictions are only applied in case of suspected DDoS attacks.
Each URL has the {size} placeholder. Meaning, the size of the image you can get.
- The possible size meanings:
  - crop — the image is fit by the width and is cut equally from the bottom and top till the middle part of the height.
  - fit-h — the image is fit into the rectangle by the height.
  - fit-w — the image is scaled so that its width fits the given value, and the height is adjusted proportionally.
  - fit-w-min — the image is scaled so that its width is at least the specified value (if it’s smaller, it is enlarged; if it’s larger, it is reduced), while the height is adjusted proportionally. No cropping occurs.
  - fit — the image is fit into the rectangle by the size in question.
- The possible values:
  - 1024x768 — fit.
  - x220 — fit-h.
  - x500 — fit-h.
  - x768 — fit-h.
  - 40x40 — crop.
  - 80x80 — crop.
  - 100x100 — crop.
  - 120x120 — crop.
  - 241x241 — crop.
  - 240x240 — crop.
  - 154x105 — crop.
  - 170x154 — crop.
  - 640x350 — crop.
  - 320x175 — crop.
  - 200x200 — crop.
  - 1080x522 — crop.
  - 750x400 — crop.
  - 640x400 — crop.
  - 120x90 — crop.
  - 90x75 — crop.
  - x300 — fit-h.
  - x600 — fit-h.
  - 100x130 — crop.
  - x296 — fit-h.
  - 100x50 — crop.
  - x100 — fit-h.
  - 100x — fit-w.
  - 640x230 — crop.
  - 370x — fit-w.
  - 645x255 — crop.
  - 450x161 — crop.
  - x102 — fit-h.
  - 225x60 — fit.
  - 828x560 — fit.
  - 640x640 — crop.
  - 196x196 — crop.
  - 1298x — fit-w.
  - 295x220 — crop.
  - 2048x2048 — crop.
  - 304x — fit-w.
  - 304x140 — crop.
  - x700 — fit-h.
  - 112x112 — crop.
  - 695x — fit-w-min.
  - 1300x620 — fit-w.
  - 2600x1240 — fit-w.
  - 600x313 — fit-w.
  - 1200x616 — fit-w.
  - 326x220 — fit-w.
  - 768x1024 — fit-h.
  - 900x900 — crop.
  - 1920x1080 — fit.
  - 1080x1920 — fit-h.
  - x1080 — fit-h.
  - x1920 — fit-h.
  - 1920x — fit-w.
  - 1080x — fit-w.

detailed_review [Object]

Detailed ratings for different aspects of the stay (see subfields below).

cleanness Int

Guest rating of the cleanliness.

ℹ️

The minimum value is 0.
The maximum value is 10.

location Int

Guest rating of the location.

ℹ️

The minimum value is 0.
The maximum value is 10.

price Int

Value for money rating.

ℹ️

The minimum value is 0.
The maximum value is 10.

services Int

Rating of the provided services.

ℹ️

The minimum value is 0.
The maximum value is 10.

room Int

Rating of the room itself.

ℹ️

The minimum value is 0.
The maximum value is 10.

meal Int

Rating of the meals.

ℹ️

The minimum value is 0.
The maximum value is 10.

wifi String

Guest’s feedback on the Wi-Fi; may be unspecified if not reviewed.

hygiene String

Guest’s feedback on hygiene; may be unspecified if not reviewed.

traveller_type String

Type of traveller (e.g., solo, couple, family, or unspecified if not provided).

trip_type String

Type of trip, such as leisure or business.

rating Int

The hotel rating on a scale from 1 to 5. Has the 0 value for no available rating.

ℹ️

The minimum value is 0.
The maximum value is 5.

Response example

{
  "data": [
    {
      "id": "hostellerie_du_marais",
      "hid": 6905392,
      "reviews": [
        {
          "id": 418560,
          "review_plus": "Yes Place des Vosges\r\nBreakfast was a variety of croissant’s, baguettes, bakery pieces, juice, cafe, cheese, ham, yogurt and fruit.\r\nThe room was comfortable, great view over the rooftops where you could watch the sunset.  Very clean.\r\nYes very clean and a central area for coffee and afternoon drinks.\r\nGreat welcome, service, and looking after you.  Any issue or question that arose addressed quickly and professionally.   Felt like a family looking after you.",
          "review_minus": "",
          "created": "2022-05-09 10:27:57.030573+00",
          "author": "Linda",
          "adults": 1,
          "children": 0,
          "room_name": "Standard Single room",
          "nights": 7,
          "images": null,
          "detailed_review": {
            "cleanness": 9,
            "location": 10,
            "price": 10,
            "services": 10,
            "room": 9,
            "meal": 10,
            "wifi": "perfect",
            "hygiene": "unspecified"
          },
          "traveller_type": "solo_travel",
          "trip_type": "leisure",
          "rating": 9.7
        }
      ]
    }
  ],
  "debug": {
    "api_endpoint": {
      "endpoint": "",
      "is_active": false,
      "is_limited": false,
      "remaining": 0,
      "requests_number": 0,
      "reset": "",
      "seconds_number": 0
    },
    "request": {
      "language": "en",
      "hids": [
        6905392
      ]
    },
    "method": "",
    "real_ip": "",
    "request_id": "",
    "key_id": 0,
    "api_key_id": 0,
    "utcnow": ""
  },
  "status": "ok",
  "error": null
}

Errors

The error field has the value specified in the headers below.

`invalid_params`

One or more input parameters are incorrect. For more details, see the response field debug validation_error.

`no_hotel_reviews`

An internal search error. Has 500 status code.