kalshi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9629748b750216c1b4e3bbd22458dd85dd0fea94c9e64a5b624aadb2e1e04112
+  data.tar.gz: d9c999475615530d0e7a9238cff6f083df704eaac1b55ec14f298dd9e7e51153
+SHA512:
+  metadata.gz: bca603a43360c6e46b43bbdea8e24f45f4c0fe06a32be5fbcc38b86259c3b65fdc1d70b9b958ac711e8811f6f001e5234271502078ff9a789f9bb475848a319b
+  data.tar.gz: f2cac3252e09ccf560a9a9553e95572c420352414f64422bed7bc1e7b1cc4131e131473ac198c43158d934bad361a5ecd08f5f9eba8e15922dc257d74c3d4865

data/.release-please-config.json

@@ -0,0 +1,28 @@
+{
+  "packages": {
+    ".": {
+      "changelog-path": "CHANGELOG.md",
+      "release-type": "simple",
+      "bump-minor-pre-major": true,
+      "bump-patch-for-minor-pre-major": true,
+      "draft": false,
+      "prerelease": false,
+      "version-file": ".version.txt",
+      "extra-files": [
+        {
+          "type": "generic",
+          "path": "lib/kalshi/version.rb"
+        }
+      ],
+      "exclude-paths": [
+        ".release-please-manifest.json",
+        ".version.txt",
+        "lib/kalshi/version.rb",
+        ".rubocop.yml",
+        ".overcommit.yml",
+        "coverage/coverage.json"
+      ]
+    }
+  },
+  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
+}

data/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.1.0"
+}

data/CHANGELOG.md

@@ -0,0 +1,46 @@
+# Changelog
+
+## [0.1.0](https://github.com/rubyists/kalshi/compare/v0.0.5...v0.1.0) (2026-01-05)
+
+
+### ⚠ BREAKING CHANGES
+
+* corrects gemspec source code uri ([#15](https://github.com/rubyists/kalshi/issues/15))
+
+### Bug Fixes
+
+* corrects gemspec source code uri ([#15](https://github.com/rubyists/kalshi/issues/15)) ([2a69255](https://github.com/rubyists/kalshi/commit/2a69255fdca48bda599b19d5aa9649eca6effe34))
+
+## [0.0.5](https://github.com/rubyists/kalshi/compare/v0.0.4...v0.0.5) (2026-01-05)
+
+
+### Features
+
+* adds series event lookup, and events/ endpoints ([#13](https://github.com/rubyists/kalshi/issues/13)) ([a9fcb72](https://github.com/rubyists/kalshi/commit/a9fcb72724e5e1a51be8671d96bf58514d14904c))
+
+
+### Bug Fixes
+
+* correct path to filter_by_sport, adds ApiClient helper ([#8](https://github.com/rubyists/kalshi/issues/8)) ([a608fbe](https://github.com/rubyists/kalshi/commit/a608fbe0e88ad2678dc3ba84ba8198121e1d29aa))
+* renamed #get_without_prefix to #get_url for clarity ([#11](https://github.com/rubyists/kalshi/issues/11)) ([a641a5f](https://github.com/rubyists/kalshi/commit/a641a5f187ba2d42d1e4637fe599e63ea34fd4d8))
+
+## [0.0.4](https://github.com/rubyists/kalshi/compare/v0.0.3...v0.0.4) (2026-01-05)
+
+
+### Features
+
+* adds search endpoints ([#6](https://github.com/rubyists/kalshi/issues/6)) ([d29aa7d](https://github.com/rubyists/kalshi/commit/d29aa7d01d4ac83c5eec9303afb03fe1e47ec056))
+
+## [0.0.3](https://github.com/rubyists/kalshi/compare/v0.0.2...v0.0.3) (2026-01-05)
+
+
+### Features
+
+* adds all market/ endpoints ([#4](https://github.com/rubyists/kalshi/issues/4)) ([b7bd5a7](https://github.com/rubyists/kalshi/commit/b7bd5a7273db51ac829cbb384a684918b08edac1))
+
+## [0.0.2](https://github.com/rubyists/kalshi/compare/v0.0.1...v0.0.2) (2026-01-04)
+
+
+### Features
+
+* initial structure ([e102a98](https://github.com/rubyists/kalshi/commit/e102a982f8e3ad9e4ee39b31f32970d3bdee0414))

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.ruby_opts = %w[-rhelper]
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[rubocop test]

data/Readme.adoc

@@ -0,0 +1,231 @@
+= Kalshi
+:toc: macro
+:icons: font
+
+Ruby client for the Kalshi API.
+
+== Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+[source,bash]
+----
+bundle add kalshi
+----
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+[source,bash]
+----
+gem install kalshi
+----
+
+== Usage
+
+=== Configuration
+
+Configure the gem with your API key (optional for public endpoints). You can set it via the `KALSHI_API_KEY` environment variable or configure it explicitly:
+
+[source,ruby]
+----
+Rubyists::Kalshi.configure do |config|
+  config.api_key = 'your_api_key'
+  config.base_url = 'https://api.elections.kalshi.com/trade-api/v2' # Default
+end
+----
+
+=== Client
+
+Initialize the client:
+
+[source,ruby]
+----
+client = Rubyists::Kalshi.client
+----
+
+=== Market
+
+Access Market endpoints via the `market` namespace.
+
+==== Series List
+
+https://docs.kalshi.com/api-reference/market/get-series-list[API Reference]
+
+List series with optional filtering:
+
+[source,ruby]
+----
+# List series with default filter
+series_list = client.market.series_list.list
+
+# List series with custom filter
+series_list = client.market.series_list.list(category: 'Sports', tags: 'Football')
+----
+
+==== Series
+
+https://docs.kalshi.com/api-reference/market/get-series[API Reference]
+
+Get a specific series by ticker:
+
+[source,ruby]
+----
+series = client.market.series.fetch('KX-SERIES')
+----
+
+==== Markets
+
+https://docs.kalshi.com/api-reference/market/get-markets[API Reference]
+
+List markets with optional filtering:
+
+[source,ruby]
+----
+# List markets with default filter
+markets = client.market.markets.list
+
+# List markets with custom filter
+markets = client.market.markets.list(status: 'open', limit: 10)
+----
+
+Get a specific market by ticker:
+
+[source,ruby]
+----
+market = client.market.markets.fetch('KX-MARKET')
+----
+
+==== Orderbook
+
+https://docs.kalshi.com/api-reference/market/get-market-orderbook[API Reference]
+
+Get the orderbook for a market:
+
+[source,ruby]
+----
+# Get full orderbook
+orderbook = client.market.orderbook.fetch('KX-MARKET')
+
+# Get orderbook with specific depth
+orderbook = client.market.orderbook.fetch('KX-MARKET', depth: 10)
+----
+
+==== Trades
+
+https://docs.kalshi.com/api-reference/market/get-trades[API Reference]
+
+List trades with optional filtering:
+
+[source,ruby]
+----
+# List trades with default filter
+trades = client.market.trades.list
+
+# List trades with custom filter
+trades = client.market.trades.list(ticker: 'KX-MARKET', limit: 100)
+----
+
+==== Candlesticks
+
+https://docs.kalshi.com/api-reference/market/get-market-candlesticks[API Reference]
+
+Get candlesticks for a market:
+
+[source,ruby]
+----
+candlesticks = client.market.candlesticks.fetch(
+  series_ticker: 'KX-SERIES',
+  ticker: 'KX-MARKET',
+  start_ts: 1600000000,
+  end_ts: 1600000060,
+  period_interval: 1
+)
+----
+
+https://docs.kalshi.com/api-reference/market/batch-get-market-candlesticks[API Reference]
+
+Get candlesticks for multiple markets:
+
+[source,ruby]
+----
+candlesticks = client.market.candlesticks.batch(
+  tickers: ['KX-MARKET-1', 'KX-MARKET-2'],
+  series_ticker: 'KX-SERIES',
+  start_ts: 1600000000,
+  end_ts: 1600000060,
+  period_interval: 1
+)
+----
+
+=== Search
+
+Access Search endpoints via the `search` namespace.
+
+==== Tags by Category
+
+https://docs.kalshi.com/api-reference/search/get-tags-for-series-categories[API Reference]
+
+Get tags organized by series categories:
+
+[source,ruby]
+----
+tags = client.search.tags_by_categories
+----
+
+==== Filters by Sport
+
+https://docs.kalshi.com/api-reference/search/get-filters-for-sports[API Reference]
+
+Get filters organized by sport:
+
+[source,ruby]
+----
+filters = client.search.filters_by_sport
+----
+
+=== WebSocket Client
+
+A raw WebSocket client is included in `bin/wss-raw` for testing connection and subscription.
+
+IMPORTANT: This script requires the https://www.passwordstore.org/[`pass`] password manager to be installed and configured. It expects the API key on the first line and the PEM private key starting from the third line of the pass entry.
+
+NOTE: If you aren't using `pass` yet, you should! It works on Windows, Android, macOS, Linux, and everything else. It is the standard unix password manager.
+
+[source,bash]
+----
+# Set up your pass entry at the default path
+printf '%s\n\n%s\n' "$API_KEY" "$PEM_PRIVATE_KEY" | pass insert -m kalshi/api/initial-dev-ro
+
+# Default pass path: kalshi/api/initial-dev-ro
+./bin/wss-raw
+
+# Set up your pass entry at a custom path
+printf '%s\n\n%s\n' "$API_KEY" "$PEM_PRIVATE_KEY" | pass insert -m my/custom/path
+
+# Override pass path
+KALSHI_PASS_PATH=my/custom/path ./bin/wss-raw
+----
+
+[IMPORTANT]
+.The "$PEM_PRIVATE_KEY" must include the BEGIN and END lines
+====
+For example:
+
+[source]
+----
+-----BEGIN RSA PRIVATE KEY-----
+MIIEvQIBADANBgkqhkiG9w0BAQEFAASC...
+-----END RSA PRIVATE KEY-----
+----
+====
+
+
+== Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rubyists/kalshi.

data/ci/build_image.sh

@@ -0,0 +1,248 @@
+#!/usr/bin/env bash
+
+if readlink -f . >/dev/null 2>&1 # {{{ makes readlink work on mac
+then
+    readlink=readlink
+else
+    if greadlink -f . >/dev/null 2>&1
+    then
+        readlink=greadlink
+    else
+        printf "You must install greadlink to use this (brew install coreutils)\n" >&2
+    fi
+fi # }}}
+
+# Set here to the full path to this script
+me=${BASH_SOURCE[0]}
+[ -L "$me" ] && me=$($readlink -f "$me")
+here=$(cd "$(dirname "$me")" && pwd)
+just_me=$(basename "$me")
+
+repo_top=$(git rev-parse --show-toplevel)
+cd "$repo_top" || {
+    printf "Could not cd to %s\n" "$repo_top" >&2
+    exit 1
+}
+
+base_dir=$(basename "$(pwd)")
+: "${BUILD_CONTEXT:=$(pwd)}"
+: "${IMAGE_NAME:=$base_dir}"
+: "${LICENSE:=MIT}"
+: "${APP_VERSION:=$(< "$here"/../.version.txt)}"
+: "${REGISTRY:=ghcr.io}"
+: "${REGISTRY_TOKEN:=$GITHUB_TOKEN}"
+
+usage() { # {{{
+    cat <<-EOT
+    Build an image, optionally pushing it to the registry
+
+    Usage: $0 <options> <image_tag>
+        Options:
+            -c CONTAINERFILE  Path to the containerfile (default: ./oci/Containerfile)
+            -C CONTEXT        Build context (default: $BUILD_CONTEXT)
+            -i NAME           Name of the image (default: $IMAGE_NAME)
+            -l LICENSE        License of the image (default: $LICENSE)
+            -r REGISTRY       Registry to push the image to when -p is given (default: $REGISTRY)
+            -p                Push the image to the registry
+            -h                Show help / usage
+EOT
+} # }}}
+
+die() { # {{{
+    local -i code
+    code=$1
+    shift
+    error "$*"
+    printf "\n" >&2
+    usage >&2
+    # shellcheck disable=SC2086
+    exit $code
+} # }}}
+
+## Logging functions # {{{
+log() { # {{{
+    printf "%s [%s] <%s> %s\n" "$(date '+%Y-%m-%d %H:%M:%S.%6N')" "$$" "${just_me:-$0}" "$*"
+} # }}}
+
+debug() { # {{{
+    [ $verbose -lt 2 ] && return 0
+    # shellcheck disable=SC2059
+    log_line=$(printf "$@")
+    log "[DEBUG] $log_line" >&2
+} # }}}
+
+warn() { # {{{
+    # shellcheck disable=SC2059
+    log_line=$(printf "$@")
+    log "[WARN] $log_line" >&2
+} # }}}
+
+error() { # {{{
+    # shellcheck disable=SC2059
+    log_line=$(printf "$@")
+    log "[ERROR] $log_line" >&2
+} # }}}
+
+info() { # {{{
+    [ $verbose -lt 1 ] && return 0
+    # shellcheck disable=SC2059
+    log_line=$(printf "$@")
+    log "[INFO] $log_line" >&2
+} # }}}
+# }}}
+
+push=0
+verbose=0
+while getopts :hpvc:C:i:l:r: opt # {{{
+do
+    case $opt in
+        c)
+            CONTAINERFILE=$OPTARG
+            ;;
+        C)
+            BUILD_CONTEXT=$OPTARG
+            ;;
+        i)
+            IMAGE_NAME=$OPTARG
+            ;;
+        l)
+            LICENSE=$OPTARG
+            ;;
+        r)
+            REGISTRY=$OPTARG
+            ;;
+        p)
+            push=1
+            ;;
+        v)
+            verbose=$((verbose + 1))
+            ;;
+        h)
+            usage
+            exit
+            ;;
+        :)
+            printf "Option %s requires an argument\n" "$OPTARG" >&2
+            usage >&2
+            exit 28
+            ;;
+        ?)
+            printf "Invalid option '%s'\n" "$OPTARG" >&2
+            usage >&2
+            exit 27
+            ;;
+    esac
+done # }}}
+shift $((OPTIND-1))
+
+tag=$1
+[ -z "$tag" ] && die 1 "Missing image tag"
+shift
+
+# Check for extra argument
+if [ $# -gt 0 ]; then
+    # If we have the special argument '--' we shift it away, otherwise we die
+    [ "$1" != '--' ] && die 2 "Too many arguments"
+    # Once this is shifted away, the rest of the arguments are passed to the build command, below
+    shift
+fi
+
+if [ -z "$CONTAINERFILE" ]; then
+    printf "No containerfile specified, looking for default locations\n"
+    for containerfile in Containerfile Dockerfile
+    do
+        if [ -f ./oci/"$containerfile" ]; then
+            debug "Found ./oci/%s\n" "$containerfile"
+            containerfile=./oci/"$containerfile"
+            break
+        fi
+        if [ -f "$containerfile" ]; then
+            debug "Found %s\n" "$containerfile"
+            break
+        fi
+    done
+else
+    [ -f "$CONTAINERFILE" ] || die 3 "Containerfile '$CONTAINERFILE' not found"
+    debug "Using containerfile %s\n" "$CONTAINERFILE"
+    containerfile=$CONTAINERFILE
+fi
+
+[ -f "$containerfile" ] || die 4 "No containerfile found"
+
+[ -d "$BUILD_CONTEXT" ] || die 5 "Build context '$BUILD_CONTEXT' not found"
+
+debug 'Building image from %s in in %s\n' "$containerfile" "$here"
+# Build the image
+if command -v podman 2>/dev/null
+then
+    runtime=podman
+elif command -v docker 2>/dev/null
+then
+    runtime=docker
+else
+    die 6 "No container runtime found"
+fi
+
+revision=$(git rev-parse HEAD)
+shortref=$(git rev-parse --short "$revision")
+repo_url=$(git remote get-url origin)
+if [ -z "$repo_url" ]
+then
+    die 7 "No remote found"
+fi
+if [[ $repo_url == *github.com/* ]]
+then
+    owner_and_repo=${repo_url#*github.com/}
+else
+    owner_and_repo=${repo_url##*:}
+fi
+# Get rid of the trailing .git
+service=$(basename "$owner_and_repo" .git)
+owner=$(dirname "$owner_and_repo")
+
+full_tag=$IMAGE_NAME:$tag
+created=$(date --utc --iso-8601=seconds 2>/dev/null || gdate --utc --iso-8601=seconds)
+# Pass any extra arguments to the build command ("$@" contains the rest of the arguments)
+$runtime build --tag "$full_tag" "$@" \
+               --label org.opencontainers.image.created="$created" \
+               --label org.opencontainers.image.description="Image for $service" \
+               --label org.opencontainers.image.licenses="$LICENSE" \
+               --label org.opencontainers.image.revision="$revision" \
+               --label org.opencontainers.image.url="$repo_url" \
+               --label org.opencontainers.image.title="$IMAGE_NAME" \
+               --label org.opencontainers.image.source="Generated by ruby-automation's build_image.sh ($USER@$HOSTNAME)" \
+               --label org.opencontainers.image.version="$full_tag" \
+               --label shortref="$shortref" \
+               --build-arg APP_VERSION="$APP_VERSION" \
+               -f "$containerfile" "$BUILD_CONTEXT" || die 8 "Failed to build image"
+
+[ $push -eq 1 ] || exit 0
+if ! $runtime login --get-login "$REGISTRY" >/dev/null 2>/dev/null
+then
+    printf "Not logged in to '%s', trying to login\n" "$REGISTRY" >&2
+    [ -z "$REGISTRY_TOKEN" ] && die 9 "No REGISTRY_TOKEN (nor GITHUB_TOKEN) set, cannot login"
+    printf "%s" "$REGISTRY_TOKEN" | $runtime login -u "$REGISTRY_TOKEN" --password-stdin "$REGISTRY" || die 10 "Failed to login to $REGISTRY"
+fi
+
+# Split 1.2.3 into 1.2.3, 1.2, 1. We want to tag our image with all 3 of these
+mapfile -t tags < <(echo "$tag" | awk -F'.' 'NF==3{print; print $1"."$2; print $1; next} NF==2{print; print $1; next} {print}')
+for t in "${tags[@]}"
+do
+    new_tag=$IMAGE_NAME:$t
+    registry_image_name="$REGISTRY/$owner/$new_tag"
+    if [ "$runtime" = "podman" ]
+    then
+        if [ "$full_tag" != "$new_tag" ]
+        then
+            debug "Tagging %s as %s\n" "$full_tag" "$new_tag"
+            podman tag "$full_tag" "$new_tag" || die 11 "Failed to tag image $full_tag as $new_tag"
+        fi
+        podman push "$new_tag" "$registry_image_name" || die 12 "Failed to push image $new_tag to $registry_image_name"
+    else
+        debug "Tagging %s as %s\n" "$full_tag" "$registry_image_name"
+        docker tag "$full_tag" "$registry_image_name" || die 13 "Failed to tag image $full_tag as $registry_image_name"
+        docker push "$registry_image_name" || die 14 "Failed to push image $new_tag to $registry_image_name"
+    fi
+done
+
+# vim: set foldmethod=marker et ts=4 sts=4 sw=4 ft=bash :

data/ci/publish-gem.sh

@@ -0,0 +1,91 @@
+#!/usr/bin/env bash
+
+if readlink -f . >/dev/null 2>&1 # {{{ makes readlink work on mac
+then
+    readlink=readlink
+else
+    if greadlink -f . >/dev/null 2>&1
+    then
+        readlink=greadlink
+    else
+        printf "You must install greadlink to use this (brew install coreutils)\n" >&2
+    fi
+fi # }}}
+
+# Set here to the full path to this script
+me=${BASH_SOURCE[0]}
+[ -L "$me" ] && me=$($readlink -f "$me")
+here=$(cd "$(dirname "$me")" && pwd)
+root=$(cd "$here/.." && pwd)
+just_me=$(basename "$me")
+
+: "${GEM_NAME:=kalshi}"
+: "${GIT_ORG:=rubyists}"
+
+GEM_HOST=$1
+: "${GEM_HOST:=rubygems}"
+
+case "$GEM_HOST" in
+    rubygems)
+        gem_key='rubygems'
+        gem_host='https://rubygems.org'
+        ;;
+    github)
+        gem_key='github'
+        gem_host="https://rubygems.pkg.github.com/$GIT_ORG"
+        # Replace the gem host in the gemspec, so it allows pushing to the GitHub package registry
+        sed --in-place=.bak -e "s|https://rubygems.org|https://rubygems.pkg.github.com/$GIT_ORG|" "$here/../$GEM_NAME".gemspec
+        # Restore the original gemspec after the script finishes
+        trap 'mv -v "$here/../$GEM_NAME".gemspec.bak "$here/../$GEM_NAME".gemspec' EXIT
+        ;;
+    *)
+        printf 'Unknown GEM_HOST: %s\n' "$GEM_HOST" >&2
+        exit 1
+        ;;
+esac
+
+# We only want this part running in CI, with no ~/.gem dir
+# For local testing, you should have a ~/.gem/credentials file with
+# the keys you need to push to rubygems or github
+if [ ! -d ~/.gem ]
+then
+    if [ -z "$GEM_TOKEN" ]
+    then
+        printf 'No GEM_TOKEN provided, cannot publish\n' >&2
+        exit 1
+    fi
+    mkdir -p ~/.gem
+    printf '%s\n:%s: %s\n' '---' "$gem_key" "$GEM_TOKEN" > ~/.gem/credentials
+    chmod 600 ~/.gem/credentials
+fi
+
+bundle exec gem build
+
+if [ -f "$here"/../.version.txt ]
+then
+    version=$(<"$here"/../.version.txt)
+else
+    version=$(git describe --tags --abbrev=0 | sed -e 's/^v//')
+fi
+
+if [ -z "$version" ]
+then
+    gem="$(ls "$root"/"$GEM_NAME"-*.gem | tail -1)"
+else
+    gem="$(printf '%s/%s-%s.gem' "$root" "$GEM_NAME" "$version")"
+fi
+
+if [ ! -f "$gem" ]
+then
+    printf 'No gem file found: %s\n' "$gem" >&2
+    exit 1
+fi
+
+if [[ "${TRACE:-false}" == true || "${ACTIONS_STEP_DEBUG:-false}" == true ]]
+then
+    printf "DEBUG: [%s] Building And Publishing %s to %s\n" "$just_me" "$gem" "$gem_host" >&2
+fi
+
+bundle exec gem push -k "$gem_key" --host "$gem_host" "$(basename "$gem")"
+
+# vim: set foldmethod=marker et ts=4 sts=4 sw=4 ft=bash :