Introduction

    API Endpoint

        https://fyapi.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.

fy.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://fyapi.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.

Fytoken

Exchanges

Segments

Product Types

Order Types

Order Sides

Order Status

Order Sides

Symbology Format

PlaceOrder

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

                

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

Request example :

{
    "api_key":"c1997d92a3bb556a67dca7d1446b7087",
    "api_secret":"5306433329e81ba41203653417063c71",
    "data":
        {
            "strg_name": "Test Strategy",
            "symbol":"NSE:RELIANCE-EQ",
            "qty":"1",
            "type":"2",
            "side":"1",
            "productType":"INTRADAY",
            "limitPrice":0,
            "stopPrice": 0,
            "validity": "DAY",
            "disclosedQty": 0,
            "offlineOrder": "False",
            "stopLoss": 0,
            "takeProfit": 0
        }
}

Response example :

{
    "s": "error",
    "code": -174,
    "message": "RMS:1111644:NSE EQUITY 2885 RELIANCE INTRADAY  EQ XR03832 B 1 I 2368.45 MARKET IS CLOSE YOU CANNOT PLACE AN ORDER NOW",
    "id": "1111644"
}
                

REQUEST ATTRIBUTES

PlaceMultiOrder

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

                

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

Request example :

{
    "api_key":"c1997d92a3bb556a67dca7d1446b7087",
    "api_secret":"5306433329e81ba41203653417063c71",
    "data":
      {
          "orders" : 
            [
                {
                "order_refno":"1",
                "user_apikey":"c1997d92a3bb556a67dca7d1446b7087",
                "api_secret":"5306433329e81ba41203653417063c71",
                "strg_name": "Test Strategy",
                "symbol":"NSE:RELIANCE-EQ",
                "qty":"1",
                "type":"2",
                "side":"1",
                "productType":"INTRADAY",
                "limitPrice":0,
                "stopPrice": 0,
                "validity": "DAY",
                "disclosedQty": 0,
                "offlineOrder": "False",
                "stopLoss": 0,
                "takeProfit": 0
                },
                {
                "order_refno":"2",
                "strg_name": "Test Strategy",
                "user_apikey":"c1997d92a3bb556a67dca7d1446b7087",
                "api_secret":"5306433329e81ba41203653417063c71",
                "symbol":"NSE:SBIN-EQ",
                "qty":"1",
                "type":"2",
                "side":"1",
                "productType":"INTRADAY",
                "limitPrice":0,
                "stopPrice": 0,
                "validity": "DAY",
                "disclosedQty": 0,
                "offlineOrder": "False",
                "stopLoss": 0,
                "takeProfit": 0
                }
            ]
      }
}

Response example :

[
    {
        "s": "error",
        "code": -99,
        "message": "RMS:169444:NSE,EQUITY,2885,RELIANCE,INTRADAY,,EQ,XR03832,B,1,I,2380.60010,FUND LIMIT INSUFFICIENT,AVAILABLE FUND=29.33,ADDITIONAL REQUIRED FUND=446.79,CALCULATED MARGIN FOR ORDER=476.12",
        "id": "169444"
    },
    {
        "s": "error",
        "code": -99,
        "message": "RMS:169454:NSE,EQUITY,3045,SBIN,INTRADAY,,EQ,XR03832,B,1,I,437.95001,FUND LIMIT INSUFFICIENT,AVAILABLE FUND=29.33,ADDITIONAL REQUIRED FUND=58.26,CALCULATED MARGIN FOR ORDER=87.59",
        "id": "169454"
    }
]
                

REQUEST ATTRIBUTES

PlaceFOOptionsOrder

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

                

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

Request example :

{
    "api_key":"c1997d92a3bb556a67dca7d1446b70",
    "api_secret":"5306433329e81ba41203653417063c",
    "data":
      {
        "stgy_name":"Options",
        "spot_sym":"NIFTY",
        "expiry_dt":"22D08",
        "opt_type":"PE",
        "side":"-1",
        "type":"2",
        "qty":"50",
        "limitPrice":"0",
        "stopPrice":"0",
        "productType":"MARGIN",
        "strike_int":"50",
        "offset":"-4"
      }      
}

Response example :

{
    "s": "ok",
    "code": 1101,
    "message": "Order Submitted Successfully. Your Order Ref. No.2221201528222",
    "id": "2221201528222",
    "symbol": "NSE:NIFTY22D0818600PE"
}
                

REQUEST ATTRIBUTES

ModifyOrder

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

                

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

Request example :

{
    "api_key":"c1997d92a3bb556a67dca7d1446b70",
    "api_secret":"5306433329e81ba41203653417063c",
    "data":
      {
        "strg_name":"Test Strategy",
        "id":809229222111,
        "qty":1,
        "type":2,
        "side":1,
        "limitPrice":61200
      }
}

Response example :

{
  "s": "ok",
  "code": 1101,
  "message": "Successfully modified order', 'id': '808058117761"
}
                

REQUEST ATTRIBUTES

CancelOrder

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

                

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

Request example :

{
    "api_key":"c1997d92a3bb556a67dca7d1446b70",
    "api_secret":"5306433329e81ba41203653417063c",
    "data":
      {
        "id":"52009227353"
      }
}

Response example :

{
  "s": "ok",
  "code": 1103,
  "message": "Successfully cancelled order",
  "id": "808058117761"
}
                

REQUEST ATTRIBUTES

profile

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

                

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

Request example :

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

Result Example:

{
    "s": "ok",
    "code": 200,
    "message": "",
    "data": {
        "name": "YOUR NAME",
        "image": null,
        "display_name": null,
        "email_id": "YOUR EMAIL ID",
        "PAN": "YOUR PAN DETAILS",
        "fy_id": "YOUR CLIENT ID",
        "pwd_change_date": "03-07-2021 09:49:11",
        "pwd_to_expire": 43
    }
}
                

REQUEST ATTRIBUTES

RESPONSE ATTRIBUTES

funds

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

                

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

Request example :

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

Response example :

{
    "s": "ok",
    "code": 200,
    "message": "",
    "fund_limit": [
        {
            "id": 9,
            "title": "Limit at start of the day",
            "equityAmount": 29.33,
            "commodityAmount": 0
        },
        {
            "id": 8,
            "title": "Adhoc Limit",
            "equityAmount": 0,
            "commodityAmount": 0
        },
        {
            "id": 7,
            "title": "Receivables",
            "equityAmount": 0,
            "commodityAmount": 0
        },
        {
            "id": 6,
            "title": "Fund Transfer",
            "equityAmount": 0,
            "commodityAmount": 0
        },
        {
            "id": 5,
            "title": "Collaterals",
            "equityAmount": 0,
            "commodityAmount": 0
        },
        {
            "id": 4,
            "title": "Realized Profit and Loss",
            "equityAmount": 0,
            "commodityAmount": 0
        },
        {
            "id": 2,
            "title": "Utilized Amount",
            "equityAmount": 0,
            "commodityAmount": 0
        },
        {
            "id": 3,
            "title": "Clear Balance",
            "equityAmount": 29.33,
            "commodityAmount": 0
        },
        {
            "id": 1,
            "title": "Total Balance",
            "equityAmount": 29.33,
            "commodityAmount": 0
        },
        {
            "id": 10,
            "title": "Available Balance",
            "equityAmount": 29.33,
            "commodityAmount": 0
        }
    ]
}
                

REQUEST ATTRIBUTES

RESPONSE ATTRIBUTES

Holdings

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

                

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

Request example :

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

Response example:

{
    "s": "ok",
    "code": 200,
    "message": "",
    "holdings": [
        {
            "holdingType": "HLD",
            "quantity": 1,
            "costPrice": 12.4,
            "marketVal": "11.10",
            "remainingQuantity": 1,
            "pl": -1.3,
            "ltp": 11.1,
            "id": 1,
            "fyToken": "101000000011915",
            "exchange": 10,
            "symbol": "NSE:YESBANK-EQ"
        }
    ],
    "overall": {
        "count_total": 1,
        "total_investment": 12.4,
        "total_current_value": 11.1,
        "total_pl": -1.3,
        "pnl_perc": -10.4839
    }
}
                

REQUEST ATTRIBUTES

RESPONSE ATTRIBUTES

OrderBook

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

                

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

Request example :

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

Response example :
{
    "s": "ok",
    "code": 200,
    "message": "",
    "orderBook": [
        {
            "orderDateTime": "20-Aug-2021 12:32:31",
            "id": "174264",
            "exchOrdId": "1300000013082682",
            "side": 1,
            "segment": 10,
            "instrument": 0,
            "productType": "CNC",
            "status": 2,
            "qty": 1,
            "remainingQuantity": 0,
            "filledQty": 1,
            "limitPrice": 0,
            "stopPrice": 0,
            "type": 2,
            "discloseQty": 0,
            "dqQtyRem": 0,
            "orderValidity": "DAY",
            "source": "ITS",
            "slNo": 1,
            "fyToken": "101000000011915",
            "offlineOrder": false,
            "message": "TRADE CONFIRMED",
            "orderNumStatus": "174264:2",
            "tradedPrice": 11.1,
            "exchange": 10,
            "pan": "YOUR PAN CARD",
            "clientId": "YOUR CLIENT ID",
            "symbol": "NSE:YESBANK-EQ",
            "ch": -0.2,
            "chp": -1.77,
            "lp": 11.1,
            "ex_sym": "YESBANK",
            "description": "YES BANK LIMITED"
        }
    ]
}
                

REQUEST ATTRIBUTES

RESPONSE ATTRIBUTES

TradeBook

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

                

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

Request example :

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

Response example :

{
    "s": "ok",
    "code": 200,
    "message": "",
    "tradeBook": [
        {
            "clientId": "YOUR CLIENT CODE",
            "orderDateTime": "23-Aug-2021 11:07:33",
            "orderNumber": "162004",
            "exchangeOrderNo": "1300000010099693",
            "exchange": 10,
            "transactionType": 1,
            "segment": 10,
            "orderType": 2,
            "fyToken": "101000000011915",
            "productType": "CNC",
            "tradedQty": 1,
            "tradePrice": 10.9,
            "tradeValue": 10.9,
            "tradeNumber": "77846484",
            "id": "77846484",
            "row": 1,
            "symbol": "NSE:YESBANK-EQ"
        }
    ]
}
                

REQUEST ATTRIBUTES

RESPONSE ATTRIBUTES

Positions

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

                

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

Request example :

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

Response example :

{
    "s": "ok",
    "code": 200,
    "message": "",
    "netPositions": [
        {
            "netQty": 1,
            "qty": 1,
            "avgPrice": 11.1,
            "netAvg": 11.1,
            "side": 1,
            "productType": "CNC",
            "realized_profit": 0,
            "unrealized_profit": 0.05,
            "pl": 0.05,
            "ltp": 11.15,
            "buyQty": 1,
            "buyAvg": 11.1,
            "buyVal": 11.1,
            "sellQty": 0,
            "sellAvg": 0,
            "sellVal": 0,
            "slNo": 0,
            "fyToken": "101000000011915",
            "dummy": "          ",
            "crossCurrency": "N",
            "rbiRefRate": 1,
            "qtyMulti_com": 1,
            "segment": 10,
            "symbol": "NSE:YESBANK-EQ",
            "id": "NSE:YESBANK-EQ-CNC"
        }
    ],
    "overall": {
        "count_total": 1,
        "count_open": 1,
        "pl_total": 0.05,
        "pl_realized": 0,
        "pl_unrealized": 0.05
    }
}
                

REQUEST ATTRIBUTES

RESPONSE ATTRIBUTES

SquareOffPosition

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

                

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

Request example :

{
    "api_key":"c1997d92a3bb556a67dca7d1446b7087",
    "api_secret":"5306433329e81ba41203653417063c71",
    "data":
    {
        "id" : "NSE:SBIN-EQ-BO"
    }
}

Response example :

{
    "s": "ok",
    "code": 200,
    "message": "The position is closed",
}
                

REQUEST ATTRIBUTES

SquareOffAllPositions

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

                

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

Request example :

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

Response example :

{
    "s": "ok",
    "code": 200,
    "message": "",
}
                

PartialPositionconvertion

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

                

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

Request example :

{
    "api_key":"c1997d92a3bb556a67dca7d1446b7087",
    "api_secret":"5306433329e81ba41203653417063c71",
    "data":
    {
      "symbol":"MCX:SILVERMIC20NOVFUT",
      "positionSide":1,
      "convertQty":1,
      "convertFrom":"INTRADAY",
      "convertTo":"CNC"
    }    
}

Response example :

 {
  "s": "ok",
  "code": 200,
  "message": "Position Converted Successfully!!",
  "positionDetails": 1101
}
                

REQUEST ATTRIBUTES

Notes
1. CNC, CO and BO positions cannot be converted.
2.You cannot convert positions to CO and BO

fetchtoken

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

                

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

Request example :

{
    "api_key":"c1997d92a3bb556a67dca7d1446b7087",
    "api_secret":"5306433329e81ba41203653417063c71",
    "data":
        {
            "s":"RELIANCE-EQ"
        }
}

Response example :

{
    "trading_symbol": "INFY-EQ",
    "exch": "NSE",
    "token": "1594",
    "lot_size": "1",
    "fy_symbol": "NSE:INFY-EQ",
    "fy_token": "10100000001594",
    "s": "ok"
}

                

REQUEST ATTRIBUTES

RESPONSE ATTRIBUTES

GetQuotes

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

                

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

Request example :

{
    "api_key": "c1997d92a3bb556a67dca7d1446b7087",
    "api_secret":"5306433329e81ba41203653417063c71",
    "data": {
        "fy_symbol":"NSE:RELIANCE-EQ"
    }
}

Response example :

{
    "s": "ok",
    "d": [
        {
            "n": "NSE:RELIANCE-EQ",
            "s": "ok",
            "v": {
                "ch": -63.45,
                "chp": -2.64,
                "lp": 2340.45,
                "spread": 0,
                "ask": 0,
                "bid": 0,
                "open_price": 2398.05,
                "high_price": 2408,
                "low_price": 2320,
                "prev_close_price": 2403.9,
                "volume": 9714489,
                "short_name": "RELIANCE-EQ",
                "exchange": "NSE",
                "description": "NSE:RELIANCE-EQ",
                "original_name": "NSE:RELIANCE-EQ",
                "symbol": "NSE:RELIANCE-EQ",
                "fyToken": "10100000002885",
                "tt": 1639872000
            }
        }
    ]
}

                

REQUEST ATTRIBUTES

RESPONSE ATTRIBUTES