GitHub – zerodha/javakiteconnect: The official Java client for communicating with Kite Connect API. – Latest commit

Looking for:

Zerodha api documentation

Click here to Download


The order APIs let you place orders of different varities, modify and cancel pending orders, retrieve the daily order and more. This does not guarantee the order\’s receipt at the exchange. The fate of an order is dependent on several factors including market hours, availability of funds, risk checks and so on. Under normal circumstances, order placement, receipt by the OMS, transport to the exchange, execution, and the confirmation roundtrip happen instantly.

The status of the order is not known at the moment of placing because of the aforementioned reasons. In case of non-MARKET orders that may be open indefinitely during the course of a trading day, it is not practical to poll the order APIs continuously to know the status.

For this, postbacks are ideal as they sent order updates asynchronously as they happen. Successful placement of an order via the API does not imply its successful execution.

You can place orders of different varieties—regular orders, after market orders, cover orders, iceberg orders etc. See the list of varieties here. As long as on order is open or pending in the system, certain attributes of it may be modified. It is important to sent the right value for :variety in the URL. The order history or the order book is transient as it only lives for a day in the system. When you retrieve orders, you get all the orders for the day including open, pending, and executed ones.

The status field in the order response shows the current state of the order. The status values are largely self explanatory. An order can traverse through several interim and temporary statuses during its lifetime.

For example, when an order is first placed or modified, it instantly passes through several stages before reaching its end state. Some of these are highlighted below. The tag field comes in handy here. It let\’s you send an arbitrary string while placing an order.

This can be a unique ID, or something that indicates a particular type or context, for example. When the orderbook is retrieved, this value will be present in the tag field in the response. Cover orders are \”multi-legged\” orders, where, a single order you place first-leg may spawn new orders second-leg based on the conditions you set on the first-leg order. These orders have special properties, where the first-leg order creates a position.

The position is exited when the second-leg order is executed or cancelled. This field may be required while modifying or cancelling an open second-leg order. Every order, right after being placed, goes through multiple stages internally in the OMS. In addition, an open order, when modified, again goes through these stages. While an orders is sent as a single entity, it may be executed in arbitrary chunks at the exchange depending on market conditions.

For instance, an order for 10 quantity of an instrument can be executed in chunks of 5, 1, 1, 3 or any such combination. Each individual execution that fills an order partially is a trade. An order may have one or more trades.

Skip to content. Table of contents Glossary of constants Placing orders Order varieties Regular order parameters Modifying orders Regular order parameters Cover order CO parameters Cancelling orders Retrieving orders Response attributes Order statuses Tagging orders Multi-legged orders CO Retrieving an order\’s history Retrieving all trades Response attributes Retrieving an order\’s trades.

SL-M Stoploss-market order? NRML Normal for futures and options? Required margin is Check the orderbook for open orders. Cover Order? Iceberg Order?

Stoploss order? Stoploss-market order? Normal for futures and options? Margin Intraday Squareoff for futures and options? Margin product to use for the order margins are blocked based on this? Total number of legs for iceberg order type number of legs per Iceberg should be between 2 and ID of the user that placed the order. This may different from the user\’s ID for orders placed outside of Kite, for instance, by dealers at the brokerage using dealer terminals. Current status of the order.

There may be other values as well. The numerical identifier issued by the exchange representing the instrument. Used for subscribing to live market data over WebSocket.

Quantity to be disclosed may be different from actual quantity to the public exchange orderbook. Only for equities. Timestamp at which the order was registered by the exchange. Orders that don\’t reach the exchange have null timestamps.



Zerodha api documentation

Kite Connect API client for Python — Zerodha Technology Pvt. Execute orders in real time, manage user portfolio, stream live market data (WebSockets), and more, with the simple HTTP API collection. Zerodha Technology (c).


More Insights


Visit the link below and find a chapter near you.