Package: pya3
Official Python SDK for Alice Blue APIThe Official Python library for communicating with the Alice Blue APIs.Alice Blue Python library provides an easy to use wrapper over the HTTPS APIs.The HTTP calls have been converted to methods and JSON responses are wrapped into Python-compatible objects.Author:CodiFiCurrent Version: 1.0.29InstallationThis module is installed via pip:pip install pya3To force upgrade existing installations:pip uninstall pya3
pip --no-cache-dir install --upgrade pya3PrerequisitesPython >=3.7Getting started with APIOverviewThere is only two class in the whole library:AliceBlueandAlice_Wrapper. Theget_session_idstatic method is used to retrieve a Session ID from the alice blue server. A Session ID is valid until the trading account logout.
With a Session ID, you can instantiate an AliceBlue object. Ideally you only need to create a Session ID once every time login the trading account with password. After you have the Session ID, you can store it
separately for re-use.NOTE: User should Login through Web(a3.aliceblueonline.com) or SSO or Mobile at least once in a day, before connecting the APIRate LimitsThe following are the rate limits for API users:Orders - NOT LIMITED. Placing a new order, Modifying an existing order, square off positions and Cancelling an order are all not limited.All other requests - Limited to 1800 requests per 15 minutes. This limit will be reset every 15 minutes to 1800 again.Note:In order to make sure all clients requests are treated equally, AliceBlue has set up certain limits to the number of requests each client can make through API.REST DocumentationThe original REST API that this SDK is based on is available online.Alice Blue API REST documentationUsing the APIGet a Session IDImport pya3frompya3import*Create AliceBlue ObjectYou can create an AliceBlue object with yourUserIDandAPI Key.alice=Aliceblue(user_id='username',api_key='API_KEY')You can get a Session ID by running following command. Store it once a dayprint(alice.get_session_id())# Get Session IDYou can run commands here to check your connectivityprint(alice.get_balance())# get balance / margin limitsprint(alice.get_profile())# get profileprint(alice.get_daywise_positions())# get daywise positionsprint(alice.get_netwise_positions())# get all netwise positionsprint(alice.get_holding_positions())# get holding positionsAlice WrapperCheck Net Position Wrapper (Open/Close) Position:Net_position = alice.get_netwise_positions()

open_position= Alice_Wrapper.open_net_position(Net_position)
print("Open position :",open_position)

close_position = Alice_Wrapper.close_net_poition(Net_position)
print("Close position :",close_position)Order History response wrapper:order_history_response = alice.get_order_history('')
print(Alice_Wrapper.get_order_history(order_history_response))Balance response wrapper:get_balance_response=alice.get_balance()
print(Alice_Wrapper.get_balance(get_balance_response))Profile response wrapper:get_profile_response=alice.get_profile()
print(Alice_Wrapper.get_profile(get_profile_response))Get master contractsGetting master contracts allow you to search for instruments by symbol name and place orders.Master contracts are stored as an CSV at local by token number and by symbol name. Whenever you get a trade update, order update, or quote update, the library will check if master contracts are loaded. If they are, it will attach the instrument object directly to the update. By default all master contracts of all enabled exchanges in your personal profile will be downloaded. i.e. If your profile contains the following as enabled exchanges['NSE','CDS', 'BSE','BFO', 'MCX', NFO','INDICES']all contract notes of all exchanges will be downloaded by default. If you feel it takes too much time to download all exchange, or if you don't need all exchanges to be downloaded, you can specify which exchange to download contract notes while creating the AliceBlue object.alice.get_contract_master("MCX")alice.get_contract_master("NFO")alice.get_contract_master("NSE")alice.get_contract_master("BSE")alice.get_contract_master("CDS")alice.get_contract_master("BFO")alice.get_contract_master("INDICES")This will reduce a few milliseconds in object creation time of AliceBlue object.Get tradable instrumentsSymbols can be retrieved in multiple ways. Once you have the master contract loaded for an exchange, you can get an instrument in many ways.Get a single instrument by it's name:print(alice.get_instrument_by_symbol('NSE','ONGC'))print(alice.get_instrument_by_symbol('BSE','TATASTEEL'))print(alice.get_instrument_by_symbol('MCX','GOLDM'))print(alice.get_instrument_by_symbol('INDICES','NIFTY 50'))print(alice.get_instrument_by_symbol('INDICES','NIFTY BANK'))Get a single instrument by it's token number (generally useful only for BSE Equities):print(alice.get_instrument_by_token("MCX",239484))print(alice.get_instrument_by_token('BSE',500325))print(alice.get_instrument_by_token('NSE',22))print(alice.get_instrument_by_token('INDICES',26000))# Nifty Indicesprint(alice.get_instrument_by_token('INDICES',26009))# Bank NiftyGet FNO instruments easily by mentioning expiry, strike & call or put.print(alice.get_instrument_for_fno(exch="NFO",symbol='BANKNIFTY',expiry_date="2022-09-25",is_fut=True,strike=None,is_CE=False))print(alice.get_instrument_for_fno(exch="NFO",symbol='BANKNIFTY',expiry_date="2022-09-04",is_fut=False,strike=37700,is_CE=False))print(alice.get_instrument_for_fno(exch="NFO",symbol='BANKNIFTY',expiry_date="2022-09-04",is_fut=False,strike=37700,is_CE=True))print(alice.get_instrument_for_fno(exch="CDS",symbol='USDINR',expiry_date="2022-09-16",is_fut=True,strike=None,is_CE=False))print(alice.get_instrument_for_fno(exch="CDS",symbol='USDINR',expiry_date="2022-09-23",is_fut=False,strike=79.50000,is_CE=False))print(alice.get_instrument_for_fno(exch="CDS",symbol='USDINR',expiry_date="2022-09-28",is_fut=False,strike=79.50000,is_CE=True))Search for symbolsSearch for multiple instruments by matching the name. This works case insensitive and returns all instrument which has the name in its symbol. It does not require contract master file.all_sensex_scrips=alice.search_instruments('BSE','SENSEX')print(all_sensex_scrips)The above code results multiple symbol which has 'sensex' in its symbol.Instrument objectInstruments are represented by instrument objects. These are named-tuples that are created while getting the master contracts. They are used when placing an order and searching for an instrument. The structure of an instrument tuple is as follows:Instrument=namedtuple('Instrument',['exchange','token','symbol','name','expiry','lot_size'])All instruments have the fields mentioned above. Wherever a field is not applicable for an instrument (for example, equity instruments don't have strike prices), that value will beNonePlace an orderPlace limit, market, SL, SL-M, AMO, BO, CO orders# TransactionType.Buy, OrderType.Market, ProductType.Deliveryprint("%%%%%%%%%%%%%%%%%%%%%%%%%%%%1%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")print(alice.place_order(transaction_type=TransactionType.Buy,instrument=alice.get_instrument_by_symbol('NSE','INFY'),quantity=1,order_type=OrderType.Market,product_type=ProductType.Delivery,price=0.0,trigger_price=None,stop_loss=None,square_off=None,trailing_sl=None,is_amo=False,order_tag='order1'))# TransactionType.Buy, OrderType.Market, ProductType.Intradayprint("%%%%%%%%%%%%%%%%%%%%%%%%%%%%2%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")print(alice.place_order(transaction_type=TransactionType.Buy,instrument=alice.get_instrument_by_symbol('NSE','INFY'),quantity=1,order_type=OrderType.Market,product_type=ProductType.Intraday,price=0.0,trigger_price=None,stop_loss=None,square_off=None,trailing_sl=None,is_amo=False,order_tag='order1'))# TransactionType.Buy, OrderType.Market, ProductType.CoverOrderprint("%%%%%%%%%%%%%%%%%%%%%%%%%%%%3%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")print(alice.place_order(transaction_type=TransactionType.Buy,instrument=alice.get_instrument_by_symbol('NSE','INFY'),quantity=1,order_type=OrderType.Market,product_type=ProductType.CoverOrder,price=0.0,trigger_price=7.5,# trigger_price Here the trigger_price is taken as stop loss (provide stop loss in actual amount)stop_loss=None,square_off=None,trailing_sl=None,is_amo=False,order_tag='order1'))# TransactionType.Buy, OrderType.Limit, ProductType.BracketOrder# OCO Order can't be of type marketprint("%%%%%%%%%%%%%%%%%%%%%%%%%%%%4%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")print(alice.place_order(transaction_type=TransactionType.Buy,instrument=alice.get_instrument_by_symbol('NSE','INFY'),quantity=1,order_type=OrderType.Limit,product_type=ProductType.BracketOrder,price=8.0,trigger_price=None,stop_loss=6.0,square_off=10.0,trailing_sl=None,is_amo=False,order_tag='order1'))# TransactionType.Buy, OrderType.Limit, ProductType.Intradayprint("%%%%%%%%%%%%%%%%%%%%%%%%%%%%5%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")print(alice.place_order(transaction_type=TransactionType.Buy,instrument=alice.get_instrument_by_symbol('NSE','INFY'),quantity=1,order_type=OrderType.Limit,product_type=ProductType.Intraday,price=8.0,trigger_price=None,stop_loss=None,square_off=None,trailing_sl=None,is_amo=False,order_tag='order1'))# TransactionType.Buy, OrderType.Limit, ProductType.CoverOrderprint("%%%%%%%%%%%%%%%%%%%%%%%%%%%%6%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")print(alice.place_order(transaction_type=TransactionType.Buy,instrument=alice.get_instrument_by_symbol('NSE','INFY'),quantity=1,order_type=OrderType.Limit,product_type=ProductType.CoverOrder,price=7.0,trigger_price=6.5,# trigger_price Here the trigger_price is taken as stop loss (provide stop loss in actual amount)stop_loss=None,square_off=None,trailing_sl=None,is_amo=False,order_tag='order1'))################################ TransactionType.Buy, OrderType.StopLossMarket, ProductType.Deliveryprint("%%%%%%%%%%%%%%%%%%%%%%%%%%%%7%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")print(alice.place_order(transaction_type=TransactionType.Buy,instrument=alice.get_instrument_by_symbol('NSE','INFY'),quantity=1,order_type=OrderType.StopLossMarket,product_type=ProductType.Delivery,price=0.0,trigger_price=8.0,stop_loss=None,square_off=None,trailing_sl=None,is_amo=False,order_tag='order1'))# TransactionType.Buy, OrderType.StopLossMarket, ProductType.Intradayprint("%%%%%%%%%%%%%%%%%%%%%%%%%%%%8%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")print(alice.place_order(transaction_type=TransactionType.Buy,instrument=alice.get_instrument_by_symbol('NSE','INFY'),quantity=1,order_type=OrderType.StopLossMarket,product_type=ProductType.Intraday,price=0.0,trigger_price=8.0,stop_loss=None,square_off=None,trailing_sl=None,is_amo=False,order_tag='order1'))# TransactionType.Buy, OrderType.StopLossMarket, ProductType.CoverOrder# CO order is of type Limit and And Market Only# TransactionType.Buy, OrderType.StopLossMarket, ProductType.BO# BO order is of type Limit and And Market Only#################################### TransactionType.Buy, OrderType.StopLossLimit, ProductType.Deliveryprint("%%%%%%%%%%%%%%%%%%%%%%%%%%%%9%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")print(alice.place_order(transaction_type=TransactionType.Buy,instrument=alice.get_instrument_by_symbol('NSE','INFY'),quantity=1,order_type=OrderType.StopLossMarket,product_type=ProductType.Delivery,price=8.0,trigger_price=8.0,stop_loss=None,square_off=None,trailing_sl=None,is_amo=False,order_tag='order1'))# TransactionType.Buy, OrderType.StopLossLimit, ProductType.Intradayprint("%%%%%%%%%%%%%%%%%%%%%%%%%%%%10%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")print(alice.place_order(transaction_type=TransactionType.Buy,instrument=alice.get_instrument_by_symbol('NSE','INFY'),quantity=1,order_type=OrderType.StopLossLimit,product_type=ProductType.Intraday,price=8.0,trigger_price=8.0,stop_loss=None,square_off=None,trailing_sl=None,is_amo=False,order_tag='order1'))# TransactionType.Buy, OrderType.StopLossLimit, ProductType.CoverOrder# CO order is of type Limit and And Market Only# TransactionType.Buy, OrderType.StopLossLimit, ProductType.BracketOrderprint("%%%%%%%%%%%%%%%%%%%%%%%%%%%%11%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")print(alice.place_order(transaction_type=TransactionType.Buy,instrument=alice.get_instrument_by_symbol('NSE','INFY'),quantity=1,order_type=OrderType.StopLossLimit,product_type=ProductType.BracketOrder,price=8.0,trigger_price=8.0,stop_loss=1.0,square_off=1.0,trailing_sl=20,is_amo=False,order_tag='order1'))Place basket orderBasket order is used to buy or sell group of securities simultaneously.order1={"instrument":alice.get_instrument_by_symbol('NSE','INFY'),"order_type":OrderType.Market,"quantity":1,"transaction_type":TransactionType.Buy,"product_type":ProductType.Delivery,"order_tag":"Order1"}order2={"instrument":alice.get_instrument_by_symbol('NSE','SBIN'),"order_type":OrderType.Limit,"quantity":2,"price":280.0,"transaction_type":TransactionType.Sell,"product_type":ProductType.Intraday,"order_tag":"Order2"}orders=[order1,order2]print(alice.place_basket_order(orders))WebsocketConnect the Websocket and subscribe script. To get market depth please set market_depth asTrueLTP=0socket_opened=Falsesubscribe_flag=Falsesubscribe_list=[]unsubscribe_list=[]defsocket_open():# Socket open callback functionprint("Connected")globalsocket_openedsocket_opened=Trueifsubscribe_flag:# This is used to resubscribe the script when reconnect the socket.alice.subscribe(subscribe_list)defsocket_close():# On Socket close this callback function will triggerglobalsocket_opened,LTPsocket_opened=FalseLTP=0print("Closed")defsocket_error(message):# Socket Error Message will receive in this callback functionglobalLTPLTP=0print("Error :",message)deffeed_data(message):# Socket feed data will receive in this callback functionglobalLTP,subscribe_flagfeed_message=json.loads(message)iffeed_message["t"]=="ck":print("Connection Acknowledgement status :%s(Websocket Connected)"%feed_message["s"])subscribe_flag=Trueprint("subscribe_flag :",subscribe_flag)print("-------------------------------------------------------------------------------")passeliffeed_message["t"]=="tk":print("Token Acknowledgement status :%s"%feed_message)print("-------------------------------------------------------------------------------")passelse:print("Feed :",feed_message)LTP=feed_message['lp']if'lp'infeed_messageelseLTP# If LTP in the response it will store in LTP variable# Socket Connection Requestalice.start_websocket(socket_open_callback=socket_open,socket_close_callback=socket_close,socket_error_callback=socket_error,subscription_callback=feed_data,run_in_background=True,market_depth=False)whilenotsocket_opened:passsubscribe_list=[alice.get_instrument_by_token('INDICES',26000)]alice.subscribe(subscribe_list)print(datetime.now())sleep(10)print(datetime.now())# unsubscribe_list = [alice.get_instrument_by_symbol("NSE", "RELIANCE")]# alice.unsubscribe(unsubscribe_list)# sleep(8)# Stop the websocketalice.stop_websocket()sleep(10)print(datetime.now())# Connect the socket after socket closealice.start_websocket(socket_open_callback=socket_open,socket_close_callback=socket_close,socket_error_callback=socket_error,subscription_callback=feed_data,run_in_background=True)Modify an orderprint(alice.modify_order(transaction_type=TransactionType.Buy,instrument=alice.get_instrument_by_token('MCX',242508),order_id="220803000207716",quantity=1,order_type=OrderType.Limit,product_type=ProductType.Delivery,price=30.0,trigger_price=None))Cancel an orderprint(alice.cancel_order('191015000018737'))#Cancel an open orderprint(alice.cancel_order('220803000207716'))#Cancel an open orderGetting order history and trade detailsGet order history of a particular orderprint(alice.get_order_history('220803000207716'))Get order history of all orders.print(alice.get_order_history(''))Get trade bookprint(alice.get_trade_book())Get Script InfoGet Current OHLC, Upper and Lower circuit dataprint(alice.get_scrip_info(alice.get_instrument_by_token('MCX',242508)))Get Historical DataGet Historical data of Open, High, Low, Close and Volume of Minutes, Day and Month.fromdatetimeimportdatetimealice=Aliceblue(user_id='',api_key='')instrument=alice.get_instrument_by_symbol("NFO","RELIANCE")from_datetime=datetime.now()-datetime.timedelta(days=7)# From last & daysto_datetime=datetime.now()# To nowinterval="1"# ["1", "D"]indices=False# For Getting index dataprint(alice.get_historical(instrument,from_datetime,to_datetime,interval,indices))Order properties as enumsOrder properties such as TransactionType, OrderType, and others have been safely classified as enums so you don't have to write them out as stringsTransactionTypeTransaction types indicate whether you want to buy or sell. Valid transaction types are of the following:TransactionType.Buy- buyTransactionType.Sell- sellOrderTypeOrder type specifies the type of order you want to send. Valid order types include:OrderType.Market- Place the order with a market priceOrderType.Limit- Place the order with a limit price (limit price parameter is mandatory)OrderType.StopLossLimit- Place as a stop loss limit orderOrderType.StopLossMarket- Place as a stop loss market orderProductTypeProduct types indicate the complexity of the order you want to place. Valid product types are:ProductType.Intraday- Intraday order that will get squared off before market closeProductType.Delivery- Delivery order that will be held with you after market closeProductType.CoverOrder- Cover orderProductType.BracketOrder- One cancels other order. Also known as bracket orderExample strategy using alice blue APIThis strategy generates a buy signal when 5-EMA > 20-EMA (golden cross) or a sell signal when 5-EMA < 20-EMA (death cross).Read this before creating an issueBefore creating an issue in this library, please follow the following steps.Search the problem you are facing is already asked by someone else. There might be some issues already there, either solved/unsolved related to your problem. Go toissuesIf you feel your problem is not asked by anyone or no issues are related to your problem, then create a new issue.Describe your problem in detail while creating the issue. If you don't have time to detail/describe the problem you are facing, assume that I also won't be having time to respond to your problem.Post a sample code of the problem you are facing. If I copy paste the code directly from issue, I should be able to reproduce the problem you are facing.Before posting the sample code, test your sample code yourself once. Only sample code should be tested, no other addition should be there while you are testing.Have some print() function calls to display the values of some variables related to your problem.Post the results of print() functions also in the issue.Use the insert code feature of github to inset code and print outputs, so that the code is displayed neat.If you have multiple lines of code, use triple grave accent ( ``` ) to insert multiple lines of code.Example:Hereis an example of what I'm expecting while you are creating an issue.