Skip to content
Longport WhaleLongport Whale
Sending Brokerage Firm

Delete Rival Broker

Deletes a counterparty broker record.

Request parameters

  • Required: brokers_id (counterparty broker record ID)
  • See the field descriptions for the format, value range, and business meaning of each field.

Risk warning

This operation permanently deletes live counterparty broker configuration data and cannot be undone. Confirm the target record before calling.

Result

On success, the counterparty broker record is deleted. The resulting state and returned data follow the 200 response definition.

POSThttps://b-api.lbkrs.com/atm/delete_brokers

Authorization

AuthorizationstringheaderRequired

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

Permission

cmbc.broker_rival

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

Request body application/json

brokers_idstringrequired

Rival Broker Record ID. Corresponds to the list row record.id.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

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