Tripadvisor search
Resolve a hotel, restaurant or attraction name to Tripadvisor's locationId.
types picks the kinds of place (hotels by default; any of hotel, restaurant, attraction) and every match carries its type and geo_id. Add city to rank same-name places elsewhere lower, then store recommended_match.location_id for /v1/ota/tripadvisor/reviews (any type) or POST /v1/ota/tripadvisor (hotels). It is null when only weak or ambiguous candidates were found.
Request
https://api.scrapercompany.com/v1/ota/tripadvisor/searchAuthenticate with your API key in the x-api-key header (see Authentication).
Run this request on your own API key from this page, with the values you type. Signed out? Sign in or get an API key.
Body
JSON object. Unknown fields are rejected with 422.
- namestringrequiredmin length 1
Place name as a visitor would search for it (
queryis accepted as an alias). - citystringdefault
Strongly recommended. Sent with the name to Tripadvisor's search and used to rank same-name places in other cities lower.
- limitintegerdefault
5min 1, max 10Maximum candidates to return, best match first.
- typesarray of stringmin items 1, max items 3
Kinds of place to search: any of
hotel,restaurant,attraction(default hotels only).
Example request
curl -X POST "https://api.scrapercompany.com/v1/ota/tripadvisor/search" \
-H "x-api-key: $SCRAPERCOMPANY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Moxy Boston Downtown"
}'Response
200 — Tripadvisor locationId candidates; read recommended_match. Metered responses carry x-credits-charged and x-credits-remaining headers (see credit headers).
{
"search_parameters": {
"engine": "tripadvisor_search",
"name": "Moxy Boston Downtown",
"city": "Boston",
"limit": 5
},
"search_status": "matched",
"recommended_match": {
"location_id": "17768161",
"geo_id": "60745",
"type": "hotel",
"name": "Moxy Boston Downtown",
"city": "Boston, Massachusetts",
"address": "240 Tremont Street",
"url": "https://www.tripadvisor.com/Hotel_Review-g60745-d17768161-Reviews-Moxy_Boston_Downtown-Boston_Massachusetts.html",
"rank": 0,
"score": 1,
"name_score": 1,
"identity_score": 1,
"match_score": 1,
"confidence": "high",
"city_score": 1,
"coordinates": {
"latitude": 42.350933,
"longitude": -71.064842
}
},
"warnings": [],
"matches": [
{
"location_id": "17768161",
"geo_id": "60745",
"type": "hotel",
"name": "Moxy Boston Downtown",
"city": "Boston, Massachusetts",
"address": "240 Tremont Street",
"url": "https://www.tripadvisor.com/Hotel_Review-g60745-d17768161-Reviews-Moxy_Boston_Downtown-Boston_Massachusetts.html",
"rank": 0,
"score": 1,
"name_score": 1,
"identity_score": 1,
"match_score": 1,
"confidence": "high",
"city_score": 1,
"coordinates": {
"latitude": 42.350933,
"longitude": -71.064842
}
}
],
"meta": {
"source": "tripadvisor",
"matches": 1,
"selection_method": "name_city_confidence",
"match_threshold": 0.8,
"match_margin": 0.12,
"elapsed_s": 0.289
}
}Errors
Errors return a JSON body with a detail field. Failed requests are not charged. See Errors for the full list and retry advice.
| Status | Meaning | Retry? |
|---|---|---|
401Unauthorized | Missing or invalid API key. {"detail":"missing or invalid API key"} | No, fix the request |
402Payment Required | Not enough credits for this request: the account's credits mode is {"detail":"insufficient credits: this request costs 5, 0 available. Credits renew 2026-11-01."} | No, fix the request |
422Unprocessable Content | Request validation failed. {"detail":[{"loc":["body","token"],"msg":"Field required","type":"missing"}]} | No, fix the request |
429Too Many Requests | Too many requests: the key's requests-per-minute limit was exceeded, or (in {"detail":"rate limit 60/min exceeded"} | Yes, with backoff |
502Bad Gateway | The upstream source failed, blocked the request or returned an unusable answer. Safe to retry later; failed requests are not charged. {"detail":"RuntimeError"} | Yes, with backoff |
Try it
Press Try it above to run this request on your own key, with the values you type (sign in first). For a no-code walkthrough, use the workspace’s guided Try it.
- Export your key:
export SCRAPERCOMPANY_API_KEY=sk_...(no key yet? start a free trial). - Copy the cURL example above and run it in a terminal.
Questions about this page?
Send the page link and your question, and the team will answer.