The imin Platform
2.0.0
2.0.0
  • Introduction to the imin Platform
  • Using the Platform
    • imin's Platform Products
    • Authentication
    • Our Platform Data
      • Understanding Responses
      • Namespaces and Extensions
      • Defensive Data Consumption
      • Mocking the Interface
  • platform products
    • Search
      • imin Events API
        • Events API Reference
        • Virtual & Physical Sessions
        • Concepts
          • EventSeries
          • ScheduledSessions and eventSchedules
          • Activities and Collections
            • Activities
            • Activity Concept Collections
          • Accessibility Support
          • Prices
        • Filters
          • Modes
          • Age Ranges
          • Dates and Times
          • Activities and Concept Collections
          • High Frequency Sessions
      • imin Facilities API
        • Query Parameter Search
          • Mandatory Query Parameters
            • mode=discovery-geo
            • mode=upcoming-slots
          • Optional Query Parameters
        • ByID Search
          • FacilityUse By-ID
          • Slot By-ID
        • FacilityUses and IndividualFacilityUses
        • Slots
        • Facilities Slot Booking
      • imin Places API [BETA]
        • Example Request & Response
    • Firehose
      • Introduction to the Firehose
      • Accessing the Firehose
      • Firehose Usage Policy & Restrictions
      • Firehose and Search
      • Bookable Firehose Feeds
      • Bookable Sellers Feed
      • Attribution Catalog Endpoint
    • Live Timetables
      • Pre-Requisites: Open Data Feeds
      • The Onboarding Process
        • 1. Ensuring your Data Offers the Best User Experience
        • 2. Setting up and Embedding your First Timetable
        • 3. Setting up the Rest of your Timetables
        • 4. Activating Booking via Guest Checkout
      • Features Available Upon Request
      • Styling the Live Timetables
      • FAQs
    • Data Dashboard
  • incorporating book and pay
    • imin Branded Checkout
      • Introduction
      • Setup
        • Information We Require From You
        • Actions You Need to Complete
      • Authenticated Checkout
        • Testing [BETA]
        • 👪Group Booking [BETA]
      • Standalone Checkout
      • Firehose and Checkout [BETA]
        • Loading the Checkout via Firehose
    • imin Booking Platform
      • Customer Account Management
        • Create Customer Account
        • Update Customer Account
        • Get Customer Account
        • Delete Customer Account
        • Example Scenario
        • Payment Card Management
        • Linked Accounts
        • Entitlement
          • Evidence Requests
          • Entitlement Pricing in Search
          • Entitlement Pricing in Checkout
        • Access Pass
        • Webhooks
      • Orders
        • Order History
        • Order (by ID)
        • Cancellations & Refunds
      • Upcoming OrderItems
      • Receipt (by ID)
  • imin and booking systems
    • Seller Onboarding
      • API
  • HINTS & TIPS
    • Get the Best Out of Search
      • Displaying Schedule Information
      • URLs and Offering a Call to Action
      • Searching by Activity
      • Your Search Results and HighFrequencySessions
      • Customer Specific Images
  • Info for Data Publishers
    • Your RPDE Feed & the imin Platform [BETA]
      • Providing Places Data [BETA]
      • Providing Schedule Information [BETA]
Powered by GitBook
On this page
  • Introduction to the Events API
  • Restrictions on Use
  • Dummy Data
  • Maximum limit
  • HighFrequencySession
  1. platform products
  2. Search

imin Events API

PreviousSearchNextEvents API Reference

Last updated 1 year ago

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 and our other service options.

Dummy Data

You can access our dummy dataset (refimpl) in the Events API using and the following test API key:

7gsdzogPG2elvc9XAvx0qQday6W637js

Please see the page for information on and for an introduction to the dummy data.

Because the location data included in refimpl is for , 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

We refer to highly repetitive activities like swimming and gym workout sessions as "high frequency sessions".

The default behaviour of the Events API is to exclude highly repetitive activities such swimming sessions and gym workout sessions.

As a result of this, an Events API call you make may not include all of the available activities based on the parameters provided.

For full a full introduction to and explanation of how to exclude/include high frequency sessions, please click .

here
Firehose
this API call
Authentication
how to use the API key
Null Island
Mocking the Interface