feat: adds series event lookup, and events/ endpoints (#13)

* feat: adds event listing and searching

* adds series path and events lookup

* feat: adds series path and events lookup

Author: bougyman

lib/kalshi/client.rb

@@ -57,10 +57,20 @@ def search
         @search ||= Search::Client.new(clone)
       end
 
+      def events
+        @events ||= Events::Client.new(clone)
+      end
+
+      def series
+        @series ||= Series::Client.new(clone)
+      end
+
       private
 
       def full_url(path)
-        File.join(*[base_url, prefix, path].compact)
+        parts = [base_url, prefix, path].compact
+        parts.reject!(&:empty?)
+        File.join(*parts)
       end
 
       def handle_response(response)

lib/kalshi/endpoint.rb

@@ -6,6 +6,19 @@ module Kalshi
     class Endpoint
       attr_reader :client
 
+      class << self
+        attr_accessor :endpoint_path
+
+        # Set the endpoint path for the resource
+        #
+        # @param path [String] API endpoint path
+        #
+        # @return [String] endpoint path
+        def kalshi_path(path)
+          self.endpoint_path = path
+        end
+      end
+
       # Initialize the Endpoint
       #
       # @param client [Client] The Kalshi client

lib/kalshi/events/client.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Rubyists
+  module Kalshi
+    module Events
+      # Events API Client
+      class Client < ApiClient
+        def list(...)
+          List.new(client).list(...)
+        end
+
+        def fetch(...)
+          List.new(client).fetch(...)
+        end
+
+        def metadata(...)
+          List.new(client).metadata(...)
+        end
+
+        def multivariate
+          Multivariate.new(client)
+        end
+
+        def candlesticks
+          Rubyists::Kalshi::Series::EventCandlesticks.new(client)
+        end
+      end
+    end
+  end
+end

lib/kalshi/events/list.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Rubyists
+  module Kalshi
+    module Events
+      # Events API endpoint
+      class List < Kalshi::Endpoint
+        include Kalshi::Listable
+
+        kalshi_path ''
+
+        # Filter for Kalshi events list
+        class Filter < Kalshi::Contract
+          propertize(%i[limit cursor status series_ticker with_nested_markets])
+
+          validation do
+            params do
+              optional(:limit).maybe(:integer)
+              optional(:cursor).maybe(:string)
+              optional(:status).maybe(:string)
+              optional(:series_ticker).maybe(:string)
+              optional(:with_nested_markets).maybe(:bool)
+            end
+          end
+        end
+
+        def fetch(event_ticker)
+          client.get(event_ticker)
+        end
+
+        def metadata(event_ticker)
+          client.get("#{event_ticker}/metadata")
+        end
+      end
+    end
+  end
+end

lib/kalshi/events/multivariate.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Rubyists
+  module Kalshi
+    module Events
+      # Multivariate Events API endpoint
+      class Multivariate < Kalshi::Endpoint
+        include Kalshi::Listable
+
+        kalshi_path 'multivariate'
+
+        # Filter for Kalshi multivariate events list
+        class Filter < Kalshi::Contract
+          propertize(%i[limit cursor series_ticker collection_ticker])
+
+          validation do
+            params do
+              optional(:limit).maybe(:integer)
+              optional(:cursor).maybe(:string)
+              optional(:series_ticker).maybe(:string)
+              optional(:collection_ticker).maybe(:string)
+            end
+          end
+        end
+      end
+    end
+  end
+end

lib/kalshi/listable.rb

@@ -10,17 +10,6 @@ def self.included(base)
 
       # Class methods for Listable
       module ClassMethods
-        attr_accessor :endpoint_path
-
-        # Set the endpoint path for the resource
-        #
-        # @param path [String] API endpoint path
-        #
-        # @return [String] endpoint path
-        def kalshi_path(path)
-          self.endpoint_path = path
-        end
-
         def list(...)
           new.list(...)
         end

lib/kalshi/market/client.rb

@@ -32,7 +32,7 @@ def trades
         end
 
         def candlesticks
-          @candlesticks ||= Candlesticks.new(client)
+          @candlesticks ||= Rubyists::Kalshi::Series::MarketCandlesticks.new(client)
         end
       end
     end

lib/kalshi/series/client.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Rubyists
+  module Kalshi
+    module Series
+      # Series API Client
+      class Client < ApiClient
+        def event_candlesticks
+          EventCandlesticks.new(client)
+        end
+
+        def forecast_percentile_history
+          ForecastPercentileHistory.new(client)
+        end
+      end
+    end
+  end
+end

lib/kalshi/series/event_candlesticks.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Rubyists
+  module Kalshi
+    module Series
+      # Event Candlesticks API endpoint
+      class EventCandlesticks < Kalshi::Endpoint
+        # Filter for Event Candlesticks
+        class EventFilter < Kalshi::Contract
+          propertize(%i[series_ticker ticker start_ts end_ts period_interval])
+
+          validation do
+            params do
+              required(:series_ticker).filled(:string)
+              required(:ticker).filled(:string)
+              required(:start_ts).filled(:integer)
+              required(:end_ts).filled(:integer)
+              required(:period_interval).filled(:integer)
+            end
+          end
+        end
+
+        def fetch(params)
+          filter = EventFilter.new(EventFilter::Properties.new(**params))
+          raise ArgumentError, filter.errors.full_messages.join(', ') unless filter.validate({})
+
+          path = "#{filter.series_ticker}/events/#{filter.ticker}/candlesticks"
+          query_params = filter.to_h.slice('start_ts', 'end_ts', 'period_interval')
+          client.get(path, params: query_params)
+        end
+      end
+    end
+  end
+end

lib/kalshi/series/forecast_percentile_history.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Rubyists
+  module Kalshi
+    module Series
+      # Event Forecast Percentile History API endpoint
+      class ForecastPercentileHistory < Kalshi::Endpoint
+        # Filter for Event Forecast Percentile History
+        class EventFilter < Kalshi::Contract
+          propertize(%i[series_ticker ticker percentiles start_ts end_ts period_interval])
+
+          validation do
+            params do
+              required(:series_ticker).filled(:string)
+              required(:ticker).filled(:string)
+              required(:percentiles).filled(:array)
+              required(:start_ts).filled(:integer)
+              required(:end_ts).filled(:integer)
+              required(:period_interval).filled(:integer)
+            end
+          end
+        end
+
+        def fetch(params)
+          filter = EventFilter.new(EventFilter::Properties.new(**params))
+          raise ArgumentError, filter.errors.full_messages.join(', ') unless filter.validate({})
+
+          path = "#{filter.series_ticker}/events/#{filter.ticker}/forecast_percentile_history"
+          query_params = filter.to_h.slice('start_ts', 'end_ts', 'period_interval')
+          query_params[:percentiles] = filter.percentiles.join(',')
+          client.get(path, params: query_params)
+        end
+      end
+    end
+  end
+end