Streaming API
Overview

Streaming API


Version: 2.0

The William Hill Streaming API provides information on streaming data for events
Summary
Method Name Description Resource
getInformationForStreams This method is used to get a list of streams for a date range. https://sandbox.whapi.com/v2/streaming/streams
getStreamAvailablityForEvent This method is used to return stream availablity for an event. https://sandbox.whapi.com/v2/streaming/streams/{eventId}/availablity
Resources Expand All Collapse All
getInformationForStreams()
This method is used to get a list of streams for a date range.
Request Example
get https://sandbox.whapi.com/v2/streaming/streams?limit=20&offset=10&fields=id,name,status&include=&exclude=&dateFrom=2015-10-10T13:13:01&dateTo=2015-10-10T13:13:01 HTTP/1.1
Host: sandbox.whapi.com
Accept: application/json
apiKey: 

Request Parameters
header parameters
Name Description
apiKey*
query parameters
Name Description
limit
offset
fields
include
exclude
dateFrom*
dateTo*
Responses Expand All Collapse All
getStreamAvailablityForEvent()
This method is used to return stream availablity for an event.
Request Example
get https://sandbox.whapi.com/v2/streaming/streams/{eventId}/availablity HTTP/1.1
Host: sandbox.whapi.com
Accept: application/json
apiKey: 
countryCode: ES

Request Parameters
path parameters
Name Description
eventId*
header parameters
Name Description
apiKey*
countryCode*
Responses Expand All Collapse All
HEAD and OPTIONS
You can call the following idempotent REST methods on all version 2 APIs:

HEAD

Asks for the response identical to the one that would correspond to a GET request, but without the response body. This is useful for retrieving meta-information written in response headers, without having to transport the entire content. The metainformation contained in the HTTP headers in response to a HEAD request is identical to the information sent in response to a GET request. This method is often used for testing hypertext links for validity, accessibility, and recent modification. The response to a HEAD request may be cacheable in the sense that the information contained in the response can be used to update a previously cached entity from that resource. If the new field values indicate that the cached entity differs from the current entity (as would be indicated by a change in Content-Length, Content-MD5, ETag or Last-Modified), then the cache treats the cache entry as stale.

OPTIONS

The OPTIONS method represents a request for information about the communication options available on the request/response chain identified by the Request-URI. This method allows you to determine the options and/or requirements associated with a resource without implying a resource action or initiating a resource retrieval. Responses to this method are not cacheable. The response includes any header fields that indicate optional features. The response body also includes information about the communication options.



Copyright (c) WHG (International) Limited 2016
Generated Date: 2020-06-06T12:17:08.618+01:00
Use of this document is subject to the William Hill Partner Developer Portal Terms and Conditions.