Skip to content

Commit e327320

Browse files
authored
Updated readme
1 parent 1afef8b commit e327320

File tree

1 file changed

+24
-25
lines changed

1 file changed

+24
-25
lines changed

README.md

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ The official Java client for communicating with [Kite Connect API](https://kite.
33

44
Kite Connect is a set of REST-like APIs that expose many capabilities required to build a complete investment and trading platform. Execute orders in real time, manage user portfolio, stream live market data (WebSockets), and more, with the simple HTTP API collection.
55

6-
[Zerodha Technology Pvt Ltd](http://rainmatter.com) (c) 2016. Licensed under the MIT License.
6+
[Zerodha Technology Pvt Ltd](http://rainmatter.com) (c) 2018. Licensed under the MIT License.
77

88
## Documentation
99
- [Kite Connect HTTP API documentation](https://kite.trade/docs/connect/v3/)
@@ -49,29 +49,28 @@ System.out.println(margins.available.cash);
4949
System.out.println(margins.utilised.debits);
5050

5151
/** Place order method requires a orderParams argument which contains,
52-
* tradingsymbol, exchange, transaction_type, order_type, quantity, product, price, trigger_price, disclosed_quantity, validity
53-
* squareoff_value, stoploss_value, trailing_stoploss
54-
* and variety (value can be regular, bo, co, amo)
55-
* place order will return order model which will have only orderId in the order model
56-
*
57-
* Following is an example param for LIMIT order,
58-
* if a call fails then KiteException will have error message in it
59-
* Success of this call implies only order has been placed successfully, not order execution. */
60-
61-
OrderParams orderParams = new OrderParams();
62-
orderParams.quantity = 1;
63-
orderParams.orderType = Constants.ORDER_TYPE_LIMIT;
64-
orderParams.tradingsymbol = "ASHOKLEY";
65-
orderParams.product = Constants.PRODUCT_CNC;
66-
orderParams.exchange = Constants.EXCHANGE_NSE;
67-
orderParams.transactionType = Constants.TRANSACTION_TYPE_BUY;
68-
orderParams.validity = Constants.VALIDITY_DAY;
69-
orderParams.price = 122.2;
70-
orderParams.triggerPrice = 0.0;
71-
orderParams.tag = "myTag"; //tag is optional and it cannot be more than 8 characters and only alphanumeric is allowed
72-
73-
Order order = kiteConnect.placeOrder(orderParams, Constants.VARIETY_REGULAR);
74-
System.out.println(order.orderId);
52+
* tradingsymbol, exchange, transaction_type, order_type, quantity, product, price, trigger_price, disclosed_quantity, validity
53+
* squareoff_value, stoploss_value, trailing_stoploss
54+
* and variety (value can be regular, bo, co, amo)
55+
* place order will return order model which will have only orderId in the order model
56+
* Following is an example param for LIMIT order,
57+
* if a call fails then KiteException will have error message in it
58+
* Success of this call implies only order has been placed successfully, not order execution. */
59+
60+
OrderParams orderParams = new OrderParams();
61+
orderParams.quantity = 1;
62+
orderParams.orderType = Constants.ORDER_TYPE_LIMIT;
63+
orderParams.tradingsymbol = "ASHOKLEY";
64+
orderParams.product = Constants.PRODUCT_CNC;
65+
orderParams.exchange = Constants.EXCHANGE_NSE;
66+
orderParams.transactionType = Constants.TRANSACTION_TYPE_BUY;
67+
orderParams.validity = Constants.VALIDITY_DAY;
68+
orderParams.price = 122.2;
69+
orderParams.triggerPrice = 0.0;
70+
orderParams.tag = "myTag"; //tag is optional and it cannot be more than 8 characters and only alphanumeric is allowed
71+
72+
Order order = kiteConnect.placeOrder(orderParams, Constants.VARIETY_REGULAR);
73+
System.out.println(order.orderId);
7574
```
7675
For more details, take a look at Examples.java in sample directory.
7776

@@ -357,4 +356,4 @@ For more details about different mode of quotes and subscribing for them, take a
357356
| :---: | :---: |
358357
| start | lower |
359358
| end | upper |
360-
| percent | percentage |
359+
| percent | percentage |

0 commit comments

Comments
 (0)