API Documentation (v2)
Once you have your API key, here are some documents to get started.
| Document | Description |
|---|---|
| Quick start guide | The absolute basics you need to know to start getting data in just a few minutes. |
| Headers and Responses | Introductory documentation, providing an overview of how to setup your API requests, and handle responses. |
| Frequently Asked Questions | A selection of some of the questions we get asked about the most. |
| Sample code | A few examples of different ways you can use our API in your applications. |
| Sandbox environment | Test data for development and educational purposes. |
Then you need the details of each of our APIs below.
| Method name | Description |
|---|---|
| GET filmsNowShowing | Returns the top N films now showing, ordered by number of showtimes in database. |
| GET filmsComingSoon | Displays a list of films coming soon (sorted by popularity) |
| GET filmLiveSearch | Returns film titles matching search string – useful for search as you type or standard search. List is ordered by popularity using a count of number of showtimes in database. |
| GET cinemaLiveSearch | Return the nearest cinemas matching a cinema name query, for example Showcase. Works best with geolocation (Optional) within 75 miles. Also works with query only, sorting alphabetically. Can be used in a Search As You Type feature. |
| GET filmDetails | Returns the metadata for a single specific film, including title, synopsis, cast, etc |
| GET cinemaDetails | Returns the metadata for a single specific cinema, including name, address, logo |
| GET cinemasNearby | Return the nearest cinemas based on a specific geolocation. |
| GET cinemaShowTimes | Returns showtimes based on combination of cinema, date and film. Results can be sorted by popularity or alphabetically. |
| GET filmShowTimes | Returns film showtimes based on combination of film, geolocation and date within 75 miles. Results are sorted by distance. |
| GET closestShowing | For a given film and location, return the nearest cinema showing the film, regardless of time and date. |
| GET purchaseConfirmation | Returns a URL deep link that links directly to cinema websites, with film, time and date selected. |
| GET images | Returns URL’s for the images for a single specific film. |
| GET trailers | Returns URL’s for the trailers for a single specific film. |