IPO LIST API
This API returns the list of ongoing, upcoming, and closed IPOs available to the user.
🔍 Query Parameters
| Parameter | Type | Required | Description | Example / Enum |
|---|
| userId | string | Yes | User ID (UCC) | "{{user_id}}" |
| type | number | No | IPO category filter | -1 |
| offerName | string | No | Filter by offer name | "ABC Technologies IPO" |
| offerType | string | No | Offer type | "IPO" |
| Header | Type | Description | Example |
|---|
| Content-Type | string | Request payload format | application/json |
| Authorization | string | Access token for authenticated requests | {{access_token}} |
| x-api-key | string | API key used to authorize request | {{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 | "IPO list fetched successfully" |
| data | object | IPO data grouped by category | Refer IPO List Fields |
📦 Current IPO List
| Field | Type | Description | Example |
|---|
| IPOCode | string | IPO code | "IPO123" |
| OfferName | string | Offer name | "ABC Technologies Ltd" |
| OfferType | string | Offer type | "IPO" |
| MinPrice | integer | Minimum bid price | 100 |
| MaxPrice | integer | Maximum bid price | 120 |
| StartDate | string | IPO opening date | "10-06-2026" |
| EndDate | string | IPO closing date | "12-06-2026" |
| IssueSize | string | Total issue size | "₹500 Cr" |
| FaceValue | integer | Face value per share | 10 |
| LotSize | string | Lot size | "125" |
| IssueType | string | Issue type | "Book Building" |
| MinOrderQty | integer | Minimum order quantity | 125 |
| MinAmount | integer | Minimum investment amount | 15000 |
| nMarketLotBIDQty | string | Market lot quantity | "125" |
| nMinimumLotBIDQty | string | Minimum bid lot quantity | "125" |
| dtStartDate | string | Start date/time | "2026-06-10" |
| dtDailyStartTime | string | Daily subscription start time | "10:00:00" |
| dtDailyEndTime | string | Daily subscription end time | "17:00:00" |
| brokerReco | string | Broker recommendation | "SUBSCRIBE" |
| exchange | string | Exchange | "NSE" |
| bidStatus | string | User bid status | "APPLIED" |
| placeModifyBid | boolean | Bid placement/modification allowed | true |
| cardDisplay | boolean | Display flag | true |
📦 Future IPO List
Future IPO List contains the same fields as Current IPO List and represents IPOs that are scheduled to open in the future.
📦 Past IPO List
Past IPO List contains the same fields as Current IPO List and represents IPOs that have already closed.
| Field | Type | Description | Example |
|---|
| metadata | string | Additional IPO metadata returned by the system | "IPO Summary Data" |
📝 Notes
- IPOs are categorized into:
- CurrentIPOList → Ongoing IPOs
- FutureIPOList → Upcoming IPOs
- PastIPOList → Closed IPOs
- Use
offerType to filter specific offer categories.
- Use
offerName to search for a particular IPO.
- Useful for:
- IPO dashboards
- IPO application workflows
- IPO discovery and tracking