Skip to content
Assets

Get IPO Subscription P/L Summary

Queries the IPO subscription P/L summary of the current account for the specified statistics period (amounts in HKD). Returns the total IPO subscription P/L and P/L rate, the amounts and shares of allotted profit, allotted loss, and non-allotted loss, the position market value, sold amount, IPO subscription cost, allotment rate, and allotted profit rate. Used for the summary and the P/L breakdown donut chart on the IPO subscription P/L page.

GEThttps://api.lbkrs.com/v2/portfolio/asset/ipo_analysis

Parameters

periodstringqueryRequired

Statistics period:

  • all: All
  • 1m: Last 1 month
  • 3m: Last 3 months
  • 6m: Last 6 months
  • 1y: Last 1 year

all1m3m6m1y

account_channelstringquery

Broker channel

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get IPO subscription P/L summary” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
periodstring

Statistics period, with the same values as the period request parameter; an empty string when there are no IPO subscription records

is_tradedboolean

Whether there are IPO subscription trading records; when false, the page shows the empty state, and all other amount fields are empty strings

updated_atstring

Data update time, as a timestamp in seconds

sum_profitstring

Total P/L generated by IPO subscriptions for stocks within the selected period

sum_profit_ratestring

P/L ratio, as a decimal (for example 0.12 means 12%)

profit_amountstring

Allotted profit amount (the "Allotted profit" part of the P/L breakdown)

profit_percentagestring

Share of the allotted profit amount

deficit_amountstring

Allotted loss amount (the "Allotted loss" part of the P/L breakdown)

deficit_percentagestring

Share of the allotted loss amount

unlucky_deficit_amountstring

Non-allotted loss amount (the "Non-allotted loss" part of the P/L breakdown)

unlucky_deficit_percentagestring

Share of the non-allotted loss amount

holding_valuestring

Position market value: the market value of the remaining allotted shares after allotment, calculated on a first-in, first-out (FIFO) basis; excludes positions bought in the grey market or after the listing date

sold_valuestring

Sold amount: the amount sold within the allotted shares during the selected period after allotment, calculated on a first-in, first-out (FIFO) basis; sell order handling fees are not deducted

ipo_coststring

IPO subscription cost: the sum of three parts within the selected period: the cost of positions remaining after allotment, the cost of positions allotted in the current period, and the subscription handling fees and financing interest for non-allotted subscriptions

lucky_ipo_ratestring

Allotment rate, as a decimal

lucky_ipo_earning_ratestring

Allotted profit rate, as a decimal

Whale Docs