TripAdvisor API

TripAdvisor search

Hotels, restaurants and attractions on TripAdvisor matching a query, with rating and review count. Queued task.

Endpoint

GET/v1/tripadvisor/searchlive · proven5 credits
Try in Playground

Parameters

Query parameters

NameRequiredDescriptionExample
queryyesSearch termshotel Edinburgh
locationnoLocation nameEdinburgh,Scotland,United Kingdom
limitnoRequested rows per response, 1–1000. The source may return fewer. Remaining rows from an already purchased page use a saved cursor and cost zero to retrieve for up to one hour; further native source pages use this endpoint’s normal price.5
cursornoUse the returned cursor unchanged, retaining the original query, filters and limit. Saved mlo1. cursors retrieve already purchased rows at zero credits for up to one hour. A native source cursor, when supplied, starts a normally priced source page. Quote with dry_run before continuing.
dry_runnoRead a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution.1

Examples

Make the request

curl
curl "https://www.monocrawl.com/v1/tripadvisor/search?query=hotel%20Edinburgh" \
  -H "x-api-key: mn_your_key_here"
TypeScript
typescript
const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
  "https://www.monocrawl.com/v1/tripadvisor/search?query=hotel%20Edinburgh",
  { headers: { "x-api-key": key } },
);
const body = await res.json();

if (!body.success) {
  // one error shape for every endpoint — see /docs/errors
  throw new Error(`${body.error.type}: ${body.error.message}`);
}

console.log(body.data, "credits left:", body.credits_remaining);
Python
python
import os
import requests

res = requests.get(
    "https://www.monocrawl.com/v1/tripadvisor/search?query=hotel%20Edinburgh",
    headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
    timeout=60,
)
body = res.json()

if not body["success"]:
    # one error shape for every endpoint — see /docs/errors
    raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")

print(body["data"], "credits left:", body["credits_remaining"])

Response

Response fields and example

This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.

200 · application/json
{
  "success": true,
  "platform": "tripadvisor",
  "endpoint": "/v1/tripadvisor/search",
  "data": {
    "count": 0,
    "has_more": false,
    "items": [
      {
        "category": "example",
        "id": "example",
        "name": "example",
        "path": "example",
        "platform": "example",
        "rank": 0,
        "rating": {
          "max": 0,
          "value": 0,
          "votes": 0
        },
        "reviews_count": 0,
        "url": "https://example.com/example"
      }
    ],
    "query": "example"
  },
  "credits_used": 5,
  "credits_remaining": 99,
  "request_id": "req_…",
  "cached": false
}

The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.

Schema basis: observed response shapes, not an exhaustive field specification. See schema coverage and validation limits.

Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.

Field inside dataTypeMeaning
countnumber | nullNumber of records in this response, not lifetime or total matches.
has_moreboolean | nullSource continuation indicator; null means unknown.
itemsarray | nullReturned records. Source coverage and completeness vary.
items[].categorystring | nullOptional category supplied by this operation. Null means unknown.
items[].idstring | nullSource identifier. Preserve the supplied type and exact value.
items[].namestring | nullOptional name supplied by this operation. Null means unknown.
items[].pathstring | nullOptional path supplied by this operation. Null means unknown.
items[].platformstring | nullOptional platform supplied by this operation. Null means unknown.
items[].ranknumber | nullOptional rank supplied by this operation. Null means unknown.
items[].ratingobject | nullSource rating; read its accompanying scale and vote count.
items[].rating.maxnumber | nullOptional max supplied by this operation. Null means unknown.
items[].rating.valuenumber | nullOptional value supplied by this operation. Null means unknown.
items[].rating.votesnumber | nullOptional votes supplied by this operation. Null means unknown.
items[].reviews_countnumber | nullOptional reviews count supplied by this operation. Null means unknown.
items[].urlstring | nullOriginal source URL when supplied.
querystring | nullOptional query supplied by this operation. Null means unknown.

Optional fields reviewed from preserved successful responses. Additive fields and source variations remain allowed; validate the fields your workflow requires.

The example is invented and illustrates types only; zero and empty values are not claims about a real result.

Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference

First call in under a minute

1,000 monthly free credits and a ready-made key the moment you sign up. No card.