SIP Orders¶

The SIP Orders API provides a comprehensive list of all SIPs (Systematic Investment Plans) created by the user. It returns both active and inactive SIPs, along with their configuration, schedule, and execution status.

Type	API Endpoint	Description
POST	`/orders/sip/execute`	Executes a new SIP order.
POST	`/orders/sip/modify`	Modifies an existing SIP order.
GET	`/info/sip/orderbook`	Retrieves the SIP order book including active and paused SIPs.
POST	`/orders/sip/cancel`	Cancels an active SIP order.
POST	`/orders/sip/resume`	Resumes a previously paused SIP.
POST	`/orders/sip/pause`	Pauses an active SIP order.

SIP Execute¶

The SIP Execute API is used to create and initiate a new Systematic Investment Plan (SIP) order. It sets up recurring investments in a selected stock, ETF, or mutual fund based on parameters like frequency, quantity, and start date. Once executed, the SIP will automatically place orders as per the defined schedule until modified, paused, or canceled.

Request Structure

{
    "regDate": "19052025",
    "startDate": "19062025",
    "frequency": "0",
    "endPeriod": "1",
    "sipName": "AD",
    "scrips": [
        {
            "exchange": "NSE",
            "tradingSymbol": "TCS-EQ",
            "product": "CNC",
            "token": "11536",
            "qty": "1"
        }
    ]
}

Input parameters

Field	Type	Description
regDate	String	Date of SIP registration in DDMMYYYY format.
startDate	String	Date when the SIP should begin, in DDMMYYYY format.
frequency	String / Integer	SIP frequency: 0 = Daily, 1 = Weekly, 2 = Monthly, etc. (as per system config).
endPeriod	String / Integer	Duration or number of SIP cycles (e.g., 1 = one-time SIP).
sipName	String	User-defined name/label for the SIP.
scrips	Array	List of instruments (stocks, ETFs, etc.) included in the SIP.
exchange	String	Exchange where the instrument is listed (e.g., NSE, BSE).
tradingSymbol	String	Trading symbol of the instrument (e.g., TCS-EQ).
product	String	Product type: CNC (delivery), MIS (intraday), etc.
token	String	Internal token ID for the instrument.
qty	String / Integer	Quantity to invest per cycle in this scrip.

Response Structure

{
    "status": "Ok",
    "message": "Success",
    "result": [
        {
            "orderNo": "25042400000049"
        }
    ]
}

Parameters

Field	Type	Description
status	String	Status of the response
message	String	Message indicating result status
result	Array	Array of result objects
orderNo	String	Order number generated

SIP Modify¶

The SIP Modify API allows users to update the details of an existing Systematic Investment Plan (SIP). It can be used to change parameters such as start date, frequency, quantity, product type, or the list of scrips. The modification takes effect from the next scheduled SIP cycle.

Request Structure

{
    "regDate": "19062025",
    "startDate": "19062025",
    "frequency": "3",
    "endPeriod": "3",
    "sipName": "fut",
    "prevExecDate": "28042025",
    "dueDate": "26-05-2025",
    "execDate": "26-05-2025",
    "period": "1",
    "active": "true",
    "orderNo": "25042400000049",
    "scrips": [
        {
            "exchange": "NSE",
            "tradingSymbol": "TCS-EQ",
            "product": "CNC",
            "token": "11536",
            "price": "2000"
        }
    ]
}

Input parameters

Field	Type	Description
regDate	String	SIP registration date in DDMMYYYY format.
startDate	String	New start date of the SIP in DDMMYYYY format.
frequency	String / Integer	Frequency of SIP execution: 0 = Daily, 1 = Weekly, 2 = Monthly, 3 = Custom, etc.
endPeriod	String / Integer	Number of SIP cycles or the period until which SIP runs.
sipName	String	Identifier or label for the SIP (can be updated).
prevExecDate	String	Last execution date in DDMMYYYY format. Used for tracking/history.
dueDate	String	Date when the SIP is next due to be executed (DD-MM-YYYY format).
execDate	String	Execution date for the current or next SIP run (DD-MM-YYYY format).
period	String / Integer	SIP interval period – e.g., 1 for every cycle, 2 for alternate.
active	String / Boolean	"true" or "false" indicating if the SIP is active.
orderNo	String	Unique identifier of the existing SIP to be modified.
scrips	Array	List of instruments included in the SIP, with new values.
exchange	String	Exchange name where the instrument is listed (e.g., NSE, BSE).
tradingSymbol	String	Instrument's trading symbol (e.g., TCS-EQ).
product	String	Product type (e.g., CNC, MIS).
token	String	Instrument token used internally by the trading platform.
price	String / Decimal	Optional price for limit orders (if applicable).

Response Structure

{
    "status": "Ok",
    "message": "Success",
    "result": null
}

Parameters

Field	Type	Description
status	String	Status of the response
message	String	Message indicating result status
result	Array	Array of result objects

SIP OrderBook¶

The SIP OrderBook API provides a list of all Systematic Investment Plans (SIPs) created by the user, including their status, scrip details, frequency, execution dates, and order numbers. It helps users track and manage active, paused, or completed SIPs along with their configurations and history.

Response Structure

{
    "status": "Ok",
    "message": "Success",
    "result": [
        {
            "regDate": "19-06-2025",
            "startDate": "19-06-2025",
            "frequency": "3",
            "endPeriod": "3",
            "sipName": "fut",
            "scrips": [
                {
                    "exchange": "NSE",
                    "token": "11536",
                    "tradingSymbol": "TCS-EQ",
                    "product": "CNC",
                    "qty": null,
                    "sipType": "prc",
                    "price": "2000"
                }
            ],
            "internal": {
                "prevExecDate": "0",
                "dueDate": "19-06-2025",
                "execDate": "19-06-2025",
                "period": "0",
                "active": "true",
                "orderNo": "25042400000049"
            }
        },
        {
            "regDate": "28-05-2025",
            "startDate": "28-05-2025",
            "frequency": "2",
            "endPeriod": "10",
            "sipName": "Tcs ",
            "scrips": [
                {
                    "exchange": "NSE",
                    "token": "11536",
                    "tradingSymbol": "TCS-EQ",
                    "product": "CNC",
                    "qty": "1",
                    "sipType": "qty",
                    "price": null
                }
            ],
            "internal": {
                "prevExecDate": "0",
                "dueDate": "28-05-2025",
                "execDate": "28-05-2025",
                "period": "0",
                "active": "true",
                "orderNo": "25042400000038"
            }
        }
    ]
}

parameters

Field	Type	Description
status	String	API call status (e.g., "Ok").
message	String	API response message (e.g., "Success").
result	Array	List of SIPs returned by the order book. Each entry contains SIP info.
regDate	String	SIP registration date in DD-MM-YYYY format.
startDate	String	SIP start date in DD-MM-YYYY format.
frequency	String	SIP frequency code (0 = Daily, 1 = Weekly, 2 = Monthly, etc.).
endPeriod	String	Total number of cycles or period count for the SIP.
sipName	String	User-defined label or identifier for the SIP.
scrips	Array	List of instruments (stocks) involved in the SIP.
exchange	String	Exchange name (e.g., NSE).
token	String	Internal token ID of the instrument.
tradingSymbol	String	Trading symbol of the instrument (e.g., TCS-EQ).
product	String	Product type (e.g., CNC, MIS).
qty	String / null	Quantity to buy (null if SIP is price-based).
sipType	String	SIP type: "qty" = quantity-based, "prc" = price-based.
price	String / null	Price for price-based SIPs (null if quantity-based).
prevExecDate	String	Last SIP execution date (0 if never executed).
dueDate	String	Scheduled next SIP execution date.
execDate	String	Actual execution date (same as dueDate unless deferred).
period	String	SIP cycle interval value (e.g., every 1, 2, etc.).
active	String	"true" if SIP is active, "false" if paused/canceled.
orderNo	String	Unique order number associated with the SIP.

SIP Cancel¶

The SIP Cancel API is used to terminate or cancel an existing Systematic Investment Plan (SIP). Once canceled, the SIP will stop placing further scheduled orders, and no future investments will be executed for that plan.

Request Structure

{
    "orderNo":"25042400000049"
}

Input parameters

Field	Type	Description
orderNo	String	The unique identifier of the SIP to be canceled. Required to locate and stop the plan execution.

Response Structure

{
    "status": "Ok",
    "message": "Success",
    "result": [
        {
            "orderNo": "25042400000049"
        }
    ]
}

Parameters

Field	Type	Description
status	String	Status of the response
message	String	Message indicating result status
result	Array	Array of result objects
orderNo	String	Order number generated

SIP Resume¶

The SIP Resume API is used to reactivate a previously paused Systematic Investment Plan (SIP). Once resumed, the SIP will continue executing orders as per the original schedule (start date, frequency, and duration).

Request Structure

{
    "orderNo":"25042400000049"
}

Input parameters

Field	Type	Description
orderNo	String	The unique identifier of the SIP to be Resumed.

Response Structure

{
    "status": "Ok",
    "message": "Success",
    "result": [
        {
            "orderNo": "25042400000049"
        }
    ]
}

Parameters

Field	Type	Description
status	String	Status of the response
message	String	Message indicating result status
result	Array	Array of result objects
orderNo	String	Order number generated

SIP Pause¶

The SIP Pause API is used to temporarily suspend an active Systematic Investment Plan (SIP). When paused, the SIP will not place any scheduled orders until it is resumed via the SIP Resume API.

Request Structure

{
    "orderNo":"25042400000049"
}

Input parameters

Field	Type	Description
orderNo	String	The unique identifier of the SIP to be Paused.

Response Structure

{
    "status": "Ok",
    "message": "Success",
    "result": [
        {
            "orderNo": "25042400000049"
        }
    ]
}

Parameters

Field	Type	Description
status	String	Status of the response
message	String	Message indicating result status
result	Array	Array of result objects
orderNo	String	Order number generated