Accessing the Firehose

Every Firehose endpoint needs an API key, sent as the X-API-KEY request header. See how to use the API key.

Demo Access

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

7rqDX97CwJrbi0kRFzWkjUcAiWttpZAq

With this API key you will be able to use the following Firehose endpoints:

Feed	Endpoint
`SessionSeries`	`https://firehose.imin.co/firehose/refimpl/v2/session-series`
`ScheduledSession`	`https://firehose.imin.co/firehose/refimpl/v2/scheduled-sessions`
`FacilityUse`	`https://firehose.imin.co/firehose/refimpl/v2/facility-uses`
`Slot`	`https://firehose.imin.co/firehose/refimpl/v2/slots`

For example, replacing <test API key> with the key above:

curl -H "X-API-KEY: <test API key>" \
  https://firehose.imin.co/firehose/refimpl/v2/session-series

See Mocking the Interface for an introduction to the dummy data.

Production Access

Once you have been provided with your own unique API key, you should use one of the following sets of Firehose endpoints.

All Data

The following endpoints provide access to all data within the imin Platform:

Feed	Endpoint
`SessionSeries`	`https://firehose.imin.co/firehose/standard/v2/session-series`
`ScheduledSession`	`https://firehose.imin.co/firehose/standard/v2/scheduled-sessions`
`FacilityUse`	`https://firehose.imin.co/firehose/standard/v2/facility-uses`
`Slot`	`https://firehose.imin.co/firehose/standard/v2/slots`

Bookable Data Only

Additional Firehose endpoints are available that provide access to only data within the imin Platform that is bookable either via imin Checkout or the imin Booking API. See Bookable Firehose Feeds.