Skip to main content

IPO Orders

This API retrieves data from the IPO order book based on specified filters such as date, offer type, IPO code, application number, etc.

🔍Query Parameters

ParameterTypeDescriptionExample
startdatestringStart date of the order book filter (YYYY-MM-DD)2022-03-12
endDatestringEnd date of the order book filter (YYYY-MM-DD)2022-04-11
offerTypeintegerType of IPO offer1
offernamestringName of the IPO offerABC IPO
statusstringStatus of the order-1
ipoCodestringUnique IPO code for the offeringIPO1234
applicationNostringApplication number submitted for the IPO9876541

🔑Header Parameters

HeaderTypeDescriptionExample
AuthorizationstringBearer token for authenticationaccess-token
x-api-keystringAPI provided for access{{x-api-key}}

🟢Success Response - 200 Ok

FieldTypeDescriptionExample
statusstringIndicates the status of the API request"success"
codestringResponse code indicating the result of the API call"s-101"
messagestringDescriptive message of the result"IPO order book fetched successfully"
dataobjectContainer object for actual data payload{ "data": [...] }
get/transactional/v1/ipo/orders