For the complete documentation index, see llms.txt. This page is also available as Markdown.

Fetch Reviews

The Reviews endpoint retrieves reviews for a specific hotel.

GET https://api.rateparity.com/v1/reviews/{code}

Query Parameters

Filtering is supported to refine the results based on the below criteria.

Name
Type
Description

category

Filters reviews based on the review category

score

Filters reviews by review score: SUPERB (9-10), GOOD (7-8), PASSABLE (5-6), POOR (3-4), and VERYPOOR (1-2).

country

string

Filters reviews based on the reviewer's country.

reviewerLanguages

List

Filters reviews based on the language of the review content.

season

Filters reviews according to the season or time of year.

verbose

boolean

To include additional information when set to true (default: false).

Pagination

See Pagination for more details. Sorting options are dateReviewed, mostRelevant and score.

Model Description

See Model Description for the base structure of responses.

Data Object Fields

The data object contains the primary response information returned by the API:

Name
Type
Description

channels

List of ReviewScore objects

Review scores and details from Airbnb.

score

double

The overall average score calculated from all available sources.

reviews

integer

Total number of reviews aggregated across all sources.

timeUpdated

Instant

The timestamp of the last update.

userReviews

List of ReviewDetails objects

A list of individual user reviews with details such as reviewer name, score, title, description, and review date.

facilities

List of ReviewFacility objects

A list of facilities mentioned in reviews. If null, no facilities data is available.

tripTypes

Map of String to TripTypeScore objects

Trip-type review score breakdown keyed by trip type, including the aggregated all bucket when available. Omitted when no trip type data is available.

ReviewScore Object Fields

The ReviewScore object represents the scoring details for each review source:

Name
Type
Description

title

String

The channel name.

score

double

The average review score from the source.

outOfScore

integer

The maximum possible score for the source (e.g., 10 or 6).

total

integer

The total number of reviews counted for this source.

ReviewDetails Object Fields

Name
Type
Description

name

string

Name of the reviewer.

category

string

Category of the reviewer (e.g., Solo traveller, Family, etc.).

dateReviewed

Date

The date the review was submitted.

score

double

The review score provided by the user.

title

string

Title of the review.

description

string

Detailed text of the review.

country

string

Country of the reviewer.

language

string

Language of the review.

photoUrl

string

URL to the reviewer's photo, if available.

channel

string

The source channel of the review (e.g. Booking.com, Tripadvisor.com).

hidden

boolean

Indicates if the review is hidden (true) or visible (false).

ReviewFacility Object Fields

Name
Type
Description

channel

string

The source channel of the review (e.g., Booking.com, Tripadvisor.com).

facility

string

The name of the facility mentioned in the review.

score

double

The review score related to the facility.

timestamp

Date

The date and time when the facility was reviewed.

TripTypeScore Object Fields

Name
Type
Description

reviewsPercent

int

Percentage of reviews for the trip type.

score

int

The score for the trip type.

categories

List of CategoryScore objects

Category scores associated with this trip type.

byLanguage

Map of String to TripTypeScore objects

Optional language-level breakdown returned for the aggregated all bucket and omitted for other trip types.

CategoryScore Object Fields

Name
Type
Description

categoryName

String

Name of the review category.

text

String

Full descriptive text for the category.

shortText

String

Short descriptive text for the category.

score

int

Score assigned to the category.

count

int

Number of reviews contributing to this category.

MetaData Object Fields

Name
Type
Description

countries

Map<String, String>

The countries available for filtering.

filterTotals

The filtering options totals.

sortingOptions

List

Available options for sorting.

FilterTotals Object Fields

Name
Type
Description

categories

Map<Category, Integer>

The Category Type totals.

scores

Map<Score, Integer>

The Score Type totals.

seasons

Map<Season, Integer>

The Season Type totals.

Request Example

200 OK - Success

400 Bad Request

401 Unauthorized

Last updated