EQUITY SIP ORDER BOOK

This API retrieves the Equity SIP Order Book for authorized end users through a middleware-based integration.

The API provides details of all Equity SIPs, including SIP status, frequency details, investment information, installment tracking, and available actions.

🔑 Header Parameters

Fields	Type	Required	Description	Example
Authorization	string	Yes	Bearer token for authentication	access_token
x-api-key	string	Yes	API key provided	x-api-key

🔍 Query Parameters

Fields	Type	Required	Description	Example
userId	string	Yes	User ID (UCC)	{{user_id}}
offset	integer	No	Specifies the page number of the collection to be displayed	1
limit	integer	No	Limits the number of items returned per page	20
orderStatus	number	No	Filter SIPs by status	-1

🟢 Success Response - 200 OK

Fields	Type	Description	Example
status	string	Status of API call	"success"
code	string	Response code	"s-101"
message	string	Success message	"Equity SIP Order Book fetched successfully"
data	array(object)	List of Equity SIP records	See below table

📘 SIP Order Object Fields

Fields	Type	Description	Example
sip_id	string	System-generated unique SIP identifier	"SI1411220001"
status	string	Current SIP status	"RUNNING"
transaction_type	string	Buy or Sell transaction type	"BUY"
frequency_type	string	SIP frequency	"MONTHLY"
frequency_details	string	Details of SIP frequency configuration	"5th day of every month"
executed_installments	integer	Number of completed installments	6
no_of_installments	integer	Total number of installments	12
created_date	string	SIP creation date	"2026-01-01"
frequency_start_date	string	SIP start date	"2026-01-05"
created_by	string	Application identifier from which SIP was created	"MOBAPP"
modified_by	string	Application identifier from which SIP was last modified	"WEBAPP"
investment_type	string	Investment mode	"VALUE"
invested_qty_or_val	integer	Quantity or investment value configured for SIP	5000
assest_type	string	Asset type	"EQUITY"
installment_date	string	Next scheduled installment date	"2026-08-05"
investment_value	integer	Total investment value	30000
traded_quantity	integer	Quantity accumulated through SIP executions	20
exchange	string	Exchange segment	"NSE_EQ"
scrip_token	integer	Exchange token number of the scrip	1594
symbol	string	Trading symbol	"INFY"
series	string	Series	"EQ"
bDetail	boolean	Indicates whether detailed SIP information can be viewed	true
bModify	boolean	Indicates whether SIP can be modified	true
bStop	boolean	Indicates whether SIP can be paused/stopped	true
bView	boolean	Indicates whether SIP can be viewed	true
cap_price	string	Cap price configured for SIP execution	"1600"
updated_status	string	Latest SIP status	"RUNNING"
caa_remark	string	Additional remarks associated with the SIP	"Active SIP"