IPO Allotment Odds API - PeopleBase & Bidding Intelligence
Comprehensive endpoint blending category-level share subscriptions with application counts, maximum allottee caps, and 1-in-X lottery allotment odds (PeopleBase) for Retail and HNI tranches. Also includes automated narrative market commentary.
Endpoint Overview & Architecture
The Combined Subscription with App-Wise Intelligence endpoint is the most advanced predictive tool in our Indian IPO data suite. It aggregates raw exchange share bids, total investor application counts, and maximum allottee limits to automatically calculate the exact mathematical lottery odds for Retail, sNII, and bNII applicants.
The resulting "peopleBase" metric gives users an intuitive 1-in-X odds figure (e.g. peopleBase: 6 means 1 in every 6 retail applicants will receive an allotment lot). This eliminates complex manual spreadsheets and allows fintech apps to display instant allotment chances to users.
Furthermore, this endpoint outputs an automated, natural-language narrative commentary synthesizing category performance, total applications received, and overall oversubscription dynamics.
Request Authentication Headers
| Header Name | Type | Required | Description |
|---|---|---|---|
| ApiKey | string | Required | Your secret API access key provided upon subscription registration. |
| ApiSecret | string | Required | Your secret API client secret used to sign and authenticate requests. |
Request Parameters
| Parameter | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
| ipoId | path | integer | Required | - | Target IPO unique ID (e.g. 257). |
Code Examples
curl -X GET "https://api.ipoapipro.in/api/ipo/subscription-with-appwise/257" \ -H "ApiKey: YOUR_API_KEY" \ -H "ApiSecret: YOUR_API_SECRET"
Sample JSON Response
{
"isSuccess": true,
"message": "Successfully.",
"data": {
"ipoId": 257,
"companyName": "Shah Investor's Home Ltd",
"displayName": "Shah Investor's Home",
"urlName": "shah-investors-home-ipo",
"type": "MAINBOARD",
"companyLogo": "https://api.ipoapipro.in/upload/ipodata/logo/shah-investor-s-home-logo.jpg",
"isSMENewRule": false,
"price": 167,
"appWiseSubscription": [
{
"name": "BHNI (10L+)",
"reserved": 423,
"applied": 1840,
"subscriptionTimes": 4.35,
"maxWinner": 423,
"peopleBase": 4
},
{
"name": "SHNI (2L - 10L)",
"reserved": 212,
"applied": 4230,
"subscriptionTimes": 19.95,
"maxWinner": 212,
"peopleBase": 20
},
{
"name": "Retail",
"reserved": 22232,
"applied": 124525,
"subscriptionTimes": 5.6,
"maxWinner": 22232,
"peopleBase": 6
}
],
"totalApplications": 130595,
"appWiseSummary": "Shah Investor's Home: For BHNI (10L+), 423 shares were reserved, 1,840 were applied, and the subscription was 4.35x. For SHNI (2L - 10L), 212 shares were reserved, 4,230 were applied, and the subscription was 19.95x. For Retail, 22,232 shares were reserved, 1,24,525 were applied, and the subscription was 5.60x. Total applications received were 1,30,595.",
"lastUpdated": "30 Sept 2026, 06:30:00 pm"
}
}Response Attributes Schema
| Attribute | Type | Description |
|---|---|---|
| data.appWiseSubscription[].name | string | Investor category name (Retail, BHNI, SHNI, Employees). |
| data.appWiseSubscription[].reserved | integer | Quota shares/lots reserved for this category. |
| data.appWiseSubscription[].applied | integer | Total applications submitted in this category. |
| data.appWiseSubscription[].subscriptionTimes | number | Subscription ratio based on category allocation. |
| data.appWiseSubscription[].peopleBase | integer | Lottery odds ratio (1 in X applicants receive allotment). |
| data.totalApplications | integer | Total consolidated application count across all investor categories. |
| data.appWiseSummary | string | Automated narrative summary of application bidding performance. |
HTTP Status & Error Codes
| HTTP Code | Title | Condition & Resolution |
|---|---|---|
| 400 | Bad Request | Missing mandatory query parameters, invalid types, or unsupported filter combinations. |
| 401 | Unauthorized | The request lacked valid authentication credentials (ApiKey or ApiSecret). |
| 403 | Forbidden | The subscription plan has expired or this specific endpoint is not included in the plan. |
| 429 | Too Many Requests | Rate limit exceeded. Standard tier permits 60 req/min, Professional tier permits 300 req/min. |
| 500 | Internal Server Error | Downstream exchange connection glitch or upstream registrar network timeout. |
Rate Limits & Edge Caching SLA
Default Rate Limit: 60 requests/minute (Standard) | 300 requests/minute (Pro). Requests are served through Cloudflare edge points of presence across Mumbai, Delhi, Bengaluru, and Chennai with sub-15ms cached latency.
Related IPO API Endpoints
Up-to-the-minute subscription multiples (times subscribed) per investor category and total bids.
Live breakdown of total application counts, bidding applications per category, and subscription multiples.
Direct registrar Basis of Allotment (BoA) official documents and allotment ratios by year and board type.