Skip to content
Longport WhaleLongport Whale
Short Selling Configure

Get Security Lending Config

Reads the current securities-lending configuration for a market, including lending rates and settlement prices, so callers can pre-fill the payload for "set securities-lending config" (POST /clearing/security_lending_set_config).

Request parameters

  • Required: market.
  • See the field definitions for format and business meaning.

Returns

On success, returns the market's rate_configs (lending-rate configuration list) and price_configs (lending settlement-price configuration list); either may be an empty array. See the response definition for field meanings.

POSThttps://b-api.lbkrs.com/clearing/security_lending_get_config

Authorization

AuthorizationstringheaderRequired

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

Permission

billing.short_selling_configure

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

Request body application/json

marketstringrequired

The market whose configuration is queried. This field is required.

Responses

HTTP 200On success, returns the market's security-lending rate and settlement-price configuration.
Standard response envelopecodemessagedata
dataobjectdata structure
rate_configsarray<object>

Securities lending rate configurations. May be an empty array.

Child attributes
originstring

Rate source, such as IB.

rate_ratiostring

Rate ratio (numeric string).

rate_deltastring

Rate delta (numeric string).

cutoff_methodinteger

Cutoff method code (integer).

cutoff_digitsinteger

Cutoff digits.

min_ratestring

Minimum rate (numeric string).

price_configsarray<object>

Securities lending settlement price configurations. May be an empty array.

Child attributes
currencystring

Currency.

transfer_ratestring

transfer_rate ratio (numeric string).

cutoff_methodinteger

Cutoff method code (integer).

cutoff_digitsinteger

Cutoff digits.

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