A collection of additional endpoints which can be used to search parts of the catalog.
Autocomplete
get/autocomplete
This endpoint is ideal for creating a list of choices as part of an autocomplete feature.
Using any of the parameters that ends with _limit will return that items for that resource in the response. It is possible to include multiple parameters to return multiple resources.
Request
query Parameters
activity_limit
integer >= 0
Limit the maximum number of activities to include in the response.
A positive value is required in order to receive activities in the response.
activity_offset
integer >= 0
Default: 0
Exclude the first N activities from the response, where N is the specified integer value.
category_limit
integer >= 0
Limit the maximum number of categories to include in the response.
A positive value is required in order to receive categories in the response.
category_offset
integer >= 0
Default: 0
Exclude the first N categories from the response, where N is the specified integer value.
city_limit
integer >= 0
Limit the maximum number of cities to include in the response.
A positive value is required in order to receive cities in the response.
city_offset
integer >= 0
Default: 0
Exclude the first N cities from the response, where N is the specified integer value.
coordinates
string(-)?\d{1,3}(\.\d+)?,(-)?\d{1,3}(\.\d+)?
Filter results using latitude and longitude, separated by a comma.
By itself, this parameter does not affect the results. Use the sort_by parameter to get results closest (or farthest) from the specified coordinates.
Results that do not contain coordinate data will not be affected by this parameter.
country_limit
integer >= 0
Limit the maximum number of countries to include in the response.
A positive value is required in order to receive countries in the response.
country_offset
integer >= 0
Default: 0
Exclude the first N countries from the response, where N is the specified integer value.
hotel_limit
integer >= 0
Limit the maximum number of hotels to include in the response.
A positive value is required in order to receive hotels in the response.
hotel_offset
integer >= 0
Default: 0
Exclude the first N hotels from the response, where N is the specified integer value.
list_limit
integer >= 0
Limit the maximum number of Musement lists to include in the response.
A positive value is required in order to receive lists in the response.
list_offset
integer >= 0
Default: 0
Exclude the first N Musement lists from the response, where N is the specified integer value.
pickup_limit
integer >= 0
Limit the maximum number of pickup points to include in the response.
A positive value is required in order to receive pickup points in the response.
pickup_offset
integer >= 0
Default: 0
Exclude the first N pickup points from the response, where N is the specified integer value.
sort_by
Array of strings
Sort results by one or more of the following values:
relevance: From lowest to highest relevance value.
-relevance: From highest to lowest relevance value.
distance: Results closest to the coordinates parameter appear first.
-distance: Results farthest from the coordinates parameter appear first.
This parameter will accept two values, separated with a comma.
Items which do not use relevance or coordinates will not be affected by this parameter.
Items Enum:-distance-relevancedistancerelevance
text
required
string >= 3 characters
Filter results to those which contain specified key words.
venue_limit
integer [ 0 .. 5 ]
Limit the maximum number of venues to include in the response.
A positive value is required in order to receive venues in the response.
Using a value greater than the maximum is ignored and the maximum number of possible results is used instead.
venue_offset
integer >= 0
Default: 0
Exclude the first N venues from the response, where N is the specified integer value.
header Parameters
Accept-Language
string (Language code)
Default: en-US
The value of this parameter might affect the language of the content in the response, provided a translation in the requested language is available.
X-Musement-Application
string (Application value)
A partner's application value, used for analyzing API usage and to identify areas of improvement.
When absent, the latest version is used by default, however the latest version may not be stable. Partners are encouraged to use the latest stable version: 3.4.0.