Cities

A collection of deprecated endpoints for cities.

Search events in cityDeprecated

Returns a list of available activities for the city. If no date range is specified with the available_from and available_to parameters, a default of one year is used.

Request
path Parameters
cityId
required
integer (City ID) >= 1

The numeric ID of the city.

query Parameters
available_from
string <date>

Filter activities by their available dates. Only activities with at least one available date after this parameter value are returned.

Must be used together with available_to parameter.

available_to
string <date>

Filter activities by their available dates. Only activities with at least one available date before this parameter value are returned.

Must be used together with available_from parameter.

category
integer (Category ID) >= 1

Filter results by category.

limit
integer <= 100
Default: 100

Limit the maximum number of results to include in the response.

offset
integer >= 0
Default: 0

Exclude the first N results from the response, where N is the specified integer value.

sort_by
string
Default: city-relevance

Sort results by specific properties. Most values sort activities from highest to lowest values. However when sorting by price, the results appear from lowest to highest values.

Enum: city-relevance external-relevance price rating relevance-city relevance-external relevance
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.

X-Musement-Currency
string (Currency code)
Default: USD

A valid currency code from the /currencies endpoint. Default value may vary depending on the X-Musement-Market header value.

X-Musement-Market
string (Musement market)
Default: us

Musement markets contain a modified catalog of activities and prices. Partners are expected to use their assigned market code to view their customized catalog.

An invalid X-Musement-Market value will return a 400 status code response.

X-Musement-Version
string^[0-9]+?.[0-9]+?.[0-9]+?$

The API version to use for the request.

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.

Example: 3.4.0
Responses
200

Activities in city

302

When the limit parameter is greater than the maximum, endpoint is redirected with limit={maximum}.

404

Resource not found

default

Error

get/cities/{cityId}/events
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/cities/{cityId}/events?available_from=2019-08-24&available_to=2019-08-24&category=1&limit=100&offset=0&sort_by=city-relevance' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Currency: USD' \
  -H 'X-Musement-Market: us' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • {
    }
]

Get events available today in cityDeprecated

Request
path Parameters
cityId
required
integer (City ID) >= 1

The numeric ID of the city.

query Parameters
limit
integer [ 1 .. 100 ]
Default: 100

Limit the maximum number of results to include in the response.

offset
integer >= 0
Default: 0

Exclude the first N results 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.

X-Musement-Currency
string (Currency code)
Default: USD

A valid currency code from the /currencies endpoint. Default value may vary depending on the X-Musement-Market header value.

X-Musement-Market
string (Musement market)
Default: us

Musement markets contain a modified catalog of activities and prices. Partners are expected to use their assigned market code to view their customized catalog.

An invalid X-Musement-Market value will return a 400 status code response.

X-Musement-Version
string^[0-9]+?.[0-9]+?.[0-9]+?$

The API version to use for the request.

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.

Example: 3.4.0
Responses
200

Activities available today in city

302

Found: when the limit parameter is greater than the maximum, the endpoint is redirected with limit={maximum}

404

Resource not found

default

Error

get/cities/{cityId}/events/today
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/cities/{cityId}/events/today?limit=100&offset=0' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Currency: USD' \
  -H 'X-Musement-Market: us' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • {
    }
]

Get events available tomorrow in cityDeprecated

Request
path Parameters
cityId
required
integer (City ID) >= 1

The numeric ID of the city.

query Parameters
limit
integer [ 1 .. 100 ]
Default: 100

Limit the maximum number of results to include in the response.

offset
integer >= 0
Default: 0

Exclude the first N results 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.

X-Musement-Currency
string (Currency code)
Default: USD

A valid currency code from the /currencies endpoint. Default value may vary depending on the X-Musement-Market header value.

X-Musement-Market
string (Musement market)
Default: us

Musement markets contain a modified catalog of activities and prices. Partners are expected to use their assigned market code to view their customized catalog.

An invalid X-Musement-Market value will return a 400 status code response.

X-Musement-Version
string^[0-9]+?.[0-9]+?.[0-9]+?$

The API version to use for the request.

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.

Example: 3.4.0
Responses
200

Activities available tomorrow in city

302

Found: when the limit parameter is greater than the maximum, the endpoint is redirected with limit={maximum}

404

Resource not found

default

Error

get/cities/{cityId}/events/tomorrow
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/cities/{cityId}/events/tomorrow?limit=100&offset=0' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Currency: USD' \
  -H 'X-Musement-Market: us' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • {
    }
]

Get verticals for cityDeprecated

Request
path Parameters
cityId
required
integer (City ID) >= 1

The numeric ID of the city.

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.

X-Musement-Market
string (Musement market)
Default: us

Musement markets contain a modified catalog of activities and prices. Partners are expected to use their assigned market code to view their customized catalog.

An invalid X-Musement-Market value will return a 400 status code response.

X-Musement-Version
string^[0-9]+?.[0-9]+?.[0-9]+?$

The API version to use for the request.

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.

Example: 3.4.0
Responses
200

Verticals for city

404

Resource not found

default

Error

get/cities/{cityId}/verticals
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/cities/{cityId}/verticals' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Market: us' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[]

Get categories for vertical in cityDeprecated

Request
path Parameters
cityId
required
integer (City ID) >= 1

The numeric ID of the city.

verticalId
required
integer (Vertical ID) >= 1

The numeric ID of the vertical.

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.

X-Musement-Market
string (Musement market)
Default: us

Musement markets contain a modified catalog of activities and prices. Partners are expected to use their assigned market code to view their customized catalog.

An invalid X-Musement-Market value will return a 400 status code response.

X-Musement-Version
string^[0-9]+?.[0-9]+?.[0-9]+?$

The API version to use for the request.

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.

Example: 3.4.0
Responses
200

Categories for vertical in city

404

Resource not found

default

Error

get/cities/{cityId}/verticals/{verticalId}/categories
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/cities/{cityId}/verticals/{verticalId}/categories' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Market: us' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[]