API docs by Redocly

IPO Analysis API (0.5.0)

Download OpenAPI specification:

Register IPOs to track. Served by API Gateway (REST API) and AWS Lambda.

IPO

IPO registration.

Register an IPO

Registers an IPO under an id derived from its name, with its status worked out from the subscription dates. An IPO whose name differs only in case, spacing or punctuation from a registered one is rejected as a duplicate.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 200 ] characters

Company name, as on the broker's listing. Surrounding whitespace is trimmed; it must contain a letter or digit. Names that differ only in case, spacing or punctuation are the same IPO.

Open Date (string) or Open Date (null) (Open Date)
Default: null

First day of the subscription window (IST). Required with close_date.

Close Date (string) or Close Date (null) (Close Date)
Default: null

Last day of the subscription window (IST); not before open_date.

Responses

Request samples

Content type
application/json
{
  • "close_date": "2026-10-08",
  • "name": "Acme Ltd",
  • "open_date": "2026-10-01"
}

Response samples

Content type
application/json
{
  • "close_date": "2026-10-08",
  • "created_at": "2026-10-04T09:30:00Z",
  • "ipo_id": "acme-ltd",
  • "name": "Acme Ltd",
  • "open_date": "2026-10-01",
  • "status": "OPEN"
}