> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Tripadvisor place API

> Get a place's rating, ranking and details. Call the Tripadvisor place API and get JSON back in one request. 1 credit per call. Failed calls cost nothing.

Returns a place's rating, ranking and details. The place is identified by its URL or ID.

## Request

Exactly one of `placeUrl` or `placeId` is required. A request that sets both, or none, fails with `invalidRequest`.

<CodeGroup>
  ```typescript TypeScript icon="https://mintcdn.com/sirathic/7E4w9-IC4ysabjfc/images/icons/typescript.svg?fit=max&auto=format&n=7E4w9-IC4ysabjfc&q=85&s=d8272a85e64145620f1fbbfcf7932986" theme={null}
  import { Stophy } from "stophy";

  const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
  const result = await stophy.tripadvisor.place({ placeUrl: "https://www.tripadvisor.com/Hotel_Review-g186338-d187591-Reviews-The_Ritz_London.html" });
  console.log(result.data);
  ```

  ```python Python icon="python" theme={null}
  from stophy import Stophy

  stophy = Stophy()  # reads STOPHY_API_KEY
  result = stophy.tripadvisor.place(place_url="https://www.tripadvisor.com/Hotel_Review-g186338-d187591-Reviews-The_Ritz_London.html")
  print(result["data"])
  ```

  ```bash cURL icon="terminal" theme={null}
  curl -X POST https://api.stophy.dev/v1/tripadvisor/place \
    -H "Authorization: Bearer $STOPHY_API_KEY" \
    -H "content-type: application/json" \
    -d '{"placeUrl":"https://www.tripadvisor.com/Hotel_Review-g186338-d187591-Reviews-The_Ritz_London.html"}'
  ```

  ```bash CLI icon="square-terminal" theme={null}
  stophy tripadvisor place --placeUrl https://www.tripadvisor.com/Hotel_Review-g186338-d187591-Reviews-The_Ritz_London.html
  ```
</CodeGroup>

## Response

If successful, the response body contains the standard envelope. `data` contains the place's rating, ranking, price range, address and contact details.

The following example is a real response, truncated: each list shows one item and long strings are cut.

```json theme={null}
{
  "success": true,
  "data": {
    "placeId": "187591",
    "placeUrl": "https://www.tripadvisor.com/Hotel_Review-g186338-d187591-Reviews-The_Ritz_London_Hotel-London_England.html",
    "name": "The Ritz London Hotel",
    "type": "accommodation",
    "subtypes": ["Hotel"],
    "rating": 4.7,
    "reviews": 5407,
    "rankingText": "#137 of 1,363 hotels in London",
    "rankingPosition": 137,
    "rankingOf": 1363,
    "rankingGeo": "London",
    "priceLevel": "$$$$",
    "priceRangeText": "$1,662 - $2,737",
    "hotelClass": 5,
    "description": "Opened in 1906 by hotelier César Ritz, The Ritz London is one of the world’s most iconic hotels, situated on…",
    "addressFull": "150 Piccadilly, London W1J 9BR England",
    "addressStreet": "150 Piccadilly",
    "addressCity": "London",
    "addressCountry": "United Kingdom",
    "addressPostalCode": "W1J 9BR",
    "latitude": 51.507088,
    "longitude": -0.141628,
    "phone": "+1 555 0100",
    "website": "https://www.theritzlondon.com/?scid=45f93f1b-bd77-45c9-8dab-83b6a417f6fe&y_source=1_NDIyOTQyMS03NjktbG9jYXRpb24ud2Vic2l…",
    "email": "name@example.com",
    "neighborhoods": ["St. James's"],
    "parents": [
      {
        "placeId": "186338",
        "name": "London"
      }
    ],
    "tags": ["Luxury"],
    "imageUrl": "https://media-cdn.tripadvisor.com/media/photo-o/0c/1e/94/94/hallways--v13146843.jpg",
    "timezone": "Europe/London",
    "isClosed": false
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}
```

| Field | Type | Description |
| - | - | - |
| `rating` | number | The average star rating, on a scale of 1 to 5. |
| `reviews` | integer | The number of reviews the rating is based on. |

For every field, see the response schema on this page.

## Billing

Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed.

## Pagination

This method is not paginated. A single request returns the complete result.

## Related methods

* [Tripadvisor reviews](/api-reference/endpoint/tripadvisor-reviews): Accepts `placeUrl`. Returns a place's reviews.


## OpenAPI

````yaml api-reference/openapi.json POST /v1/tripadvisor/place
openapi: 3.1.0
info:
  title: Stophy API
  version: '1'
  description: >-
    Every endpoint is a POST that takes its input as a JSON object body. Unknown
    fields are rejected with 400.


    Responses leave out empty values: null, empty strings, empty objects and
    empty nested lists are not sent.


    x-credits is what one call costs. Every call costs the same, whatever it
    returns, unless an operation's description says it costs per 10 results, or
    per second of audio. Then x-credits is the lowest price and x-credits-max
    the most one call can cost. Where an operation takes limit, send it to
    return fewer results and pay for fewer.


    When a response has a cursor, send it back unchanged with the same input to
    get the next page. When it has a page, send the next page number.
servers:
  - url: https://api.stophy.dev
security:
  - apiKey: []
paths:
  /v1/tripadvisor/place:
    post:
      summary: Get a place's rating, ranking and details
      description: Costs 1 credit per call.
      operationId: tripadvisorPlace
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                placeUrl:
                  type: string
                  description: >-
                    Link to the Tripadvisor place, like
                    https://www.tripadvisor.com/Hotel_Review-g186338-d187591-Reviews-The_Ritz_London.html.
                    Send this or placeId.
                placeId:
                  type: string
                  description: Tripadvisor place id, like d187591. Send this or placeUrl.
              sendOne:
                - placeUrl
                - placeId
              additionalProperties: false
      responses:
        '200':
          description: The data, and the credits this call used.
          headers:
            X-Request-ID:
              $ref: '#/components/headers/RequestId'
            x-credits-used:
              $ref: '#/components/headers/CreditsUsed'
            X-RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            x-cache:
              $ref: '#/components/headers/Cache'
            x-cache-age:
              $ref: '#/components/headers/CacheAge'
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                  - creditsUsed
                  - requestId
                properties:
                  success:
                    const: true
                  data:
                    type: object
                    additionalProperties: false
                    properties:
                      placeId:
                        type: string
                      placeUrl:
                        type: string
                        format: uri
                      name:
                        type: string
                      type:
                        type: string
                      subtypes:
                        type: array
                        items:
                          type: string
                      rating:
                        type: number
                      reviews:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      rankingText:
                        type: string
                      rankingPosition:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      rankingOf:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      rankingGeo:
                        type: string
                      priceLevel:
                        type: string
                      priceRangeText:
                        type: string
                      hotelClass:
                        type: number
                      description:
                        type: string
                      addressFull:
                        type: string
                      addressStreet:
                        type: string
                      addressCity:
                        type: string
                      addressRegion:
                        type: string
                      addressCountry:
                        type: string
                      addressPostalCode:
                        type: string
                      latitude:
                        type: number
                        minimum: -90
                        maximum: 90
                      longitude:
                        type: number
                        minimum: -180
                        maximum: 180
                      phone:
                        type: string
                      website:
                        type: string
                        format: uri
                      email:
                        type: string
                      neighborhoods:
                        type: array
                        items:
                          type: string
                      parents:
                        type: array
                        items:
                          type: object
                          additionalProperties: false
                          properties:
                            placeId:
                              type: string
                            name:
                              type: string
                          required: []
                      cuisines:
                        type: array
                        items:
                          type: string
                      hours:
                        type: array
                        items:
                          type: object
                          additionalProperties: false
                          properties:
                            days:
                              type: string
                            times:
                              type: array
                              items:
                                type: string
                          required: []
                      tags:
                        type: array
                        items:
                          type: string
                      imageUrl:
                        type: string
                        format: uri
                      timezone:
                        type: string
                      isClosed:
                        type: boolean
                    required:
                      - subtypes
                      - neighborhoods
                      - parents
                      - cuisines
                      - hours
                      - tags
                      - isClosed
                  creditsUsed:
                    type: integer
                  requestId:
                    type: string
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
components:
  headers:
    RequestId:
      description: The request id. Quote it when you report a problem.
      schema:
        type: string
    CreditsUsed:
      description: Credits this call used.
      schema:
        type: integer
    RateLimitLimit:
      description: Requests allowed in the current window.
      schema:
        type: integer
    RateLimitRemaining:
      description: Requests left in the current window.
      schema:
        type: integer
    RateLimitReset:
      description: Unix time in seconds when the current window resets.
      schema:
        type: integer
    Cache:
      description: hit if this result came from the cache, miss if it was fetched live.
      schema:
        type: string
    CacheAge:
      description: Seconds since the returned result was written to the cache.
      schema:
        type: integer
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
  responses:
    Error:
      description: The request failed. retryable says whether trying again can help.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestId'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
        - success
        - error
      properties:
        success:
          const: false
        error:
          type: object
          required:
            - code
            - message
            - retryable
            - requestId
          properties:
            code:
              type: string
              enum:
                - cliSessionCompleted
                - cliSessionExists
                - cliSessionNotFound
                - forbidden
                - insufficientCredits
                - internalError
                - inviteClaimed
                - inviteDisabled
                - inviteExpired
                - inviteUsedUp
                - invalidCliSession
                - invalidCliVerifier
                - invalidRequest
                - notFound
                - rateLimited
                - sourceChanged
                - sourceRefused
                - sourceTimeout
                - sourceUnavailable
                - tooManyInFlight
                - unauthorized
                - unsupportedMediaType
            message:
              type: string
            retryable:
              type: boolean
            retryAfterSeconds:
              type: integer
            requestId:
              type: string
            requiredCredits:
              type: number
            availableCredits:
              type: number
            billingUrl:
              type: string
              const: https://stophy.dev/billing
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.