IPO Object
Complete reference for the IPO data model, type definitions and response structures
The IPO object contains comprehensive information about an Initial Public Offering. This document describes all available fields and their data types.
Object Structure
{
"id": "string",
"name": "string",
"symbol": "string",
"slug": "string",
"type": "string",
"startDate": "string",
"endDate": "string",
"listingDate": "string",
"priceRange": "string",
"listingGain": "string",
"minQty": "number",
"minAmount": "number",
"issueSize": "string",
"status": "string",
"logo": "string",
"prospectusUrl": "string",
"schedule": "array",
"about": "string",
"strengths": "array",
"risks": "array",
"mediaCoverageLinks": "array",
"nseInfoUrl": "string",
"infoUrl": "string",
"gmp": "object",
}Field Descriptions
Basic Information
| Field | Type | Description | Example |
|---|---|---|---|
id | string | Unique identifier for the IPO | "ipo-123" |
name | string | Full name of the company | "TechCorp Limited" |
symbol | string | Stock symbol/ticker | "TECHCORP" |
slug | string | URL-friendly identifier | "techcorp" |
type | string | Type of IPO | "EQ", "SME", "DEBT" |
logo | string | Company logo URL | "https://example.com/logo.png" |
status | string | Current IPO status | "open", "closed", "upcoming", "listed" or "announced" |
Dates and Timeline
| Field | Type | Description | Example |
|---|---|---|---|
startDate | string | IPO subscription start date | "2024-02-01" |
endDate | string | IPO subscription end date | "2024-02-05" |
listingDate | string | Expected listing date | "2024-02-12" |
Pricing and Financials
| Field | Type | Description | Example |
|---|---|---|---|
priceRange | string | Price band for the IPO | "95-100" |
listingGain | string | Listing gain/loss (in percentage) | "15.5", "-2" |
minQty | number | Minimum quantity of shares i.e. lot size | 150 |
minAmount | number | Minimum investment amount | 15000 |
issueSize | string | Total issue size | "192cr" |
Grey Market Premium (GMP)
This is available as an addon with the paid plans, at an additional cost over and above the base plan. To know more, refer to the billing page in your dashboard.
| Field | Type | Description | Example |
|---|---|---|---|
gmp | object | Grey Market Premium data with aggregations and sources | See GMP Object Structure |
Detailed Information
| Field | Type | Description | Example |
|---|---|---|---|
about | string | Company description | "TechCorp is a leading technology company..." |
strengths | string[] | List of company strengths | ["Strong market position", "Experienced team"] |
risks | string[] | List of investment risks | ["Market volatility", "Regulatory changes"] |
mediaCoverageLinks | string[] | Links to media coverage | ["https://example.com/news1"] |
External Links
| Field | Type | Description | Example |
|---|---|---|---|
nseInfoUrl | string | NSE information page URL | "https://www.nseindia.com/market-data/issue-information?symbol=TECHCORP" |
infoUrl | string | Company IPO information URL | "https://example.com/ipo/techcorp" |
prospectusUrl | string | Link to IPO prospectus | "https://example.com/prospectus.pdf" |
Schedule Array
The schedule field contains an array of important dates and events. Here is an example:
{
"schedule": [
{
"date": "2024-02-01",
"event": "Issue open date"
},
{
"date": "2024-02-05",
"event": "Issue close date"
},
{
"date": "2024-02-05",
"event": "UPI mandate deadline"
},
{
"date": "2024-02-08",
"event": "Allotment finalization"
},
{
"date": "2024-02-09",
"event": "Refund initiation"
},
{
"date": "2024-02-09",
"event": "Share credit"
},
{
"date": "2024-02-12",
"event": "Listing date"
}
]
}GMP Object Structure
The gmp object will only be returned in the response when includeGmp parameter is passed with a value true.
However, note that this is only available to Pro plan users who have opted-in for the GMP addon.
The gmp field contains Grey Market Premium data, which represents the latest premium at which IPO shares are trading in the unofficial market before listing. Here is the detailed structure:
{
"gmp": {
"lastUpdatedAt": "2025-10-17T20:12:03.393+00:00",
"aggregations": {
"min": 120,
"max": 145,
"mean": 132.5,
"median": 132.5,
"mode": 120
},
"sources": [
{
"name": "ipowatch",
"gmpPrice": 145
},
{
"name": "investorgain",
"gmpPrice": 120
}
]
}
}GMP Aggregations
| Field | Type | Description | Example |
|---|---|---|---|
min | number | Minimum GMP value across all sources | 120 |
max | number | Maximum GMP value across all sources | 145 |
mean | number | Average GMP value across all sources | 132.5 |
median | number | Median GMP value across all sources | 132.5 |
mode | number | Most frequently occurring GMP value (best used when multiple sources report the same value) | 120 |
GMP Sources
Each source object in the sources array contains:
| Field | Type | Description | Example |
|---|---|---|---|
name | string | Name of the GMP data source | "ipowatch", "investorgain" |
gmpPrice | number | GMP value from this specific source | 145 |
Status Values
| Status | Description |
|---|---|
open | IPO is currently open for subscription |
closed | IPO subscription period has ended |
upcoming | IPO is scheduled but not yet open for subscription |
listed | IPO has been listed on the exchange in the last 3 days |
announced | IPO has been announced but there is no subscription start or end date known |
Type Values
| Type | Description |
|---|---|
EQ | Equity IPO i.e. Mainboard |
DEBT | Debt Offering |
SME | Small and Medium Enterprise (SME) IPO |
Example Response
{
"id": "ipo-123",
"name": "TechCorp Limited",
"symbol": "TECHCORP",
"slug": "techcorp",
"type": "EQ",
"startDate": "2024-03-01",
"endDate": "2024-03-05",
"listingDate": "2024-03-12",
"priceRange": "95-100",
"listingGain": null,
"minQty": 150,
"minAmount": 15000,
"issueSize": "192cr",
"status": "open",
"logo": "https://example.com/techcorp-logo.png",
"prospectusUrl": "https://example.com/techcorp-prospectus.pdf",
"schedule": [
{
"date": "2024-03-01",
"event": "Issue open date"
},
{
"date": "2024-03-05",
"event": "Issue close date"
},
{
"date": "2024-03-05",
"event": "UPI mandate deadline"
},
{
"date": "2024-03-08",
"event": "Allotment finalization"
},
{
"date": "2024-03-09",
"event": "Refund initiation"
},
{
"date": "2024-03-09",
"event": "Share credit"
},
{
"date": "2024-03-12",
"event": "Listing date"
}
],
"about": "TechCorp is a leading technology company engaged in the development of innovative software solutions. Founded with a focus on digital transformation, the company provides enterprise-grade applications and cloud services to businesses worldwide. TechCorp operates through both domestic and international markets, serving clients across various industries including finance, healthcare, and manufacturing. The company integrates cutting-edge technology with research and development to deliver scalable and secure solutions. By leveraging its technical expertise and strategic partnerships, TechCorp aims to drive digital innovation while addressing the evolving needs of modern businesses.",
"strengths": [
"Strong R&D capabilities with focus on emerging technologies",
"Experienced management team with proven track record",
"Growing market presence in key industry verticals",
"Scalable cloud infrastructure with global reach",
"Strategic partnerships with leading technology providers"
],
"risks": [
"Intense competition from established technology players",
"Technology disruption risks and rapid market changes",
"Dependence on key personnel and talent retention",
"Cybersecurity threats and data protection challenges",
"Regulatory changes affecting technology sector"
],
"mediaCoverageLinks": [
"https://example.com/techcorp-news1",
"https://example.com/techcorp-news2"
],
"nseInfoUrl": "https://www.nseindia.com/market-data/issue-information?symbol=TECHCORP&type=Active&series=EQ#ci_info",
"infoUrl": "https://example.com/ipo/techcorp",
"gmp": {
"aggregations": {
"min": 120,
"max": 145,
"mean": 132.5,
"median": 132.5,
"mode": 120
},
"sources": [
{
"name": "ipowatch",
"gmpPrice": 145
},
{
"name": "investorgain",
"gmpPrice": 120
}
]
}
}Data Types
String Fields
- All text fields are returned as strings
- Date fields are in ISO 8601 format (
YYYY-MM-DD) - Timestamps are in ISO 8601 format with timezone (
YYYY-MM-DDTHH:mm:ssZ)
Number Fields
minQty: Integer representing minimum quantityminAmount: Integer representing minimum amount in rupees
Array Fields
schedule: Array of objects withdateandeventpropertiesstrengths: Array of stringsrisks: Array of stringsmediaCoverageLinks: Array of URLs
GMP Object Fields
gmp.aggregations: Object containing statistical aggregations of GMP valuesgmp.sources: Array of objects containing source-specific GMP data
TypeScript Interface
interface ScheduleItem {
event: string;
date: string;
}
interface GmpAggregations {
min: number;
max: number;
mean: number;
median: number;
mode: number;
}
interface GmpSource {
name: string;
gmpPrice: number;
}
interface Gmp {
aggregations: GmpAggregations;
sources: GmpSource[];
}
interface Ipo {
id: string;
name: string;
symbol: string;
slug: string;
type?: string;
startDate?: string;
endDate?: string;
listingDate?: string;
priceRange?: string;
listingGain?: string;
minQty?: number;
minAmount?: number;
issueSize?: string;
status?: string;
logo?: string;
prospectusUrl?: string;
schedule?: ScheduleItem[];
about?: string;
strengths?: string[];
risks?: string[];
mediaCoverageLinks?: string[];
nseInfoUrl?: string;
infoUrl?: string;
gmp?: Gmp;
}