Equity SIP order Book

This API retrieves the list of Equity SIP (Systematic Investment Plan) orders, including their status, frequency, investment details, and flags for modification or control.

🔍Query Parameters

Fields	Type	Required	Description	Example/Enum
offset	integer	no	Page number for pagination	1
limit	integer	no	Maximum records per page	20
orderstatus	string	no	Filter by Order Status:1=Pending,2=Completed, -1=All	-1

🔑Header Parameters

Fields	Type	Required	Description	Example/Enum
authorization	string	yes	Bearer token for authentication	access_token
content-type	string	yes	MIME Type	application/JSON
x-api-key	string	yes	API key provided by bearer	x-api-key

🟢Success Response - 200 Ok

Fields	Type	Description	Example
status	String	Response of the API status	success
code	string	Response code to the user request	"s-101"
message	string	Success message	"Orders fetched successfully"
data	array of objects	List of SIP Orders	See table below

📝Data array of objects fields

Fields	Type	Description	Example/Enum
sip_id	string	Unique system-generated SIP order ID	SIP202406XYZ
status	string	Current SIP status	INITIAL, PENDING,RUNNING,COMPLETTED,CANCELLED,STOPPED
transaction_type	string	Order type: BUY or SELL	BUY
frequency_type	string	SIP frequency	DAILY, MONTHLY, WEEKLY,FORTNIHTLY,MOTHLY
frequency_details	string	Additional frequency details	1st monday
executed_installments	integer	Number of complted installments	5
no_of_installments	integer	Total number of installments	12
created_date	string	Date of SIP created	2025-06-01
frequency_start_date	string	SIP frequency start date	2025-06-05
created_by	string	App/Terminal ID from where SIP was created	WEB_APP_001
modified_by	string	App/Terminal ID from where SIP was modified	MOBILE_APP_002
investment_type	string	QUANTITY or VALUE investment type	VALUE
invested_qty_or_val	integer	Quantity or value for investmen	5000
asset_type	string	TYpe of asset	Equity
installment_date	string	Next SIP installment date	2025-07-01
investment_value	integer	Amount to be invested per installment	5000
traded_quantity	integer	Quantity already traded	40
exchange	string	Exchange segments	NSE_EQ
scrip_token	integer	Token number for the instrument	12345
symbol	string	Stock symbol	TCS
series	string	Series (Apllication for equities )	EQ
bdetail	boolean	Flag to indicate if SIP detail is enabled	tue
bModify	boolean	Flag inidicate if modification is allowed	true
bStop	boolean	Flag to indicate if SIP can be stopped	true
bView	boolean	Flag to indicate if SIP is viewable	true
cap_price	string	Cap price or SIP	950.00
updated_status	string	Updated status of theSIP order	RUNNING
caa_remark	string	Remarks related to SIP order	Clients paused SIP

get/transactional/v1/eqsipOrders