easy_kite_methods 0.0.3

No project description provided

easy_kite_methods

The easy_kite_methods package provides a seamless interface for interacting with the Kite Connect API for stock trading on the Zerodha platform.
Kite Connect Python Client - https://kite.trade/docs/pykiteconnect/v4/ .
Kite HTTP API Documentation - https://kite.trade/docs/connect/v3/.

Installation

To install the easy_kite_methods package, run the following command:

pip install easy_kite_methods

Configuration

Before using the easy_kite_methods package, you must configure your environment with necessary API keys and secrets. Follow these steps to set up your environment:

1. Environment Variables: Store your Kite Connect API key and secret in a .env file at the root of your project. This file should contain:

   KITE_API_KEY=your_api_key_here
   KITE_API_SECRET=your_api_secret_here
   

Usage

Import the package using the alias ekm and utilize its functions for interacting with the Zerodha Kite Connect API.

Example Imports

import easy_kite_methods as ekm

Placing Orders

• Buy an Intraday Normal Order:

  order_id = ekm.buy_intraday_normal_order(stock_name="RELIANCE", quantity=1)
  

• Sell an Intraday Normal Order:

  order_id = ekm.sell_intraday_normal_order(stock_name="TCS", quantity=2)
  

• Buy an Intraday Limit Order:

  order_id = ekm.buy_intraday_limit_order(stock_name="RELIANCE", quantity=1,price=2900)
  

• Sell an Intraday Limit Order:

  order_id = ekm.sell_intraday_limit_order(stock_name="TCS", quantity=2,price=2300)
  

• Place Stop Loss Market Order:

  order_id = ekm.place_slm_order(stock_name="INFY", quantity=10, order_type="BUY", price=1500)
  

Modifying Orders

• Varieties can be [REGULAR,BO,CO,AMO]r:

  ekm.modify_order(variety="REGULAR", orderId="your_order_id_here", quantity=2, price=3550)
  

  ekm.modify_order_quantity(variety="REGULAR", order_id="order123", quantity=15)
  

  ekm.modify_order_price(variety="AMO", order_id="order123", price=1520)
  

  ekm.modify_order_to_buy(variety="CO", order_id="order123")
  

  ekm.modify_order_to_sell(variety="BO", order_id="order123")
  

Fetching Account Details

• Fetch Holdings:

  holdings = ekm.get_holdings()
  

• Fetch Positions:

  positions = ekm.get_positions()
  

• Cancel or Exit Orders:

  ekm.cancel_order(order_id="order123")
  

  ekm.exit_orders(order_id="order123")
  

Additional Useful APIS

• **Get Status and Average Price [COMPLETED,REJECTED] as an example **:

  order_status = ekm.get_status(order_id="order123")
  

  average_price,status = ekm.get_average_price_and_status(order_id="order123")
  

  order_history = ekm.get_order_history(order_id="order123")
  

Fetching Live Data

• Get Stock Price:

  stock_price = ekm.get_stock_price(name="RELIANCE")
  

• Get Stock Instrument Token:

  token = ekm.get_stock_instrument_token(stock_name="RELIANCE")
  

• Get FNO Instrument Price:

  stock_price = ekm.get_fno_price(name="BANKNIFTY24APRFUT")
  

• Get FNO Instrument Token:

  token = ekm.get_fno_instrument_token(stock_name="BANKNIFTY24APRFUT")