Introduction

    API Endpoint

        https://anapi.algomojo.com/1.0/

                

Algomojo API Bridge which helps traders/investors to build, monitor, execute their trading requirement automatically.

To use this API, you need an API key. Please login to your algomojo broker terminal to get your own API key.

an.algomojo.com

Version and API root URL
The current major stable version of the API is 1.0. All requests go to it by default. It is recommended that a specific version be requested explicity for production applications as major releases may break older implementations.

Root URL
https://anapi.algomojo.com/1.0/

Each rest call will have 3 compulsory request parameters
1. api_key
2. api_secret
3. data
api_key is a key allocated to the User. Input will be in string format.
api_secret is a id received as response from Login 2FA.Input will be in string format.
data is a JSON object which is referred as Input in rest description table. If there is no input mentioned in the table you need to send it as a blank object or a blank string. Input will be in string format.

NOTE: - All APIs are considered as POST method. All the input as well as output data type will be in string format unless its mentioned in rest explanation section.


Exchange


BSE - BSE Equity
NSE - NSE Equity
NFO - NSE Futures & Options
MCX - MCX Futures


Duration


DAY - Regular Order
IOC - Immediate or Cancel


producttype


DELIVERY - Cash & Carry for equity (CNC)
CARRYFORWARD - Normal for futures and options (NRML)
MARGIN - Margin Delivery
INTRADAY - Margin Intraday Squareoff (MIS)
AMO_MARGIN - AMO Margin
AMO_DELIVERY - AMO Delivery
AMO_CARRYFORWARD - AMO Carryforward


ordertype


MARKET - Market Order(MKT)
LIMIT - Limit Order(L)
STOPLOSS_LIMIT - Stop Loss Limit Order(SL)
STOPLOSS_MARKET - Stop Loss Market Order(SL-M)


transactiontype


BUY - Buy
SELL - Sell


variety


NORMAL - Normal Order (Regular)
STOPLOSS - Stop loss order
AMO - After Market Order


PlaceOrder


# Here is a curl example
curl \
-X POST https://anapi.algomojo.com/1.0/PlaceOrder

                

To get characters you need to make a POST call to the following url :
https://anapi.algomojo.com/1.0/PlaceOrder



Request example :

{
    "api_key":"c1997d92a3bb556a67dca7d1446b70",
    "api_secret":"5306433329e81ba41203653417063c",
    "data":
      {	
      	"stgy_name": "Test Strategy",
        "variety":"NORMAL",
        "tradingsymbol":"SBIN-EQ",
        "symboltoken":"3045",
        "transactiontype":"BUY",
        "exchange":"NSE",
        "ordertype":"MARKET",
        "producttype":"DELIVERY",
        "duration":"DAY",
        "price":"0",
        "squareoff":"0",
        "stoploss":"0",
        "quantity":"1",
        "triggerprice": "0",
        "trailingStopLoss": "0",
        "disclosedquantity":"0"
	  }
}

Response example :

{
	"status":true,
	"message":"SUCCESS",
	"errorcode":"",
	"data":
		{
		 "script":"SBIN-EQ",
		 "orderid":"200910000000111"
		}
}
                

QUERY PARAMETERS

Request Parameter Description Mandatory
stgy_name Strategy Name Yes
symbol Trading Symbol Yes
exchange Exchange name Yes
transaction_type Transtaction Type Yes
duration duration - It can be one of the following
DAY
IOC
GTD
Yes
order_type Order Type - It can be one of the following
MKT - refers to Market Order
LMT - refers to Limit Order
SL - refers to Stop Loss Limit
SL-M - refers to Stop loss market
Yes
quantity Quantity Yes
disclosed_quantity Disclosed Quantity Yes
price Price Yes
trigger_price Trigger Price Yes
product Shows if the order was either
MIS - MIS Type
CNC - CNC Type
NRML - NRML Type
Yes
is_amo AMO - It can be one of the following
YES
NO
Yes

ModifyOrder


# Here is a curl example
curl \
-X POST https://anapi.algomojo.com/1.0/ModifyOrder

                

To get characters you need to make a POST call to the following url :
https://anapi.algomojo.com/1.0/ModifyOrder



Request example :

{
    "api_key":"c1997d92a3bb556a67dca7d1446b70",
    "api_secret":"5306433329e81ba41203653417063c",
    "data":
      {
        "strg_name":"Test Strategy",
        "variety":"NORMAL",
		"orderid":"201020000000080",
		"ordertype":"LIMIT",
		"producttype":"INTRADAY",
		"duration":"DAY",
		"price":"194.00",
		"quantity":"1",
		"tradingsymbol":"SBIN-EQ",
		"symboltoken":"3045",
		"exchange":"NSE"
      }
}

Response example :

{
"status":true,
"message":"SUCCESS",
"errorcode":"",
"data":{
 "orderid":"201020000000080"
  }
}
                

QUERY PARAMETERS

Request Parameter Description Mandatory
orderid the order id for which the order must be modified Yes
quantity Quantity with which the order was placed Yes
ordertype Type of order. It can be one of the following
MARKET - Market Order(MKT)
LIMIT - Limit Order(L)
STOPLOSS_LIMIT - Stop Loss Limit Order(SL)
STOPLOSS_MARKET - Stop Loss Market Order(SL-M)
Yes
producttype Type of Product. It can be one of the following
DELIVERY - Cash & Carry for equity (CNC)
CARRYFORWARD - Normal for futures and options (NRML)
MARGIN - Margin Delivery
INTRADAY - Margin Intraday Squareoff (MIS)
AMO_MARGIN - AMO Margin
AMO_DELIVERY - AMO Delivery
AMO_CARRYFORWARD - AMO Carryforward
Yes
tradingsymbol Trading Symbol Yes
price Price at which the order was placed Yes
symboltoken Symbol Token Yes
exchange Exchange Yes
variety Exchange Yes

CancelOrder


# Here is a curl example
curl \
-X POST https://anapi.algomojo.com/1.0/CancelOrder

                

To get characters you need to make a POST call to the following url :
https://anapi.algomojo.com/1.0/CancelOrder



Request example :

{
    "api_key":"c1997d92a3bb556a67dca7d1446b70",
    "api_secret":"5306433329e81ba41203653417063c",
    "data":
      {
		"variety":"NORMAL",
		"orderid":"201020000000080",
	  }
}

Response example :

{
	"status":true,
	"message":"SUCCESS",
	"errorcode":"",
	"data":{
	 "orderid":"201020000000080"
	  }
}
                

QUERY PARAMETERS

Request Parameter Description Mandatory
orderid comma separated order ID assigned internally for the order placed Yes
variety NORMAL - Normal Order (Regular)
STOPLOSS - Stop loss order
AMO - After Market Order
Yes

Profile


# Here is a curl example
curl \
-X POST https://anapi.algomojo.com/1.0/Profile

                

To get characters you need to make a POST call to the following url :
https://anapi.algomojo.com/1.0/Profile



Request example :

{
    "api_key":"c1997d92a3bb556a67dca7d1446b70",
    "api_secret":"5306433329e81ba41203653417063c"
}

Result Example:

{
    "status":true,
    "message":"SUCCESS",
    "errorcode":"",
    "data":{
        "clientcode":"YOUR_CLIENT_CODE",
        "name":"YOUR_NAME",
        "email":"YOUR_EMAIL",
        "mobileno":"YOUR_PHONE_NUMBER",
        "exchanges":"[ "NSE", "BSE", "MCX", "CDS", "NCDEX", "NFO" ]",
        "products":"[ "DELIVERY", "INTRADAY", "MARGIN"]",
        "lastlogintime":"",
        "brokerid":"B2C",
    }
}
                

QUERY PARAMETERS

Request Parameter Description Mandatory
api_key Algomojo API Key Yes
api_secret Algomojo API Secret Yes

RESPONSE ATTRIBUTES

Attribute Datatype Description
clientcode string Uniquely identifies the user
name string Name of the user
email string E-mail address of the user
mobileno string Phone number of the user
exchanges array Lists the exchanges to which the user has access
products array Lists the products types to which the user has access
lastlogintime string lastlogin for the application
brokerid string Broker ID

Limits


# Here is a curl example
curl \
-X POST https://anapi.algomojo.com/1.0/Limits

                

To get characters you need to make a POST call to the following url :
https://anapi.algomojo.com/1.0/Limits



Request example :

{
  "api_key":"c1997d92a3bb556a67dca7d1446b70",
  "api_secret":"5306433329e81ba41203653417063c"
}

Response example :

{
    "status": true,
    "message": "SUCCESS",
    "errorcode": "",
    "data": {
        "net": "0",
        "availablecash": "0",
        "availableintradaypayin": "0",
        "availablelimitmargin": "0",
        "collateral": "0",
        "m2munrealized": "0",
        "m2mrealized": "0",
        "utiliseddebits": "0",
        "utilisedspan": "0",
        "utilisedoptionpremium": "0",
        "utilisedholdingsales": "0",
        "utilisedexposure": "0",
        "utilisedturnover": "0",
        "utilisedpayout": "0"
    }
}
                

QUERY PARAMETERS

Request Parameter Description Mandatory
api_key Algomojo API Key Yes
api_secret Algomojo API Secret Yes

RESPONSE ATTRIBUTES

Attribute Datatype Description
net string Net balance
availablecash string Available Cash
availableintradaypayin string Available Intraday Pay In Amount
availablelimitmargin string Available margin Limit
collateral string The amount of Collateral
m2munrealized string Unrealized MTM Available
m2mrealized string Realized MTM Available
utiliseddebits string Debits Utilised
utilisedspan string Span Utilised
utilisedoptionpremium string Option Premium Utilised for the Trades
utilisedholdingsales string Holdings Utilised for the Trades
utilisedexposure string Exposure Utilised for the Trades
utilisedturnover string Turnover Utilised for the Trades
utilisedpayout string Payout Money for the Trades

Holdings


# Here is a curl example
curl \
-X POST https://anapi.algomojo.com/1.0/Holdings

                

To get characters you need to make a POST call to the following url :
https://anapi.algomojo.com/1.0/Holdings



Request example :

{
  "api_key":"c1997d92a3bb556a67dca7d1446b70",
  "api_secret":"5306433329e81ba41203653417063c"
}

Response example:

{
	"status":true,
	"message":"SUCCESS",
	"errorcode":"",
	"data":
		{
			"tradingSymbol":"RELIANCE-EQ",
			"exchange":"NSE",
			"isin":"0INE002A01018",
			"t1quantity":"0",
			"realisedquantity":"0",
			"quantity":"0",
			"authorisedquantity":"0",
			"profitandloss":"0",
			"product":"DELIVERY",
			"collateralquantity":"0",
			"collateraltype":"null",
			"haircut":"0",
		 }
}
                

QUERY PARAMETERS

Request Parameter Description Mandatory
api_key Algomojo API Key Yes
api_secret Algomojo API Secret Yes

RESPONSE ATTRIBUTES

Attributes Datatype Description
exchange Exchange to which the holding is associated
tradingSymbol Shows the trading symbol which could be a combination of symbol name, instrument, expiry date etc
isin ISIN Number
t1quantity T1 Quantity
realisedquantity Realised Quantity
authorisedquantity Authorised Quantity
quantity The total holding qty
profitandloss Profit and Loss
product Product Type
collateralquantity Quantity of Collateral
collateraltype Type of collateral
haircut

OrderBook


# Here is a curl example
curl \
-X POST https://anapi.algomojo.com/1.0/OrderBook

                

To get characters you need to make a POST call to the following url :
https://anapi.algomojo.com/1.0/OrderBook



Request example :

{
    "api_key":"c1997d92a3bb556a67dca7d1446b7087",
    "api_secret":"5306433329e81ba41203653417063c71"
}

Response example :
{
    "status":true,
    "message":"SUCCESS",
    "errorcode":"",
    "data":[{
        "variety":NORMAL,
        "ordertype":LIMIT,
        "producttype":INTRADAY,
        "duration":DAY,
        "price":"194.00",
        "triggerprice":"0",
        "quantity":"1",
        "disclosedquantity":"0",
        "squareoff":"0",
        "stoploss":"0",
        "trailingstoploss":"0",
        "tradingsymbol":"SBIN-EQ",
        "transactiontype":BUY,
        "exchange":NSE,
        "symboltoken":null,
        "instrumenttype":"",
        "strikeprice":"-1",
        "optiontype":"",
        "expirydate":"",
        "lotsize":"1",
        "cancelsize":"1",
        "averageprice":"0",
        "filledshares":"0",
        "unfilledshares":"1",
        "orderid":201020000000080,
        "text":"",
        "status":"cancelled",
        "orderstatus":"cancelled",
        "updatetime":"20-Oct-2020 13:10:59",
        "exchtime":"20-Oct-2020 13:10:59",
        "exchorderupdatetime":"20-Oct-2020 13:10:59",
        "fillid":null,
        "filltime":null,
     }]
}
                

QUERY PARAMETERS

Request Parameter Description Mandatory
api_key Algomojo API Key Yes
api_secret Algomojo API Secret Yes

RESPONSE ATTRIBUTES

Attributes Datatype Description
variety string Placeorder Type (NORMAL, STOPLOSS, AMO)
ordertype string Order Type (MARKET, LIMIT, STOPLOSS_LIMIT, STOPLOSS_MARKET)
producttype string Shows the trading symbol which could be a combination of symbol name, instrument, expiry date etc
duration string Duration of the Order (DAY or IOC)
price string Price
triggerprice string Trigger Price
quantity string Order Quantity
disclosedquantity string Disclosed Quantity
squareoff string Quantity with which the order was placed
stoploss string Stoploss Value
trailingstoploss string Trailing Stoploss
tradingsymbol string Trading Symbol
transactiontype string Transaction Type (BUY or SELL)
exchange string Exchange of the symbol
symboltoken string Token Number of the Symbol
instrumenttype string Type of Instrument
strikeprice string Strike Price
optiontype string Type of Option
expirydate string Expiry Date
lotsize string Lotsize of the symbol
cancelsize string Cancel of the Order
averageprice string Average price while placing the orders
filledshares string Shares filled in one order
unfilledshares string Shares unfilled in one order
orderid number Order ID
text string Message
status string Status of the Order
orderstatus string Order Status
updatetime string Updated Time
exchtime string Exchange Time
exchorderupdatetime string Exchange Order update Time
fillid string Fill ID
filltime string Fill Time

Positions


# Here is a curl example
curl \
-X POST https://anapi.algomojo.com/1.0/Positions

                

To get characters you need to make a POST call to the following url :
https://anapi.algomojo.com/1.0/Positions



Request example :

{
    "api_key":"c1997d92a3bb556a67dca7d1446b7087",
    "api_secret":"5306433329e81ba41203653417063c71"
}

Response example :

{
     "status": true,
     "message": "SUCCESS",
     "errorcode": "",
     "data": [
          {
               "exchange": "NSE",
               "symboltoken": "2885",
               "producttype": "DELIVERY",
               "tradingsymbol": "RELIANCE-EQ",
               "symbolname": "RELIANCE",
               "instrumenttype": "",
               "priceden": "1",
               "pricenum": "1",
               "genden": "1",
               "gennum": "1",
               "precision": "2",
               "multiplier": "-1",
               "boardlotsize": "1",
               "buyqty": "1",
               "sellqty": "0",
               "buyamount": "2235.80",
               "sellamount": "0",
               "symbolgroup": "EQ",
               "strikeprice": "-1",
               "optiontype": "",
               "expirydate": "",
               "lotsize": "1",
               "cfbuyqty": "0",
               "cfsellqty": "0",
               "cfbuyamount": "0",
               "cfsellamount": "0",
               "buyavgprice": "2235.80",
               "sellavgprice": "0",
               "avgnetprice": "2235.80",
               "netvalue": "- 2235.80",
               "netqty": "1",
               "totalbuyvalue": "2235.80",
               "totalsellvalue": "0",
               "cfbuyavgprice": "0",
               "cfsellavgprice": "0",
               "totalbuyavgprice": "2235.80",
               "totalsellavgprice": "0",
               "netprice": "2235.80"
          }
     ]
}
                

QUERY PARAMETERS

Request Parameter Description Mandatory
api_key Algomojo API Key Yes
api_secret Algomojo API Secret Yes

TradeBook


# Here is a curl example
curl \
-X POST https://anapi.algomojo.com/1.0/TradeBook

                

To get characters you need to make a POST call to the following url :
https://anapi.algomojo.com/1.0/TradeBook



Request example :

{
    "api_key":"c1997d92a3bb556a67dca7d1446b7087",
    "api_secret":"5306433329e81ba41203653417063c71"
}

Response example :

{
    "status":true,
    "message":"SUCCESS",
    "errorcode":"",
    "data":[{
        "exchange":NSE,
        "producttype":DELIVERY,
        "tradingsymbol":"ITC-EQ",
        "instrumenttype":"",
        "symbolgroup":"EQ",
        "strikeprice":"-1",
        "optiontype":"",
        "expirydate":"",
        "marketlot":"1",
        "precision":"2",
        "multiplier":"-1",
        "tradevalue":"175",
        "transactiontype":"BUY",
        "fillprice":"175",
        "fillsize":"1",
        "orderid":"201020000000095",
        "fillid":"50005750",
        "filltime":"13:27:53",
     }]
}
                

QUERY PARAMETERS

Request Parameter Description Mandatory
api_key Algomojo API Key Yes
api_secret Algomojo API Secret Yes

RESPONSE ATTRIBUTES

Attributes Datatype Description
exchange string Exchange to which the order is associated
producttype string Product type of the Trade
tradingsymbol string Trading Symbol
instrumenttype string Instrument Type
symbolgroup string symbolgroup
strikeprice string Strike Price
optiontype string Option type
expirydate string expiry date
marketlot string Market Lot for the order placed
precision string Precision upto
multiplier string multiplier
tradevalue string Trade Value
transactiontype string Transaction Type
fillprice string Fill Price
fillsize string Fill Size
orderid string order id of the order placed
fillid string fill id
filltime string fill time

Feed


# Here is a curl example
curl \
-X POST https://anapi.algomojo.com/1.0/Feed

                

To get characters you need to make a POST call to the following url :
https://anapi.algomojo.com/1.0/Feed



Request example :

{
    "api_key":"c1997d92a3bb556a67dca7d1446b7087",
    "api_secret":"5306433329e81ba41203653417063c71",
    "data": {
        "exchange":"NSE",
		"tradingsymbol":"SBIN-EQ",
		"symboltoken":"3045"
    }
}

Response example :

{
	"status":true,
	"message":"SUCCESS",
	"errorcode":"",
		"data":
		{
			"exchange":"NSE",
			"tradingsymbol":"SBIN-EQ",
			"symboltoken":"3045",
			"open":"186",
			"high":"191.25",
			"low":"185",
			"close":"187.80",
			"ltp":"191",
		 }
}

                

QUERY PARAMETERS

Request Parameter Description Mandatory
exchange name of the exchange
BSE - BSE Equity
NSE - NSE Equity
NFO - NSE Futures & Options
MCX - MCX Futures
Yes
tradingsymbol Shows the trading symbol which could be a combination of symbol name, instrument, expiry date etc Yes
symboltoken Symbol Token Yes

RESPONSE ATTRIBUTES

Attributes Datatype Description
status string Status of request
message string Message
errorcode string Error code
exchange string Exchange
tradingsymbol string Trading Symbol
symboltoken string symbol token
open string Open price
high string high
low string low price
close string close
ltp string ltp