The imin Platform
2.0.0
Search…
⌃K

imin Events API

Introduction to the Events API

The imin Events API enables developers to build real-time physical activity search into their applications. The API exposes a database of available physical activities, updated (often in real-time) from numerous activity providers.
The following pages offer guidance on using various parts of the Events API.

Restrictions on Use

You must not use the API to collect more information than necessary to respond to an end user query, or store or scrape data other than as expressly permitted by us.
If you would like to temporarily store copies of larger data sets for efficiency or other purposes, please ask us about Firehose and our other service options.

Dummy Data

You can access our dummy dataset (refimpl) in the Events API using this API call and the following test API key:
7gsdzogPG2elvc9XAvx0qQday6W637js
Please see the Authentication page for information on how to use the API key and Mocking the Interface for an introduction to the dummy data.
Because the location data included in refimpl is for Null Island, the API call includes geo[radial]=0,0,1.

Maximum limit

The maximum number of items that can be returned per page of results is 50 (limit=50). This is to ensure our Platform can offer the best performance when returning results.

HighFrequencySession

As a result of COVID-19, many leisure operators, when restrictions permit them to open their doors, will increase the number of swimming sessions and gym workouts available at their centres. Generally speaking, these take start every ten minutes (or fifteen minutes, etc.) to ensure a constant and regulated flow of people through the centres. Antithetically to this, the number of other activities, e.g. group exercise classes, reduce dramatically to comply with social distancing guidelines. The knock-on effect of this is a dramatic increase in the number of swimming and gym workout data available as open data, and a reduction in other activities.
We refer to highly repetitive swimming sessions and gym workout sessions as "high frequency sessions".
In order to prevent the search results you receive from being overwhelmed by swimming and gym workout data, the Event API includes iminTag[not]=HighFrequencySession by default in every call. As a result of this, a general Events API search will return neither swimming nor gym workout sessions. However, if you want to the Events API to return all data, then you can override this default behaviour by included showAllSessions=true in your API calls.
showAllSessions=true will return all items in an API call, including all high frequency sessions.
For information on filtering High Frequency Sessions, please see here.