Tripadvisor Content API

https://tripadvisor-content-api.readme.io/reference
Admin
Tripadvisor Content API provides dynamic access to Tripadvisor's travel content including location...
Tokens:19,395
Snippets:289
Trust Score:9.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### CORS Request Example

Source: https://tripadvisor-content-api.readme.io/reference/api-security

This example demonstrates how to make a CORS-compliant request to the API. Ensure your request includes the 'origin' and 'referer' headers with a URL from a configured allowed domain.

```bash
curl -v -H "origin: <https://www.example.com>" -H "referer: <https://www.example.com>" "<https://api.content.tripadvisor.com/api/v1/location/730099/details?key=YOUR_API_KEY>"
```

--------------------------------

### cURL Request Example

Source: https://tripadvisor-content-api.readme.io/reference/location-search

Example of a cURL request to the Location Search API. Ensure you replace 'xxxxxxxxxx' with your actual API key.

```shell
curl --request GET \
     --url 'https://api.content.tripadvisor.com/api/v1/location/search?language=en' \
     --header 'accept: application/json'
```

--------------------------------

### Get Location Reviews (cURL)

Source: https://tripadvisor-content-api.readme.io/reference/location-reviews

Use this cURL command to make a GET request to the Location Reviews endpoint. Ensure you replace 'locationId' with the actual location identifier and include your API key.

```shell
curl --request GET \
     --url 'https://api.content.tripadvisor.com/api/v1/location/locationId/reviews?language=en' \
     --header 'accept: application/json'
```

--------------------------------

### Get Location Details (cURL)

Source: https://tripadvisor-content-api.readme.io/reference/location-details

Use this cURL command to make a GET request to the Location Details API. Ensure you replace 'locationId' with the actual Tripadvisor location ID and include your valid API key.

```shell
curl --request GET \
     --url 'https://api.content.tripadvisor.com/api/v1/location/locationId/details?language=en&currency=USD' \
     --header 'accept: application/json'
```

--------------------------------

### Nearby Location Search cURL Request

Source: https://tripadvisor-content-api.readme.io/reference/nearby-location-search

Example of how to make a GET request to the Nearby Location Search API using cURL. Ensure you replace placeholders with your actual API key and desired parameters.

```shell
curl --request GET \
     --url 'https://api.content.tripadvisor.com/api/v1/location/nearby_search?language=en' \
     --header 'accept: application/json'
```

--------------------------------

### Get Location Reviews

Source: https://tripadvisor-content-api.readme.io/reference/getlocationreviews

Retrieves up to 5 of the most recent reviews for a specific location. Higher limits may be available for beta subscribers.

```APIDOC
## GET /v1/location/{locationId}/reviews

### Description
Fetches recent reviews for a specific location.

### Method
GET

### Endpoint
/v1/location/{locationId}/reviews

#### Path Parameters
- **locationId** (integer) - Required - A unique identifier for a location on Tripadvisor.

#### Query Parameters
- **key** (string) - Required - The Partner API Key.
- **language** (string) - Optional - The language in which to return results (e.g., "en" for English). Defaults to "en".
- **limit** (integer) - Optional - The number of results to return.
- **offset** (integer) - Optional - The index of the first result.

### Response
#### Success Response (200)
- **data** (array) - An array of review objects.
  - **id** (integer) - The Tripadvisor ID for the review.
  - **lang** (string) - The language of the review.
  - **location_id** (integer) - Unique Tripadvisor location ID of the destination or POI.
```

--------------------------------

### Get Location Photos (cURL)

Source: https://tripadvisor-content-api.readme.io/reference/location-photos

Use this cURL command to make a GET request to the Location Photos API. Ensure you replace 'locationId' with the actual location identifier and include your API key.

```shell
curl --request GET \
     --url 'https://api.content.tripadvisor.com/api/v1/location/locationId/photos?language=en' \
     --header 'accept: application/json'
```

--------------------------------

### Get Location Reviews

Source: https://tripadvisor-content-api.readme.io/reference/location-reviews

Retrieves up to 5 of the most recent reviews for a specific location. Requires a location ID and an API key.

```APIDOC
## GET /location/{locationId}/reviews

### Description
The Location Reviews request returns up to 5 of the most recent reviews for a specific location.

### Method
GET

### Endpoint
https://api.content.tripadvisor.com/api/v1/location/{locationId}/reviews

### Parameters
#### Path Parameters
- **locationId** (int32) - Required - A unique identifier for a location on Tripadvisor.

#### Query Parameters
- **key** (string) - Required - The Partner API Key
- **language** (string) - Optional - Defaults to en. The language in which to return results (e.g. "en" for English or "es" for Spanish).
- **limit** (number) - Optional - The number of results to return
- **offset** (number) - Optional - The index of the first result

### Response
#### Success Response (200)
Details for the location reviews.
```

--------------------------------

### Get Location Details

Source: https://tripadvisor-content-api.readme.io/reference/location-details

Fetches detailed information for a specific location using its unique ID. Supports language and currency customization.

```APIDOC
## GET /location/{locationId}/details

### Description
A Location Details request returns comprehensive information about a location (hotel, restaurant, or an attraction) such as name, address, rating, and URLs for the listing on Tripadvisor.

### Method
GET

### Endpoint
https://api.content.tripadvisor.com/api/v1/location/{locationId}/details

### Parameters
#### Path Parameters
- **locationId** (int32) - Required - A unique identifier for a location on Tripadvisor. The location ID can be obtained using the Location Search.

#### Query Parameters
- **key** (string) - Required - The Partner API Key
- **language** (string) - Optional - Defaults to en. The language in which to return results (e.g. "en" for English or "es" for Spanish).
- **currency** (string) - Optional - Defaults to USD. The currency code to use for request and response (should follow ISO 4217).

### Response
#### Success Response (200)
Details for the location

### Request Example
```curl
curl --request GET \
     --url 'https://api.content.tripadvisor.com/api/v1/location/locationId/details?language=en&currency=USD' \
     --header 'accept: application/json'
```
```

--------------------------------

### Get Location Photos

Source: https://tripadvisor-content-api.readme.io/reference/location-photos

Fetches up to 5 high-quality photos for a specific location, ordered by recency. Supports various query parameters for filtering and customization.

```APIDOC
## GET /location/{locationId}/photos

### Description
Retrieves up to 5 high-quality photos for a specific location. Photos are ordered by recency.

### Method
GET

### Endpoint
`https://api.content.tripadvisor.com/api/v1/location/{locationId}/photos`

### Parameters
#### Path Parameters
- **locationId** (int32) - Required - A unique identifier for a location on Tripadvisor.

#### Query Parameters
- **key** (string) - Required - The Partner API Key.
- **language** (string) - Optional - Defaults to 'en'. The language in which to return results (e.g., "en" for English or "es" for Spanish).
- **limit** (number) - Optional - The number of results to return.
- **offset** (number) - Optional - The index of the first result.
- **source** (string) - Optional - A comma-separated list of allowed photo sources. Allowed values are 'Expert', 'Management', 'Traveler'. If not specified, photos from all sources are allowed.

### Response
#### Success Response (200)
Details for the location photos.

### Request Example
```shell
curl --request GET \
     --url 'https://api.content.tripadvisor.com/api/v1/location/YOUR_LOCATION_ID/photos?language=en&limit=5' \
     --header 'accept: application/json' \
     --header 'key: YOUR_API_KEY'
```

### Response Example
```json
{
  "data": [
    {
      "id": "photo_id_1",
      "caption": "Beautiful sunset view",
      "published_date": "2023-10-27T10:00:00Z",
      "user": {
        "username": "Traveler123",
        "is_business_owner": false
      },
      "images": {
        "thumbnail": {
          "url": "https://example.com/thumbnail.jpg",
          "height": 50,
          "width": 50
        },
        "small": {
          "url": "https://example.com/small.jpg",
          "height": 150,
          "width": 150
        },
        "medium": {
          "url": "https://example.com/medium.jpg",
          "height": 250,
          "width": 180
        },
        "large": {
          "url": "https://example.com/large.jpg",
          "height": 550,
          "width": 400
        },
        "original": {
          "url": "https://example.com/original.jpg",
          "height": 1080,
          "width": 1920
        }
      }
    }
    // ... more photos
  ]
}
```
```

--------------------------------

### Get Location Reviews

Source: https://tripadvisor-content-api.readme.io/reference/getlocationreviews

Retrieves a list of reviews for a specific location. This endpoint is useful for fetching user-generated feedback and ratings associated with a place.

```APIDOC
## GET /locations/{locationId}/reviews

### Description
Retrieves a list of reviews for a specific location.

### Method
GET

### Endpoint
/locations/{locationId}/reviews

### Parameters
#### Path Parameters
- **locationId** (string) - Required - The unique identifier for the location.

#### Query Parameters
- **limit** (integer) - Optional - The maximum number of reviews to return.
- **offset** (integer) - Optional - The number of reviews to skip before starting to collect the result set.

### Response
#### Success Response (200)
- **data** (array) - An array of review objects.
  - **review_id** (string) - The unique identifier for the review.
  - **rating** (number) - The rating given in the review (e.g., 1-5).
  - **title** (string) - The title of the review.
  - **text** (string) - The full text of the review.
  - **published_date** (string) - The date the review was published.
  - **user_profile** (object) - Information about the user who wrote the review.
    - **username** (string) - The username of the reviewer.
    - **location** (string) - The location of the reviewer.
    - **member_since** (string) - The date the user became a member.
    - **review_count** (integer) - The total number of reviews written by the user.
    - **reviewer_badge** (string) - A badge associated with the reviewer.
    - **avatar** (object) - An object containing URLs for the reviewer's avatar.
  - **subratings** (object) - An object containing sub-ratings for specific aspects of the location.
    - **name** (string) - The name of the sub-rating category.
    - **localized_name** (string) - The localized name of the sub-rating category.
    - **rating_image_url** (string) - URL for the rating image.
    - **value** (number) - The value of the sub-rating.
- **paging** (object) - Information about the pagination of the results.
  - **next** (string) - URL for the next page of results.
  - **previous** (string) - URL for the previous page of results.
  - **results** (integer) - The number of results in the current page.
  - **total_results** (integer) - The total number of results available.
  - **skipped** (integer) - The number of results skipped.

#### Error Response (4xx/5xx)
- **error** (object) - An object containing error details.
  - **message** (string) - A description of the error.
  - **type** (string) - The type of error.
  - **code** (integer) - An error code.
```

--------------------------------

### Get Location Photos

Source: https://tripadvisor-content-api.readme.io/reference/getlocationphotos

Retrieves up to 5 high-quality photos for a specific location. Photos are ordered by recency and available in various sizes: Thumbnail, Small, Medium, Large, and Original.

```APIDOC
## GET /v1/location/{locationId}/photos

### Description
Retrieves up to 5 high-quality photos for a specific location. The photos are ordered by recency.

### Method
GET

### Endpoint
/v1/location/{locationId}/photos

### Parameters
#### Path Parameters
- **locationId** (integer) - Required - A unique identifier for a location on Tripadvisor. The location ID can be obtained using the Location Search.

#### Query Parameters
- **key** (string) - Required - The Partner API Key
- **language** (string) - Optional - The language in which to return results (e.g. "en" for English or "es" for Spanish). Defaults to "en".
- **limit** (number) - Optional - The number of results to return.
- **offset** (number) - Optional - The index of the first result.
- **source** (string) - Optional - A comma-separated list of allowed photo sources. Allowed values are 'Expert', 'Management', 'Traveler'. If not specified, allow photos from all sources.

### Response
#### Success Response (200)
- **photos** (array) - Details for the location photos.

#### Response Example
{
  "photos": [
    {
      "id": "string",
      "caption": "string",
      "published_date": "string",
      "user": {
        "username": "string",
        "is_business_owner": "boolean"
      },
      "sizes": {
        "thumbnail": {
          "url": "string",
          "height": "integer",
          "width": "integer"
        },
        "small": {
          "url": "string",
          "height": "integer",
          "width": "integer"
        },
        "medium": {
          "url": "string",
          "height": "integer",
          "width": "integer"
        },
        "large": {
          "url": "string",
          "height": "integer",
          "width": "integer"
        },
        "original": {
          "url": "string",
          "height": "integer",
          "width": "integer"
        }
      }
    }
  ]
}
```

--------------------------------

### Get Location Details

Source: https://tripadvisor-content-api.readme.io/reference/getlocationdetails

Retrieves comprehensive information about a specific location, such as a hotel, restaurant, or attraction. This includes its name, address, rating, and links to its Tripadvisor listing.

```APIDOC
## GET /v1/location/{locationId}/details

### Description
A Location Details request returns comprehensive information about a location (hotel, restaurant, or an attraction) such as name, address, rating, and URLs for the listing on Tripadvisor.

### Method
GET

### Endpoint
/v1/location/{locationId}/details

### Parameters
#### Path Parameters
- **locationId** (integer) - Required - A unique identifier for a location on Tripadvisor. The location ID can be obtained using the Location Search.

#### Query Parameters
- **key** (string) - Required - The Partner API Key
- **language** (string) - Optional - The language in which to return results (e.g. "en" for English or "es" for Spanish) from the list of our Supported Languages. Default: "en"
- **currency** (string) - Optional - The currency code to use for request and response (should follow ISO 4217). Default: "USD"

### Response
#### Success Response (200)
- **location_id** (integer) - Unique Tripadvisor location ID of the destination or POI
- **name** (string) - Name of the POI as listed on Tripadvisor
- **description** (string) - Description of the POI as listed on Tripadvisor
- **web_url** (string) - Link to the POI detail page on Tripadvisor. Link is localized to the correct domain if a language other than English is requested.
- **address_obj** (object) - Object containing address data for this location
  - **street1** (string) - Description of the POI as listed on Tripadvisor
```

--------------------------------

### OpenAPI Definition Structure

Source: https://tripadvisor-content-api.readme.io/reference/getlocationreviews

This JSON object represents a portion of the OpenAPI definition for the Tripadvisor Content API. It outlines schema details, including example data structures.

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Tripadvisor Content API",
    "version": "1.0.0",
    "description": "API for accessing Tripadvisor content."
  },
  "paths": {},
  "components": {
    "schemas": {
      "ExampleSchema": {
        "type": "object",
        "properties": {
          "key1": {
            "type": "integer",
            "example": 10
          },
          "key2": {
            "type": "string",
            "example": "value"
          }
        }
      }
    }
  }
}
```

--------------------------------

### Implement Reviews by Blocking All Review Loading Javascript

Source: https://tripadvisor-content-api.readme.io/reference/review-implementation-policy

Block all JavaScript files related to loading reviews by specifying the directory in robots.txt. This prevents search engines from accessing review content.

```html
<html>
  <head>
    <script src="/everything_to_do_with_loading_reviews/load_reviews.js"></script>
  </head>
  <body>
    <div id=\"review\"></div>
  </body>
</html>
```

--------------------------------

### Robots.txt for Review Loading Javascript

Source: https://tripadvisor-content-api.readme.io/reference/review-implementation-policy

Configure robots.txt to disallow crawling of the directory containing JavaScript files for loading reviews.

```text
User-Agent: *

Disallow: /everything_to_do_with_loading_reviews
```

--------------------------------

### Implement Reviews by Blocking AJAX Call

Source: https://tripadvisor-content-api.readme.io/reference/review-implementation-policy

Load review content via an external JavaScript call. Ensure the API endpoint is blocked in robots.txt to prevent search engine crawling.

```html
<html>
  <head>
    <script>
      var review_content = $.ajax("https://api.abc.com/getReviewContentForHotel/123/");
                                  $("review").html(review_content);
    </script>
  </head>
 <body>
   <div id=\"review\"></div>
  </body>
</html>
```

--------------------------------

### Invalid Implementation: Javascript Directly in Page Source

Source: https://tripadvisor-content-api.readme.io/reference/review-implementation-policy

Do not embed review content directly within JavaScript in the page source. Reviews must be loaded dynamically from an external source.

```html
<html>
  <head>
    <script>
      var review_content = ”I had a great time at this hotel”;
      $("review").html(review_content);
    </script>
  </head>
  <body>
    <div id=\"review\"></div>
  </body>
</html>
```

--------------------------------

### Robots.txt for API Endpoint

Source: https://tripadvisor-content-api.readme.io/reference/review-implementation-policy

Configure robots.txt to disallow crawling of the review content API endpoint.

```text
User-Agent: *

Disallow: /getReviewContentForHotel
```

--------------------------------

### Invalid Implementation: Review Text in HTML Body

Source: https://tripadvisor-content-api.readme.io/reference/review-implementation-policy

Avoid placing review text directly within the HTML body section. This violates the policy and can lead to termination of the licensing agreement.

```html
<html>
  <head>
  </head>
  <body>
    <div>”I had a great time at this hotel”</div>
  </body>
</html>


```

--------------------------------

### Location Photos Response Schema

Source: https://tripadvisor-content-api.readme.io/reference/getlocationphotos

This schema describes the structure of the response when retrieving photos for a specific location. It includes details about each photo, such as its ID, caption, publication date, image URLs, source, and user information.

```APIDOC
## Get Location Photos Response

### Description
Returns a list of photos associated with a specific location.

### Response
#### Success Response (200)
- **data** (array) - An array of photo objects.
  - **id** (integer) - A unique ID for this photo.
  - **is_blessed** (boolean) - Boolean whether or not this photo is blessed, i.e. reviewed at Tripadvisor as being a photo of exceptional quality.
  - **album** (string) - Name of the album the photo is featured in.
  - **caption** (string) - Caption of the photo.
  - **published_date** (string) - Date when this photo was published to Tripadvisor.
  - **images** (object) - Links to the photo in various sizes, along with the dimensions in pixels of each size.
    - **additionalProperties** (object) - Key-value pairs where the key is the image size name (e.g., 'thumbnail', 'original') and the value is an object containing image details.
      - **width** (number) - The width of the image in pixels.
      - **url** (string) - The URL of the image.
      - **height** (number) - The height of the image in pixels.
  - **source** (object) - Origin of the photo.
    - **name** (string) - The name of the photo source (e.g., 'Traveler', 'Expert', 'Management').
    - **localized_name** (string) - The localized name of the photo source.
  - **user** (object) - Information about the user who uploaded the photo.
    - **username** (string) - The username that appears on the Tripadvisor website for the user.
    - **user_location** (object) - The location of the user.
      - **name** (string) - The name of the user's location.
      - **id** (string) - The location ID of the user's location.
    - **review_count** (integer) - The Review Count that appears on the Tripadvisor website for the user.
    - **reviewer_badge** (string) - The Reviewer Badge that appears on the Tripadvisor website for the user.
    - **avatar** (object) - An object containing URLs to the user's avatar in various sizes.
      - **additionalProperties** (string) - Key-value pairs where the key is the avatar size name and the value is the URL of the avatar.
- **paging** (object) - Pagination information for the results.
  - **next** (string) - A URL to the next page of results, if available.
```
Tokens:
Raw