Method name
GET cinemaLiveSearch
Description
Returns cinema names, or town/city matches for a search string. Useful for search as you type or standard search. Works best with geolocation (Optional) within 75 miles. For ‘search as you type’, send a request after every character entered in your app’s search field.
Example request
cinemaLiveSearch/?query=odeon+cinemas
Recommendation: If you are using this feature to implement a “Search as you type” solution, we recommend that you implement a short delay before submitting the request, to detect if the user has stopped typing, or submit after every three or four characters. This way you will consume fewer API requests.
Required headers
Sent header | Description | Data type | Optional / Mandatory |
---|---|---|---|
geolocation | Geolocation of end user. Optional, but recommended. Format must be lat;lon for example 51.510391;-0.13013 | Latitude and Longitude | Optional |
Sent Arguments
Sent argument | Description | Data type | Optional / Mandatory |
---|---|---|---|
query | The search string to be queried (URL encoded), for example query=odeon. You must submit a minimum of three characters. | String | Mandatory |
n | Limit the number of returned results. Default is 5, System max is 25. | Integer | Optional |
Caching
The returned should not be cached.
Returned data
Returned Key | |
---|---|
cinemas | Array – containing details of cinemas matching search criteria |
cinema_id | The MovieGlu numeric internal cinema ID |
cinema_name | The Cinema name |
address | Cinema address line 1 |
address2 | Cinema address line 2 |
city | City in which cinema is found |
postcode | Zip code or post code of cinema |
lat | Cinema latitude |
lng | Cinema longitude |
distance | Distance in MILES from users geolocation (if provided) |
logo_url | Location of logo image for cinema (generally available for chains 4 or more cinemas, not all countries) |
Example response
{
"cinemas": [
{
"cinema_id": 10195,
"cinema_name": "Reading Film Theatre",
"address": "Palmer Building",
"city": "Reading",
"postcode": "RG6 2AH",
"logo_url": "https://d2z9fe5yu2p0av.cloudfront.net/chainlogos/uk/UK-1221-sq.jpg"
},
{
"cinema_id": 8509,
"cinema_name": "Showcase Cinema de Lux Reading",
"address": "Loddon Bridge - Reading Road",
"city": "Wokingham",
"postcode": "RG41 5HG",
"logo_url": "https://d2z9fe5yu2p0av.cloudfront.net/chainlogos/uk/UK-577-sq.jpg"
},
{
"cinema_id": 8941,
"cinema_name": "Vue Cinemas - Reading",
"address": "Riverside Level, The Oracle Shopping Centre",
"city": "Reading",
"postcode": "RG1 2AG",
"logo_url": "https://d2z9fe5yu2p0av.cloudfront.net/chainlogos/uk/UK-712-sq.jpg"
}
],
"status": {
"count": 3,
"state": "OK",
"method": "cinemaLiveSearch",
"message": null,
"request_method": "GET",
"version": "MGv200",
"territory": "UK",
"device_datetime_sent": "2018-09-14T13:24:40.718Z",
"device_datetime_used": "2018-09-14 13:24:40"
}
}