Shoonya Python API

Python API Document
Product Of
Contents
ShoonyaApi-Py .............................................................................................................................................. 1
Introduction .............................................................................................................................................. 3
Build .......................................................................................................................................................... 3
Login ...................................................................................................................................................... 3
Orders and Trades................................................................................................................................. 3
Holdings and Limits ............................................................................................................................... 5
Symbols and Contract Information ..................................................................................................... 11
WebSocket API .................................................................................................................................... 17
Example - Getting Started ....................................................................................................................... 17
Example Symbol/Contract : Example_market.py ................................................................................... 18
Search Scrips ....................................................................................................................................... 18
Security Info ........................................................................................................................................ 19
Subscribe to a live feed ....................................................................................................................... 20
Example - Orders and Trades : example_orders.py ................................................................................ 21
Place Order.......................................................................................................................................... 21
Modify Order....................................................................................................................................... 21
Cancel Order ....................................................................................................................................... 22
Subscribe to Order Updates ................................................................................................................ 22
Introduction
Api used to connect to Shoonya OMS
Build
to build this package and install it on your server please use
pip install -r requirements.txt
Login
login(userid, password, twoFA, vendor_code, api_secret, imei)
connect to the broker, only once this function has returned successfully can any other operations be
performed
Param Type Optional Description
userid string False user credentials
password string False password encrypted
twoFA string False OTP/TOTP
vendor_code string False vendor code shared
api_secret string False your secret
imei string False imei identification
Orders and Trades
place_order(buy_or_sell, product_type,exchange, tradingsymbol, quantity,

discloseqty, price_type, price=0.0, trigger_price=None, retention='DAY',
amo='NO', remarks=None)
place an order to oms
buy_or_sell string False B -> BUY, S -> SELL
product_type string False C / M / H Product name (Select from ‘prarr’ Array provided in
User Details response, and if same is allowed for selected,
exchange. Show product display name, for user to select, and
send corresponding prd in API call)
exchange string False Exchange NSE / NFO / BSE / CDS
tradingsymbol string False Unique id of contract on which order to be placed. (use url
encoding to avoid special char error for symbols like M&M
quantity integer False order quantity
discloseqty integer False order disc qty
price_type string False PriceType enum class
price integer False Price in paise, 100.00 is sent as 10000
trigger_price integer False Price in paise
retention string False DAY / IOC / EOS
amo string True Flag for After Market Order, YES/NO
remarks string True client order id or free text
modify_order(orderno, exchange, tradingsymbol, newquantity,newprice_type,

newprice, newtrigger_price, amo):
modify the quantity pricetype or price of an order
orderno string False orderno to be modified
exchange string False Exchange NSE / NFO / BSE / CDS
tradingsymbol string False Unique id of contract on which order to be placed. (use url
encoding to avoid special char error for symbols like M&M
newquantity integer False new order quantity
newprice_type string False PriceType enum class
newprice integer False Price in paise, 100.00 is sent as 10000
newtrigger_price integer False Price in paise
cancel_order(orderno)
cancel an order
orderno string False orderno with status open
exit_order(orderno)
exits a cover or bracket order
orderno string False orderno with status open
prd string False Allowed for only H and B products (Cover order and bracket order)
single order history(orderno)

history an order
orderno string False orderno
Holdings and Limits
get_holdings(product_type)
retrieves the holdings as a list
product_type string True retreives the delivery holdings or for a given product
get_positions()
retrieves the positions cf and day as a list
No Parameters
get_limits
retrieves the margin and limits set
product_type string True retreives the delivery holdings or for a given product
segment string True CM / FO / FX
exchange string True Exchange NSE/BSE/MCX
the response is as follows,
stat Ok or False Limits request success or failure
Not_Ok indication.
actid string True Account id
prd string True Product name
seg string True Segment CM / FO / FX
exch string True Exchange
-------------------------Cash Primary Fields---------
----------------------
cash string True Cash Margin available
payin string True Total Amount transferred using
Payins today
payout string True Total amount requested for
withdrawal today
-------------------------Cash Additional Fields------
-------------------------
brkcollamt string True Prevalued Collateral Amount
unclearedcash string True Uncleared Cash (Payin through
cheques)
daycash string True Additional leverage amount /
Amount added to handle system
errors - by broker.
-------------------------Margin Utilized---------------
-------------------
marginused string True Total margin / fund used today
mtomcurper string True Mtom current percentage
-------------------------Margin Used components-
--------------------
cbu string True CAC Buy used
csc string True CAC Sell Credits
rpnl string True Current realized PNL
unmtom string True Current unrealized mtom
marprt string True Covered Product margins
span string True Span used
expo string True Exposure margin
premium string True Premium used
varelm string True Var Elm Margin
grexpo string True Gross Exposure
greexpo_d string True Gross Exposure derivative
scripbskmar string True Scrip basket margin
addscripbskmrg string True Additional scrip basket margin
brokerage string True Brokerage amount
collateral string True Collateral calculated based on
uploaded holdings
grcoll string True Valuation of uploaded holding
pre haircut
-------------------------Additional Risk Limits-------
--------------------
turnoverlmt string True
pendordvallmt string True
-------------------------Additional Risk Indicators-
--------------------------
turnover string True Turnover
pendordval string True Pending Order value
-------------------------Margin used detailed
breakup fields-------------------------
rzpnl_e_i string True Current realized PNL (Equity
Intraday)
rzpnl_e_m string True Current realized PNL (Equity
Margin)
rzpnl_e_c string True Current realized PNL (Equity Cash
n Carry)
rzpnl_d_i string True Current realized PNL (Derivative
Intraday)
rzpnl_d_m string True Current realized PNL (Derivative
Margin)
rzpnl_f_i string True Current realized PNL (FX
Intraday)
rzpnl_f_m string True Current realized PNL (FX Margin)
rzpnl_c_i string True Current realized PNL (Commodity
Intraday)
rzpnl_c_m string True Current realized PNL (Commodity
Margin)
uzpnl_e_i string True Current unrealized MTOM
(Equity Intraday)
uzpnl_e_m string True Current unrealized MTOM
(Equity Margin)
uzpnl_e_c string True Current unrealized MTOM
(Equity Cash n Carry)
uzpnl_d_i string True Current unrealized MTOM
(Derivative Intraday)
uzpnl_d_m string True Current unrealized MTOM
(Derivative Margin)
uzpnl_f_i string True Current unrealized MTOM (FX
Intraday)
uzpnl_f_m string True Current unrealized MTOM (FX
Margin)
uzpnl_c_i string True Current unrealized MTOM
(Commodity Intraday)
uzpnl_c_m string True Current unrealized MTOM
(Commodity Margin)
span_d_i string True Span Margin (Derivative
Intraday)
span_d_m string True Span Margin (Derivative Margin)
span_f_i string True Span Margin (FX Intraday)
span_f_m string True Span Margin (FX Margin)
span_c_i string True Span Margin (Commodity
Intraday)
span_c_m string True Span Margin (Commodity
Margin)
expo_d_i string True Exposure Margin (Derivative
Intraday)
expo_d_m string True Exposure Margin (Derivative
Margin)
expo_f_i string True Exposure Margin (FX Intraday)
expo_f_m string True Exposure Margin (FX Margin)
expo_c_i string True Exposure Margin (Commodity
Intraday)
expo_c_m string True Exposure Margin (Commodity
Margin)
premium_d_i string True Option premium (Derivative
Intraday)
premium_d_m string True Option premium (Derivative
Margin)
premium_f_i string True Option premium (FX Intraday)
premium_f_m string True Option premium (FX Margin)
premium_c_i string True Option premium (Commodity
Intraday)
premium_c_m string True Option premium (Commodity
Margin)
varelm_e_i string True Var Elm (Equity Intraday)
varelm_e_m string True Var Elm (Equity Margin)
varelm_e_c string True Var Elm (Equity Cash n Carry)
marprt_e_h string True Covered Product margins (Equity
High leverage)
marprt_e_b string True Covered Product margins (Equity
Bracket Order)
marprt_d_h string True Covered Product margins
(Derivative High leverage)
marprt_d_b string True Covered Product margins
(Derivative Bracket Order)
marprt_f_h string True Covered Product margins (FX
High leverage)
marprt_f_b string True Covered Product margins (FX
Bracket Order)
marprt_c_h string True Covered Product margins
(Commodity High leverage)
marprt_c_b string True Covered Product margins
(Commodity Bracket Order)
scripbskmar_e_i string True Scrip basket margin (Equity
Intraday)
scripbskmar_e_m string True Scrip basket margin (Equity
Margin)
scripbskmar_e_c string True Scrip basket margin (Equity Cash
n Carry)
addscripbskmrg_d_i string True Additional scrip basket margin
(Derivative Intraday)
addscripbskmrg_d_m string True Additional scrip basket margin
(Derivative Margin)
addscripbskmrg_f_i string True Additional scrip basket margin
(FX Intraday)
addscripbskmrg_f_m string True Additional scrip basket margin
(FX Margin)
addscripbskmrg_c_i string True Additional scrip basket margin
(Commodity Intraday)
addscripbskmrg_c_m string True Additional scrip basket margin
(Commodity Margin)
brkage_e_i string True Brokerage (Equity Intraday)
brkage_e_m string True Brokerage (Equity Margin)
brkage_e_c string True Brokerage (Equity CAC)
brkage_e_h string True Brokerage (Equity High Leverage)
brkage_e_b string True Brokerage (Equity Bracket Order)
brkage_d_i string True Brokerage (Derivative Intraday)
brkage_d_m string True Brokerage (Derivative Margin)
brkage_d_h string True Brokerage (Derivative High
Leverage)
brkage_d_b string True Brokerage (Derivative Bracket
Order)
brkage_f_i string True Brokerage (FX Intraday)
brkage_f_m string True Brokerage (FX Margin)
brkage_f_h string True Brokerage (FX High Leverage)
brkage_f_b string True Brokerage (FX Bracket Order)
brkage_c_i string True Brokerage (Commodity Intraday)
brkage_c_m string True Brokerage (Commodity Margin)
brkage_c_h string True Brokerage (Commodity High
Leverage)
brkage_c_b string True Brokerage (Commodity Bracket
Order)
peak_mar string True Peak margin used by the client
request_time string True This will be present only in a
successful response.
emsg string True This will be present only in a
failure response.
Symbols and Contract Information
searchscrip(exchange, searchtext):
search for scrip or contract and its properties
exchange string True Exchange NSE / NFO / BSE / CDS
searchtext string True Search Text ie partial or complete text ex: INFY-EQ, INF..

stat string True ok or Not_ok
values string True properties of the scrip
emsg string False Error Message

exch string True Exchange NSE / NFO / BSE / CDS
tsym string True Trading Symbol is the readable Unique id of contract/scrip
token string True Unique Code of contract/scrip
pp string True price precision, in case of cds its 4 ie 100.1234
ti string True tick size minimum increments of paise for price
ls string True Lot Size
get_security_info(exchange, token):
gets the complete details and its properties
token string True token number of the contract


cname string True Company Name
symnam string True Symbol Name
seg string True Segment
exd string True Expiry Date
instname string True Instrument Name
strprc string True Strike Price
optt string True Option Type
isin string True ISIN
ti string True Tick Size
pp string True Price Precision
mult string True Multiplier
gp_nd string True GN/GD * PN/PD
prcunt string True Price Units
prcqqty string True Price Quote Qty
trdunt string True Trade Units
delunt string True Delivery Units
frzqty string True Freeze Qty
gsmind string True GSM indicator
elmbmrg string True ELM Buy Margin
elmsmrg string True ELM Sell Margin
addbmrg string True Additional Long Margin
addsmrg string True Additional Short Margin
splbmrg string True Special Long Margin
splsmrg string True Special Short Margin
delmrg string True Delivery Margin
tenmrg string True Tender Margin
tenstrd string True Tender Start Date
tenendd string True Tender End Date
exestrd string True Exercise Start Date
exeendd string True Exercise End Date
elmmrg string True ELM Margin
varmrg string True VAR Margin
expmrg string True Exposure Margin
token string True Contract Token
prcftr_d string True ((GN / GD) * (PN/PD))
get_quotes(exchange, token):
gets the complete details and its properties


cname string True Company Name
symname string True Symbol Name
seg string True Segment
instname string True Instrument Name
isin string True ISIN
pp string True Price precision
ti string True Tick Size
mult string True Multiplier
uc string True Upper circuit limitlc
lc string True Lower circuit limit
prcftr_d string True Price factor((GN / GD) * (PN/PD))
token string True Token
lp string True LTP
o string True Open Price
h string True Day High Price
l string True Day Low Price
v string True Volume
ltq string True Last trade quantity
ltt string True Last trade time
bp1 string True Best Buy Price 1
sp1 string True Best Sell Price 1
bq1 string True Best Buy Quantity 1
sq1 string True Best Sell Quantity 1
bo1 string True Best Buy Orders 1
so1 string True Best Sell Orders 1
get_time_price_series(exchange, token, starttime, endtime):

gets the chart date for the symbol
starttime string True Start time (seconds since 1 jan 1970)
endtime string True End Time (seconds since 1 jan 1970)


time string True DD/MM/CCYY hh:mm:ss
into string True Interval Open
inth string True Interval High
intl string True Interval Low
intc string True Interval Close
intvwap string True Interval vwap
intv string True Interval volume
v string True volume
inoi string True Interval oi change
oi string True oi
WebSocket API
start_websocket()
starts the websocket
subscribe_callback function False callback for market updates
order_update_callback function False callback for order updates
socket_open_callback function False callback when socket is open (reconnection also)
socket_close_callback function False callback when socket is closed
subscribe_orders()
get order and trade update callbacks
subscribe([instruments])
send a list of instruments to watch
instruments list False list of instruments [NSE\
unsubscribe()
send a list of instruments to stop watch
Example - Getting Started

First configure the endpoints in the api_helper constructor.
Thereon provide your credentials and login as follows.
from api_helper import ShoonyaApiPy
import logging
#enable dbug to see request and responses
logging.basicConfig(level=logging.DEBUG)
#start of our program

api = ShoonyaApiPy()
#credentials
user = '< user id>'
u_pwd = '< password >'
factor2 = 'second factor'
vc = 'vendor code'
app_key = 'secret key'
imei = 'uniq identifier'
ret = api.login(userid=user, password=pwd, twoFA=factor2, vendor_code=vc,

api_secret=app_key, imei=imei)
print(ret)
Example Symbol/Contract : Example_market.py

This Example shows API usage for finding scrips and its properties
Search Scrips
The call can be made to get the exchange provided token for a scrip or alternately can search for a
partial string to get a list of matching scrips
Trading Symbol:
SymbolName + ExpDate + 'F' for all data having InstrumentName starting with FUT
SymbolName + ExpDate + 'P' + StrikePrice for all data having InstrumentName starting with OPT and
with OptionType PE
SymbolName + ExpDate + 'C' + StrikePrice for all data having InstrumentName starting with OPT and
with OptionType C
For MCX, F to be ignored for FUT instruments
api.searchscrip(exchange='NSE', searchtext='REL')
This will reply as following

{
"stat": "Ok",
"values": [
{
"exch": "NSE",
"token": "18069",
"tsym": "REL100NAV-EQ"
},
{
"exch": "NSE",
"token": "24225",
"tsym": "RELAXO-EQ"
},
{
"exch": "NSE",
"token": "4327",
"tsym": "RELAXOFOOT-EQ"
},
{
"exch": "NSE",
"token": "18068",
"tsym": "RELBANKNAV-EQ"
},
{
"exch": "NSE",
"token": "2882",
"tsym": "RELCAPITAL-EQ"
},
{
"exch": "NSE",
"token": "18070",
"tsym": "RELCONSNAV-EQ"
},
{
"exch": "NSE",
"token": "18071",
"tsym": "RELDIVNAV-EQ"
},
{
"exch": "NSE",
"token": "18072",
"tsym": "RELGOLDNAV-EQ"
},
{
"exch": "NSE",
"token": "2885",
"tsym": "RELIANCE-EQ"
},
{
"exch": "NSE",
"token": "15068",
"tsym": "RELIGARE-EQ"
},
{
"exch": "NSE",
"token": "553",
"tsym": "RELINFRA-EQ"
},
{
"exch": "NSE",
"token": "18074",
"tsym": "RELNV20NAV-EQ"
}
]
}
Security Info
This call is done to get the properties of the scrip such as freeze qty and margins
api.get_security_info(exchange='NSE', token='22')
The response for the same would be

{
"request_time": "17:43:38 31-10-2020",
"stat": "Ok",
"exch": "NSE",
"tsym": "ACC-EQ",
"cname": "ACC LIMITED",
"symname": "ACC",
"seg": "EQT",
"instname": "EQ",
"isin": "INE012A01025",
"pp": "2",
"ls": "1",
"ti": "0.05",
"mult": "1",
"prcftr_d": "(1 / 1 ) * (1 / 1)",
"trdunt": "ACC.BO",
"delunt": "ACC",
"token": "22",
"varmrg": "40.00"
}
Subscribe to a live feed

Subscribe to a single token as follows
api.subscribe('NSE|13')
Subscribe to a list of tokens as follows

api.subscribe(['NSE|22', 'BSE|522032'])
First we need to connect to the WebSocket and then subscribe as follows

feed_opened = False
def event_handler_feed_update(tick_data):
print(f"feed update {tick_data}")
def open_callback():
global feed_opened
feed_opened = True
api.start_websocket( order_update_callback=event_handler_order_update,
subscribe_callback=event_handler_feed_update,
socket_open_callback=open_callback)
while(feed_opened==False):
pass
# subscribe to a single token

api.subscribe('NSE|13')
#subscribe to multiple tokens
api.subscribe(['NSE|22', 'BSE|522032'])
Example - Orders and Trades : example_orders.py

Place Order
Place a Limit order as follows
api.place_order(buy_or_sell='B', product_type='C',
exchange='NSE', tradingsymbol='INFY-EQ',
quantity=1, discloseqty=0,price_type='LMT', price=1500,
trigger_price=None,
retention='DAY', remarks='my_order_001')
Place a Market Order as follows
quantity=1, discloseqty=0,price_type='MKT', price=0,
trigger_price=None,
Place a StopLoss Order as follows
quantity=1, discloseqty=0,price_type='SL-LMT', price=1500,
trigger_price=1450,
Place a Cover Order as follows
api.place_order(buy_or_sell='B', product_type='H',
trigger_price=None,
retention='DAY', remarks='my_order_001', bookloss_price =
1490)
Place a Bracket Order as follows
api.place_order(buy_or_sell='B', product_type='H',
trigger_price=None,
retention='DAY', remarks='my_order_001', bookloss_price =
1490, bookprofit_price = 1510)
Modify Order
Modify a New Order by providing the OrderNumber
api.modify_order(exchange='NSE', tradingsymbol='INFY-EQ', orderno=orderno,
newquantity=2, newprice_type='LMT', newprice=1505)
Cancel Order
Cancel a New Order by providing the Order Number
api.cancel_order(orderno=orderno)
Subscribe to Order Updates

Connecting to the Websocket will automatically subscribe and provide the order updates in the call back
as follows
Note: Feed and Order updates are received from the same websocket and needs to be connected once
only.
feed_opened = False
def event_handler_order_update(order):
print(f"order feed {order}")
def open_callback():
global feed_opened
feed_opened = True
api.start_websocket( order_update_callback=event_handler_order_update,
subscribe_callback=event_handler_feed_update,
socket_open_callback=open_callback)
while(feed_opened==False):
pass

Shoonya Python API

Uploaded by

Copyright:

Available Formats

Shoonya Python API

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Shoonya Python API

Uploaded by

Copyright:

Available Formats

Python API Document

Orders and Trades

place_order(buy_or_sell, product_type,exchange, tradingsymbol, quantity,

modify_order(orderno, exchange, tradingsymbol, newquantity,newprice_type,

single order history(orderno)

Holdings and Limits

Symbols and Contract Information

the response is as follows,

Param Type Optional Description

the response is as follows,

Param Type Optional Description

the response is as follows,

Param Type Optional Description

get_time_price_series(exchange, token, starttime, endtime):

the response is as follows,

Param Type Optional Description

Example - Getting Started

#start of our program

ret = api.login(userid=user, password=pwd, twoFA=factor2, vendor_code=vc,

Example Symbol/Contract : Example_market.py

This will reply as following

The response for the same would be

Subscribe to a live feed

Subscribe to a list of tokens as follows

First we need to connect to the WebSocket and then subscribe as follows

# subscribe to a single token

Example - Orders and Trades : example_orders.py

Subscribe to Order Updates

You might also like