Skip to content

QUICKSTART.md

Latest commit

 

History

History
78 lines (58 loc) · 2.16 KB

QUICKSTART.md

File metadata and controls

78 lines (58 loc) · 2.16 KB
Raw

Quick Start Guide

Get your Kalshi Trading Bot running in 5 minutes!

🚀 Quick Setup

1. Install Dependencies

npm install

2. Configure API Keys

  1. Copy the environment template:

    cp env.example .env

  2. Edit .env and add your Kalshi API credentials:

    KALSHI_API_KEY_ID=your_api_key_id_here
KALSHI_PRIVATE_KEY_PATH=./testKey.txt

  3. Ensure your private key file (testKey.txt) is in the project root.

3. Test the Bot

node test-bot.js

4. Start Trading

npm start

🎯 First Steps

  1. Check Status: Type status in the CLI
  2. View Strategies: Type strategies to see performance
  3. Start Trading: Type start to begin automated trading
  4. Stop Trading: Type stop to halt trading
  5. Exit: Type quit to close the application

⚠️ Important Notes

  • Demo First: The bot starts in demo mode by default
  • Trading Disabled: Set TRADING_ENABLED=true in .env for live trading
  • Risk Management: Start with small position sizes
  • Monitor Logs: Check ./logs/ directory for detailed information

🔧 Configuration Options

Setting Description Default
TRADING_ENABLED Enable/disable actual trading false
MAX_POSITION_SIZE Maximum contracts per position 100
RISK_PERCENTAGE Risk per trade (%) 2
STOP_LOSS_PERCENTAGE Stop-loss threshold (%) 5
TAKE_PROFIT_PERCENTAGE Take-profit threshold (%) 10

📊 Built-in Strategy

The bot includes a Mean Reversion Strategy that:

  • Enters positions when prices deviate from moving averages
  • Uses configurable stop-loss and take-profit levels
  • Manages risk with position sizing limits
  • Automatically closes positions based on exit conditions

🆘 Need Help?

  • Check the logs in ./logs/ directory
  • Review the full README.md
  • Ensure your API keys are correct
  • Test with demo environment first

🎉 You're Ready!

Your Kalshi Trading Bot is now configured and ready to trade. Start with demo mode to test everything works, then enable live trading when you're confident in the setup.