Firehose

The imin Firehose is a feed of all the data in the imin Platform. Instead of sending queries to Search, you copy the data into your own datastore and keep it up to date as it changes.

The Firehose is compatible with the OpenActive Modelling Specification and published using the OpenActive Paging Specification.

Note

Unlike Search, the Firehose is not a search API. It is a “feed” of all data, which means that all filtering needs to be done client-side.

The Feeds

Feeds	What they contain
Firehose feeds	Every session and facility in the imin Platform
Bookable Firehose feeds	Only the sessions and facilities from Booking Systems that are bookable by imin
Bookable Sellers feed	The Sellers that are bookable by you
Attribution Catalog Endpoint	The datasets that the data comes from, so that you can attribute them

Getting Started

1. Read the Introduction to the Firehose to see what the feeds contain and how they link together.
2. Find your endpoints in Accessing the Firehose.
3. Read Firehose Authentication and CDN Endpoints before you write the code that follows a feed.
4. Decide which data to keep with Filtering Firehose Data.
5. Check your application against the Firehose Usage Policy & Restrictions.