Annexure
Extra information a bout APIs
There are various enums which are used in APIs. The details of these could be found below.
Exchanges
These are the possible value of exchanges used in API as integer.
| ExchangeName |
Value |
Description |
| NSE |
1 |
NSE cash market |
| NFO |
2 |
NSE F&O market |
| BSE |
3 |
BSE cash market |
Order status
These are the possible value of order status as integer used in API as integer.
| Order status |
Value |
Description |
| CREATED |
1 |
order is created |
| OPEN |
3 |
Order is sent to Order management system |
| PENDING |
4 |
Order is sent to exchange and in pending status. |
| COMPLETED |
5 |
Order is completed |
| CANCELLED |
6 |
Order is cancelled |
| REJECTED |
7 |
Order is rejected. You could see the rejection reason to know the cause |
| INVALID_STATUS |
8 |
Invalid order status |
| TRIGGER_PENDING |
10 |
a stoploss order is sent to exchange and is pending |
Order validity
These are the possible validities as integer which users could choose while placing/modifying order.
| Order validity |
Value |
Description |
| DAY |
1 |
Valid for a day |
| IOC |
2 |
Immediate or Cancelled |
| EOS |
2 |
Valid till the end of the session |
| GTT |
3 |
Valid until triggered |
Price type
These are the possible price types as integer which users can choose while placing/modifying order.
| Price type |
Value |
Description |
| LIMIT |
1 |
Order is placed at a fixed price.know more |
| MARKET |
2 |
Order is placed at Market rate know more |
| STOPLOSSLIMIT |
3 |
Order is placed as limit when stoploss is triggered. know more |
| STOPLOSSMARKET |
4 |
Order is placed as market when stoploss is triggered.know more |
| SPREAD |
5 |
price type when spread order is placed |
| TWOLEGGEDORDER |
6 |
price type when two legged order is placed. know more |
| THREELEGGEDORDER |
7 |
price type when three legged order is placed. know more |
Order type
These are the possible options for Order types available while placing order as integer.
| Order type |
Value |
Description |
| CNC |
1 |
Carry forward order in equity segment |
| INTRADAY |
2 |
Intraday Orders |
| NRML |
3 |
Carry forward order in F&O segment |
| CO |
4 |
Cover Order are intraday orders with a stoploss |
| BO |
5 |
Bracket Order are intrdaya order with a target and stoploss |
Transaction type
Trasaction type determines whether order is BUY or SELL and are as integer.
| Transaction type |
Value |
Description |
| BUY |
1 |
Buy order |
| SELL |
2 |
Sell order |
Option type
These are the possible options types present in F&O segment of NSE as integer.
| Option type |
Value |
Description |
| CE |
1 |
Call option |
| PE |
2 |
Put option |
Order Source
These are the possible order source from which order is recieved from as integer.
| Order source |
Value |
Description |
| MOB |
1 |
Order coming from Mobile |
| WEB |
2 |
Order coming from Web |
| TT |
3 |
Order coming from Trading terminal |
| API |
4 |
Order coming from API |
| OTHERS |
5 |
Order coming from other source |
Order Source
These are the possible subscriptions type available to subscribe/unsubscribe to message types in websocket.
| subscription type |
Value |
Description |
| t |
t |
subscribe marketwatch |
| t |
ut |
unsubscribe marketwatch |
| d |
2 |
subscribe snapquote |
| ud |
2 |
unsubscribe snapquote |
| o |
3 |
subscribe Order updates |
| uo |
3 |
unsubscribe Order updates |