Class: SportsOddsAPI::Resources::Stream

Inherits:
Object
  • Object
show all
Defined in:
lib/sports_odds_api/resources/stream.rb,
sig/sports_odds_api/resources/stream.rbs

Overview

Get info about Events (includes odds, results, teams, and other metadata)

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Stream

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Stream.

Parameters:



37
38
39
 
# File 'lib/sports_odds_api/resources/stream.rb', line 37

def initialize(client:)
  @client = client
end

Instance Method Details

#events(event_id: nil, feed: nil, league_id: nil, request_options: {}) ⇒ SportsOddsAPI::Models::StreamEventsResponse

Setup streamed (WebSocket) connection

Parameters:

  • event_id (String) —

    An eventID to stream events for

  • feed (String) —

    The feed you would like to subscribe to

  • league_id (String) —

    A leagueID to stream events for

  • request_options (SportsOddsAPI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/sports_odds_api/resources/stream.rb', line 22

def events(params = {})
  parsed, options = SportsOddsAPI::StreamEventsParams.dump_request(params)
  query = SportsOddsAPI::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "stream/events",
    query: query.transform_keys(event_id: "eventID", league_id: "leagueID"),
    model: SportsOddsAPI::Models::StreamEventsResponse,
    options: options
  )
end