Skip to content

Latest commit

 

History

History
44 lines (32 loc) · 1.48 KB

README.md

File metadata and controls

44 lines (32 loc) · 1.48 KB

Kalshi CLI tool

Enables CLI interaction with Kalshi's trading api. Supported operations include:

  • Retrieve all markets
  • Retrieve individual market by ID
  • Retrieve user positions
  • Place order (with custom expiration, not supported via UI)

Kalshi docs

Setup

WIP

Usage

kalshi help - lists usages within CLI
Placing Orders
kalshi buy -a <amount> -id <marketId> -p <price> -s <side> -e <expiration> -max <maxCost> -sellCap <sellPositionCapped> 
kalshi sell -a <amount> -id <marketId> -p <price> -s <side> -e <expiration> -max <maxCost> -sellCap <sellPositionCapped>

There are no "buy" and "sell" orders in kalshi, you can buy shares on one side, or you can buy the opposite side to close a position (see the site for more details). The sell command, therefore, attempts to place an order to "close", or buy a contract on the opposite side that you offer (all contracts are yes/no binaries)

Retrieving Markets
kalshi getMarket -id <id>
kalshi getMarkets
Retrieving Positions
kalshi positions

Notes

This tool is still a WIP. Outstanding items include:

  • Supporting new Kalshi API methods
  • Using local json to map ticker to market ID for methods dependent on market ID
  • Additional test coverage
  • Pretty print orderbook
  • Pretty print market bids for cached markets
  • Add addtional arguments for methods not currently supported

Contributing: