EQUITY SIP ORDER BOOK
This API returns the Equity SIP order book records, including SIP lifecycle status, execution details, and metadata.
🔍 Query Parameters
| Parameter | Type | Required | Description | Example / Enum |
|---|
| client_id | string | No | Client ID to fetch SIPs for a user | "VISHAL1" |
| offset | integer | No | Page number for pagination | 1 |
| limit | integer | No | Number of records per page | 20 |
| orderStatus | number | No | SIP filter | 1 = Pending, 2 = Completed, -1 = All |
| Header | Type | Description | Example |
|---|
| Content-Type | string | Request payload format | application/json |
| Authorization | string | Access token | {{access_token}} |
| x-api-key | string | API key | {{x-api-key}} |
🟢 Success Response - 200 OK
Content-Type: application/json
| Field | Type | Description | Example |
|---|
| status | string | Status of API call | "success" |
| code | string | Response code | "s-101" |
| message | string | Success message | "SIP order book fetched successfully" |
| data | array | SIP order records | Refer Data Object Fields |
📦 Data Object Fields
| Field | Type | Description | Example / Enum |
|---|
| sip_id | string | Unique SIP ID | "SI123456" |
| status | string | Current SIP status | "INITIAL", "PENDING", "RUNNING", "COMPLETED", "CANCELLED", "STOPPED" |
| transaction_type | string | Buy/Sell | "BUY", "SELL" |
| frequency_type | string | SIP frequency | "DAILY", "WEEKLY", "FORTHNIGHTLY", "MONTHLY" |
| frequency_details | string | Frequency description | "Every Monday" |
| executed_installments | integer | Completed installments | 5 |
| no_of_installments | integer | Total installments | 12 |
| created_date | string | SIP creation date | "2026-05-01" |
| frequency_start_date | string | Start date | "2026-05-05" |
| created_by | string | Source of creation | "WEB", "DEALER" |
| modified_by | string | Source of modification | "WEB" |
| investment_type | string | Investment type | "QUANTITY", "VALUE" |
| invested_qty_or_val | integer | Quantity or value | 1000 |
| assest_type | string | Asset type | "EQUITY" |
| installment_date | string | Next installment date | "2026-06-05" |
| investment_value | integer | Investment amount | 5000 |
| traded_quantity | integer | Total traded quantity | 50 |
| exchange | string | Exchange segment | "NSE_EQ", "BSE_EQ" |
| scrip_token | integer | Scrip token | 12345 |
| symbol | string | Symbol | "INFY" |
| series | string | Series | "EQ" |
| bDetail | boolean | Detail flag | true, false |
| bModify | boolean | Modify flag | true, false |
| bStop | boolean | Stop flag | true, false |
| bView | boolean | View flag | true, false |
| cap_price | string | Maximum allowed price | "2600" |
| updated_status | string | Updated SIP status | "INITIAL", "PENDING", "RUNNING", "COMPLETED", "CANCELLED", "STOPPED" |
| caa_remark | string | Remarks | "User paused SIP" |