zerodha / pykiteconnect

The official Python client library for the Kite Connect trading APIs
MIT License
996 stars 473 forks source link

minor documentation sync up issues #159

Open avnishbm opened 2 years ago

avnishbm commented 2 years ago
  1. Python Client documentation (https://kite.trade/docs/pykiteconnect/v4): a. When trying to look at Python client documentation, it seems the documentation was not updated for some new parameters in v4 e.g. place_order() accepts validity_ttl, iceberg_legs, iceberg_quantity as additional parameters, but these do not show up in the python client documentation page (though it's updated in http api documentation): https://kite.trade/docs/pykiteconnect/v4/#kiteconnect.KiteConnect.place_order . May be the python client documentation is not updated for v4.

  2. Kite Connect HTTP API documentation(https://kite.trade/docs/connect/v3): a. The http api documentation, while updated for v4, seems to have older version breadcrumb (Kite Connect 3 / API documentation) & the path also has v3 in it: https://kite.trade/docs/connect/v3/orders/#placing-orders

b. Some parameters are not seen in http api documentation e.g. for /orders/:variety (https://kite.trade/docs/connect/v3/orders/#placing-orders), couldn't find squareoff, stoploss & trailing_stoploss parameters. It's not clear from python client documentation what values can be provided for these parameters & for which specific order_type.

c. Are squareoff & trailing_stoploss implemented? The Kite interface does not seem to provide squareoff & trailing stoploss options.