Class: Rubyists::Kalshi::Endpoint

Inherits:

Object

• Object
• Rubyists::Kalshi::Endpoint

Defined in:

lib/kalshi/endpoint.rb

Overview

Base class for Kalshi API endpoints

Direct Known Subclasses

Rubyists::Kalshi::Events::List, Rubyists::Kalshi::Events::Multivariate, Market::Markets, Market::Orderbook, Market::Series, Market::SeriesList, Market::Trades, Search::SeriesTags, Search::SportsFilters, Series::EventCandlesticks, Series::ForecastPercentileHistory, Series::MarketCandlesticks

Class Attribute Summary

• .endpoint_path ⇒ Object

  Returns the value of attribute endpoint_path.

Instance Attribute Summary

• #client ⇒ Object readonly

  Returns the value of attribute client.

Class Method Summary

• .kalshi_path(path) ⇒ String

  Set the endpoint path for the resource.

Instance Method Summary

• #initialize(client = nil) ⇒ void constructor

  Initialize the Endpoint.

Constructor Details

#initialize(client = nil) ⇒ void

Initialize the Endpoint

Parameters:

• client (Client) (defaults to: nil) —

  The Kalshi client

# File 'lib/kalshi/endpoint.rb', line 27

def initialize(client = nil)
  @client = client || Client.new
end

Class Attribute Details

.endpoint_path ⇒ Object

Returns the value of attribute endpoint_path.

# File 'lib/kalshi/endpoint.rb', line 10

def endpoint_path
  @endpoint_path
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.

# File 'lib/kalshi/endpoint.rb', line 7

def client
  @client
end

Class Method Details

.kalshi_path(path) ⇒ String

Set the endpoint path for the resource

Parameters:

• path (String) —

  API endpoint path

Returns:

• (String) —

  endpoint path

# File 'lib/kalshi/endpoint.rb', line 17

def kalshi_path(path)
  self.endpoint_path = path
end