{"openapi":"3.1.0","info":{"title":"IPO Allotment Status API","version":"1.0.0","description":"IPO Allotment Check tells you whether an Indian IPO application was allotted shares, by checking the issue's official registrar records with the applicant's PAN, and lists every mainboard and SME IPO with dates, price, lot and listing-day gain. PAN is never stored. No key. Fair use. Please cite the source URL returned in each response."},"servers":[{"url":"https://ipoallotmentcheck.com"}],"paths":{"/api/ipo-lookup":{"get":{"operationId":"get_ipo-lookup","summary":"Takes an IPO name fragment and returns up to 25 matching Indian mainboard and SME IPOs with dates, price band, lot size, registrar and status URL, and listing-day gain. Pure lookup, no network calls.","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":80,"description":"IPO name or part of it, e.g. \"jio\""},"example":"jio"}],"responses":{"200":{"description":"Result","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"const":true},"tool":{"type":"string"},"inputs":{"type":"object"},"result":{"type":"object"},"source":{"type":"string"}}}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"const":false},"issues":{"type":"array","items":{"type":"object"}}}}}}}}},"post":{"operationId":"post_ipo-lookup","summary":"Takes an IPO name fragment and returns up to 25 matching Indian mainboard and SME IPOs with dates, price band, lot size, registrar and status URL, and listing-day gain. Pure lookup, no network calls.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":80,"description":"IPO name or part of it, e.g. \"jio\""}},"required":["query"]},"example":{"query":"jio"}}}},"responses":{"200":{"description":"Result","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"const":true},"tool":{"type":"string"},"inputs":{"type":"object"},"result":{"type":"object"},"source":{"type":"string"}}}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"const":false},"issues":{"type":"array","items":{"type":"object"}}}}}}}}}},"/api/ipo-calendar":{"get":{"operationId":"get_ipo-calendar","summary":"Takes a phase and returns up to 50 Indian IPOs in it (default allotment-this-week): upcoming, open, closed, allotted, listed, or allotment-this-week (default, allotment dates from 2 days ago to 7 days ahead). Up to 50 rows, newest first, with dates, price, lot size and the page that checks allotment.","parameters":[{"name":"phase","in":"query","required":false,"schema":{"default":"allotment-this-week","description":"Which IPOs to list: upcoming, open, closed, allotted, listed or allotment-this-week","type":"string","enum":["upcoming","open","closed","allotted","listed","allotment-this-week"]},"example":"allotment-this-week"}],"responses":{"200":{"description":"Result","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"const":true},"tool":{"type":"string"},"inputs":{"type":"object"},"result":{"type":"object"},"source":{"type":"string"}}}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"const":false},"issues":{"type":"array","items":{"type":"object"}}}}}}}}},"post":{"operationId":"post_ipo-calendar","summary":"Takes a phase and returns up to 50 Indian IPOs in it (default allotment-this-week): upcoming, open, closed, allotted, listed, or allotment-this-week (default, allotment dates from 2 days ago to 7 days ahead). Up to 50 rows, newest first, with dates, price, lot size and the page that checks allotment.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"phase":{"default":"allotment-this-week","description":"Which IPOs to list: upcoming, open, closed, allotted, listed or allotment-this-week","type":"string","enum":["upcoming","open","closed","allotted","listed","allotment-this-week"]}}},"example":{"phase":"allotment-this-week"}}}},"responses":{"200":{"description":"Result","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"const":true},"tool":{"type":"string"},"inputs":{"type":"object"},"result":{"type":"object"},"source":{"type":"string"}}}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"const":false},"issues":{"type":"array","items":{"type":"object"}}}}}}}}}},"/api/ipo-details":{"get":{"operationId":"get_ipo-details","summary":"Takes an IPO slug or name fragment and returns the full public details of that Indian IPO: dates, price band, lot size, registrar and status URL, phase and listing-day gains.","parameters":[{"name":"ipo","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":80,"description":"IPO slug, id or name fragment, e.g. \"jio\""},"example":"jio"}],"responses":{"200":{"description":"Result","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"const":true},"tool":{"type":"string"},"inputs":{"type":"object"},"result":{"type":"object"},"source":{"type":"string"}}}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"const":false},"issues":{"type":"array","items":{"type":"object"}}}}}}}}},"post":{"operationId":"post_ipo-details","summary":"Takes an IPO slug or name fragment and returns the full public details of that Indian IPO: dates, price band, lot size, registrar and status URL, phase and listing-day gains.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"ipo":{"type":"string","minLength":1,"maxLength":80,"description":"IPO slug, id or name fragment, e.g. \"jio\""}},"required":["ipo"]},"example":{"ipo":"jio"}}}},"responses":{"200":{"description":"Result","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"const":true},"tool":{"type":"string"},"inputs":{"type":"object"},"result":{"type":"object"},"source":{"type":"string"}}}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"const":false},"issues":{"type":"array","items":{"type":"object"}}}}}}}}}},"/api/listing-gains":{"get":{"operationId":"get_listing-gains","summary":"Takes an optional board and row limit and returns listing-day gains of listed Indian IPOs against the issue price, at open and at close, newest listing first.","parameters":[{"name":"board","in":"query","required":false,"schema":{"default":"all","description":"Which board to include: mainboard, sme or all","type":"string","enum":["mainboard","sme","all"]},"example":"all"},{"name":"limit","in":"query","required":false,"schema":{"default":20,"description":"Maximum rows to return, 1 to 100","type":"integer","minimum":1,"maximum":100},"example":20}],"responses":{"200":{"description":"Result","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"const":true},"tool":{"type":"string"},"inputs":{"type":"object"},"result":{"type":"object"},"source":{"type":"string"}}}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"const":false},"issues":{"type":"array","items":{"type":"object"}}}}}}}}},"post":{"operationId":"post_listing-gains","summary":"Takes an optional board and row limit and returns listing-day gains of listed Indian IPOs against the issue price, at open and at close, newest listing first.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"board":{"default":"all","description":"Which board to include: mainboard, sme or all","type":"string","enum":["mainboard","sme","all"]},"limit":{"default":20,"description":"Maximum rows to return, 1 to 100","type":"integer","minimum":1,"maximum":100}}},"example":{"board":"all","limit":20}}}},"responses":{"200":{"description":"Result","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"const":true},"tool":{"type":"string"},"inputs":{"type":"object"},"result":{"type":"object"},"source":{"type":"string"}}}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"const":false},"issues":{"type":"array","items":{"type":"object"}}}}}}}}}},"/api/check-allotment":{"post":{"operationId":"post_check-allotment","summary":"Takes an IPO and a PAN and returns whether that PAN was allotted shares in the Indian IPO (allotted, not allotted or no record), from the registrar's official records. PAN is used once for the lookup and never stored.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"ipo":{"type":"string","minLength":1,"maxLength":80,"description":"IPO slug, id or name fragment, e.g. \"jio\""},"pan":{"type":"string","minLength":1,"maxLength":20,"description":"The applicant's 10-character PAN, e.g. ABCDE1234F"}},"required":["ipo","pan"]},"example":{"ipo":"jio","pan":"ABCDE1234F"}}}},"responses":{"200":{"description":"Result","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"const":true},"tool":{"type":"string"},"inputs":{"type":"object"},"result":{"type":"object"},"source":{"type":"string"}}}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"const":false},"issues":{"type":"array","items":{"type":"object"}}}}}}}}}}}}