Search vacation rental destinations by place name
View all Tripadvisor Hotel, Rental & Travel Data endpoints →Look up vacation-rental destination suggestions from a typed place name using the required string query parameter. Send a city, region or country name and read the returned location records so a user can choose a place for a rental-focused interface. This operation resolves destinations only: it does not return rental listings, prices, availability or reviews, and it accepts no dates, guest counts or page number. No observed probe response was supplied for this operation, so the response description comes from a truncated source example and is unverified. The example shows a data array of location objects with geoId, locationId, isGeo, localizedName, localizedAdditionalNames, locationV2, placeType, latitude, longitude and a thumbnail.photoSizeDynamic object holding maxHeight, maxWidth and a urlTemplate that contains {width} and {height} placeholders. Example placeType values include CITY, STATE, COUNTRY and MUNICIPALITY, and example entries include New York City, New Orleans, Newport and New Zealand. Envelope fields around data, the maximum result count, ordering and error behavior are not established by the supplied evidence. Inspect the actual response before relying on any field, treat labels as display text, and confirm in the documentation of any other operation that a returned identifier is accepted there before passing it on.
API Features
Live API Demo
🔒 Sign in to try it live
Log in to call this API with your own API key. New accounts get 100 free credits — no card required.
Log in / Sign upNo active API key found. Create one in your Dashboard, then reload this page. Dashboard →
/api/project/tripadvisor-data/search-vacation-rental-location API Response (JSON)
{} curl -X GET 'https://api.opendata-api.com/api/project/tripadvisor-data/search-vacation-rental-location?key=<API_KEY>&query=<query>'
Query Result
Use Cases
- Prototype a vacation-rental destination picker that shows localizedName next to localizedAdditionalNames so travelers can tell a city from a similarly named state or country.
- Group typed-place suggestions by placeType on a rental landing page, offering city, state and country matches in separate sections of the dropdown.
- Preview suggested destinations on a map by plotting latitude and longitude after verifying that both fields are present in the live response.
- Build destination cards with images by substituting {width} and {height} in each thumbnail urlTemplate for the card size your layout needs.
- Audit how ambiguous place names resolve for a rental catalog by saving the identifiers returned for each choice before connecting them to any other request.
Frequently asked questions
What should I pass in the query parameter?
Pass the name of the place you want to search for as a vacation-rental destination, for example a city such as New York. The parameter is a required string. The operation exposes no other inputs, so dates, guest counts, filters and paging are not available here.
Does this endpoint return rental listings or availability?
No. It is a destination lookup. The documented purpose is to find locations for vacation-rental searches, and the source example contains place records only. Use other operations in the Vacation Rentals group for property details, rates or availability, and check their own inputs.
Which response fields are documented?
The truncated source example shows a data array whose objects include geoId, locationId, isGeo, localizedName, localizedAdditionalNames, locationV2, placeType, latitude, longitude and thumbnail.photoSizeDynamic. These fields are unverified because no probe response was supplied, and the portion of the example after the visible entries is cut off.
Can I reuse a returned geoId in hotel search or other rental operations?
Do not assume so. The field is named geoId in the example, but the supplied evidence does not show that every operation accepts the identifier returned here. Check the input documentation of the target operation and test with a returned value before building a flow on it.
How do I turn the thumbnail urlTemplate into an image URL?
The example urlTemplate contains literal {width} and {height} placeholders. Replace them with pixel sizes that fit your layout, keeping within the maxWidth and maxHeight values shown beside the template. Treat the resulting URL as optional presentation content and tolerate suggestions without a thumbnail.
Why can results include states or countries as well as cities?
The source example lists entries with placeType CITY, STATE, COUNTRY and MUNICIPALITY, for instance New York City alongside the state of New York and the country New Zealand. Show the place type and the additional-name text so users can pick the intended level, and handle an empty list when nothing matches.