Bookable Sellers Feed

The Bookable Sellers feed is an RPDE feed whose items are Sellers that are bookable by the accessing Broker.

Accessing the Bookable Sellers feed

The Bookable Sellers feed is broker specific and can be accessed at the following endpoint:

https://firehose.imin.co/firehose/bookable-sellers/:broker

where :broker is your broker name.

Caution

As with other feeds, you must provide a valid API key as the X-API-KEY request header.

Note

Unlike the other Firehose feeds, the Bookable Sellers feed does not use the CDN endpoint. Every page comes from firehose.imin.co, so send your API key with every request.

Using the Bookable Sellers feed with Bookable Firehose

The data object in an item in the Bookable Sellers feed will look like the following:

"data": {
  "@context": "https://openactive.io/",
  "@type": "Organization",
  "@id": "https://firehose.imin.co/sellers/premiertennis/https%3A%2F%2Fapi.premiertennis.co.uk%2Fopenactive%2Fidentifiers%2Fsellers%2F1"
}

The value of the data["@id"] property represents a Bookable Seller for you, the broker. Match it against the Seller ID in the SessionSeries and FacilityUse feeds to leave only opportunities that are bookable for you:

Feed	Where to find the Seller ID
SessionSeries	data.superEvent.organizer["@id"]. This is the organizer of its EventSeries
FacilityUse	data.provider["@id"]

An item with a state of deleted is a Seller that is no longer bookable by you.

Caution

The Sellers that are bookable by you change over time. Store this feed alongside the opportunities, and match them when you read from your datastore. Do not use this feed to discard opportunities while you harvest them. See Filtering Firehose Data.

Testing with Bookable Sellers feed

A test Bookable Sellers feed can be found by appending -test to your Broker name. For example if your broker name was acme, your test Bookable Sellers feed can be found at:

https://firehose.imin.co/firehose/bookable-sellers/acme-test

Caution

As with other feeds, you must provide a valid API key as the X-API-KEY request header.

Use this in conjunction with the test Bookable Firehose feeds in order to perform end-to-end testing against non-live data.