List city properties
Returns one page of a TripAdvisor location list. Requires geo_id and location_slug from the same TripAdvisor URL. data is null when no list page was served.
Authorization
ApiKeyAuth In: header
Query Parameters
TripAdvisor's id for the city or region — the g number in its URL, e.g. geo_id=60713 for /Hotels-g60713-San_Francisco_California-Hotels.html. Each row also carries its own geo_id, which can differ from the one you asked for.
1 <= value <= 99999999The underscored place name from the same URL, e.g. San_Francisco_California. Required alongside geo_id because there is no lookup that turns a geo id into a slug. Trimmed of leading/trailing slashes only; otherwise used as given.
Which of the city's three list pages to read. hotels and restaurants rows are fully populated; attractions rows carry only name and coordinates. See coverage on the response.
"hotels"Value in
- "hotels"
- "restaurants"
- "attractions"
TripAdvisor's own oa cursor. Moves in steps of 30: page two is offset=30. Must be a multiple of 30 — a non-multiple is rejected rather than rounded.
0 <= value <= 29700curl -X GET "https://example.com/v1/tripadvisor/list?geo_id=60713&location_slug=San_Francisco_California" \ -H "x-api-key: YOUR_API_KEY"{ "data": { "geo_id": 60713, "location_slug": "San_Francisco_California", "kind": "hotels", "offset": 0, "page_size": 30, "next_offset": 30, "count": 30, "item_list_order": "Descending", "coverage": "TripAdvisor publishes attractions as TouristAttraction, which carries only name and coordinates — no rating, review count, address or location id. Hotels and restaurants carry all of them.", "breadcrumbs": [ { "position": 1, "name": "United States", "url": "string" } ], "results": [ { "position": 1, "schema_type": "Hotel", "name": "InterContinental Mark Hopkins", "url": "https://www.tripadvisor.com/HotelHighlight-g60713-d115623-Reviews-InterContinental_Mark_Hopkins-San_Francisco_California.html", "geo_id": "60713", "location_id": "115623", "rating": 4.5, "rating_scale_max": 5, "review_count": 3309, "price_range": "$$$", "telephone": "+1 415-392-3434", "image": "string", "address": { "street_address": "999 California Street", "locality": "San Francisco", "region": "CA", "postal_code": "94108", "country": "US" }, "geo": { "latitude": 37.791553, "longitude": -122.41039 } } ] }}