API reference
TripAdvisor Hotels API
Discover up to thirty hotels in a city, with ratings and review counts. Hotel directory only: no stay availability, nightly prices, images, price filters or pagination. Queued searches reuse the saved task when retried.
Endpoint
/v1/tripadvisor/hotelslive · proven2 creditsParameters
Query parameters
Useful optional inputs
country— Select the documented market or country filter.Read this endpoint’s country semantics; filtering and source request location can differ.
limit— Bound the returned rows to what your task needs.A smaller limit does not necessarily reduce source calls or price; inspect the quote.
dry_run— Read a free estimate before fetching sources or scheduling paid work.Zero credits; cache status and availability are snapshots rather than guarantees.
| Name | Required | Description | Example |
|---|---|---|---|
query | no | City name, optionally followed by region and country. Required unless location or location_code is supplied. q is an alias. Paris, London and New York default to France, UK and US respectively; country overrides this. | Paris |
country | no | Two-letter country code to disambiguate a city. | FR |
location | no | Explicit city and country; must agree with query if both are supplied. | Paris,France |
location_code | no | Search location code, not a Tripadvisor geo_id. Prefer a city name. | 1006094 |
limit | no | 1 to 30 hotels; default 30. First page only. | 30 |
dry_run | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable. | 1 |
Examples
Make the request
curl "https://www.monocrawl.com/v1/tripadvisor/hotels?query=Paris" \ -H "x-api-key: mn_your_key_here"
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/hotels?query=Paris",
{ 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
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/tripadvisor/hotels?query=Paris",
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.
{
"success": true,
"platform": "tripadvisor",
"endpoint": "/v1/tripadvisor/hotels",
"data": {
"checked_at": "2026-09-01T12:00:00Z",
"count": 0,
"geo_id": "example",
"has_more": false,
"items": [
{
"geo_id": "example",
"id": "example",
"images": [],
"name": "example",
"offer_labels": [],
"platform": "example",
"primary_info": "example",
"rank": 0,
"rating": {
"max": 0,
"value": 0,
"votes": 0
},
"reviews_count": 0,
"sponsored": false,
"type": "example",
"url": "https://example.com/example"
}
],
"location_code": 0,
"page": 0,
"pricing_available": false,
"query": "example",
"result_type": "example"
},
"credits_used": 2,
"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 data | Type | Meaning |
|---|---|---|
checked_at | string | null | Optional checked at supplied by this operation. Null means unknown. |
count | number | null | Number of records in this response, not lifetime or total matches. |
geo_id | string | null | Optional geo id supplied by this operation. Null means unknown. |
has_more | boolean | null | Source continuation indicator; null means unknown. |
items | array | null | Returned records. Source coverage and completeness vary. |
items[].geo_id | string | null | Optional geo id supplied by this operation. Null means unknown. |
items[].id | string | null | Source identifier. Preserve the supplied type and exact value. |
items[].images | array | null | Source array was empty in the reviewed captures; item fields remain unspecified. |
items[].name | string | null | Optional name supplied by this operation. Null means unknown. |
items[].offer_labels | array | null | Source array was empty in the reviewed captures; item fields remain unspecified. |
items[].platform | string | null | Optional platform supplied by this operation. Null means unknown. |
items[].primary_info | string | null | Optional primary info supplied by this operation. Null means unknown. |
items[].rank | number | null | Optional rank supplied by this operation. Null means unknown. |
items[].rating | object | null | Source rating; read its accompanying scale and vote count. |
items[].rating.max | number | null | Optional max supplied by this operation. Null means unknown. |
items[].rating.value | number | null | Optional value supplied by this operation. Null means unknown. |
items[].rating.votes | number | null | Optional votes supplied by this operation. Null means unknown. |
items[].reviews_count | number | null | Optional reviews count supplied by this operation. Null means unknown. |
items[].sponsored | boolean | null | Optional sponsored supplied by this operation. Null means unknown. |
items[].type | string | null | Optional type supplied by this operation. Null means unknown. |
items[].url | string | null | Original source URL when supplied. |
location_code | number | null | Optional location code supplied by this operation. Null means unknown. |
page | number | null | Optional page supplied by this operation. Null means unknown. |
pricing_available | boolean | null | Optional pricing available supplied by this operation. Null means unknown. |
query | string | null | Optional query supplied by this operation. Null means unknown. |
result_type | string | null | Optional result type 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