Skip to content
Longport WhaleLongport Whale
Fund Theme

Fund return rates

Query the return rate of each fund across different measurement periods to read a fund's historical performance.

Request parameters

  • Use filters to combine business conditions (see the filter field notes below), and use page, page_size, and orderBy for pagination and sorting.

Business notes

The data comes from fund return-rate records, joined with fund basic information to supply the fund name.

Each record carries the fund code, the return-rate measurement period, the return value for that period, and the fund name.

It is typically used when configuring fund rankings, hot-sale, or recommendation lists to read a fund's return for a given period, and can be filtered by measurement period and fund code.

Returns

On success, returns the matching record list with pagination info. See the response definition for column meanings.

POSThttps://b-api.lbkrs.com/v1/datasets/fund_return_rates

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

fund.fund_product

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

filtersobject

Filters

Child attributes
return_typestring

Yield Time Range

Allowed values: 1d 1 day, 1w 1 week, 1m 1 month, 3m 3 months, 6m 6 months, ytd Year to date, 1y 1 year, 2y 2 years, 3y 3 years, 5y 5 years, 10y 10 years

Values
1d
1w
1m
3m
6m
ytd
1y
2y
3y
5y
10y
counter_idstring

Fund Code. Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000.

pageinteger

Page

page_sizeinteger

Page Size

orderByarray<object>

Order By

Responses

HTTP 200Paginated list result.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List

Child attributes
counter_idstring

Fund Code

return_typestring

Yield Time Range

return_valuestring

Return Rate

name_localsstring

Name

totalintegerrequired

Total

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs