Skip to main content

IPO ORDERS

This API returns the user's IPO Order Book, including IPO applications placed across different offers along with their current status.

🔍 Query Parameters

ParameterTypeRequiredDescriptionExample
userIdstringYesUser ID (UCC)"{{user_id}}"
startdatestringNoStart date for filtering IPO orders"2023-01-27"
endDatestringNoEnd date for filtering IPO orders"2022-01-27"
offerTypeintegerNoIPO offer type filter1
offernamestringNoIPO offer name filter"ABC Technologies Ltd"
statusnumberNoIPO application status filter-1
ipoCodestringNoIPO code filter"NMULTSB1"
applicationNostringNoIPO application number"APP123456"

🔑 Header Parameters

HeaderTypeDescriptionExample
Content-TypestringRequest payload formatapplication/json
AuthorizationstringAccess token for authenticated requests{{access_token}}
x-api-keystringAPI key used to authorize request{{x-api-key}}

🟢 Success Response - 200 OK

Content-Type: application/json

FieldTypeDescriptionExample
statusstringStatus of API call"success"
codestringResponse code"s-101"
messagestringSuccess message"IPO orders fetched successfully"
dataobjectIPO order book detailsRefer Data Fields

📦 Data Fields

FieldTypeDescription
dataarrayList of IPO orders/applications matching the applied filters