Skip to content
Longport WhaleLongport Whale
Add Rate Configuration

Batch Add User Rate

Batch-create user execution spread rates, submitting multiple user-rate entries at once.

Request parameters

  • Required: data (user-rate entry list)
  • See each field's definition for its format, value range, and business meaning.

Business notes

data is the user execution spread-rate entry list, submitted as a JSON array; each item corresponds to one user-rate configuration.

Risk warning

This operation batch-creates user execution spread rates, directly affecting the executed FX prices for the relevant users. Confirm the entry list before calling.

Result

On success the user execution spread rates are batch-created; see the 200 response definition for the returned content.

POSThttps://b-api.lbkrs.com/forex/user_rate_add_batch

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_conversion.rate_reference_update

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

Request body application/json

dataarray<string>required

Submit Data as a JSON array. This field is required.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure
okboolean
idstring
msgstring
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