API ReferenceAPI Endpoints
Get All IPOs
Retrieve a paginated list of IPOs
Endpoint
GET /iposParameters
| Parameter | Required | Description | Examples |
|---|---|---|---|
status | Yes | (string) Filter by IPO status | open, upcoming, listed, closed, announced |
type | No | (string) Filter by IPO type i.e. Mainboard / SME / DEBT etc. This also accepts comma-separated string values. | EQ, SME, DEBT, EQ,SME |
startDate | No | (string: YYYY-MM-DD) Filter IPOs starting from date | 2024-01-01 |
endDate | No | (string: YYYY-MM-DD) Filter IPOs ending before date | 2024-12-31 |
year | No | (string: YYYY) Filter IPOs by year | 2024 |
page | No | (number) Page number for pagination | 1 |
limit | No | (number) Number of results per page | 3 |
Example Request
curl -H "x-api-key: YOUR_API_KEY" \
"https://api.ipoalerts.in/ipos?status=open&limit=3&page=1"Example Response
To understand the complete response structure, refer to IPO Object.
{
"meta": {
"count": 1,
"countOnPage": 1,
"totalPages": 1,
"page": 1,
"limit": 1,
"info": "To get all IPOs, please provide a valid API key. Contact support for more information."
},
"ipos": [
{
"id": "ipo-123",
"name": "TechCorp Limited",
"symbol": "TECHCORP",
"slug": "techcorp",
"type": "EQ",
<...and other fields>
}
]
}