Skip to content
Longport WhaleLongport Whale
Sending Brokerage Firm

Sending Brokerage Firm

Queries Sending Brokerage Firm data. Combine business filters in filters, and use page, page_size, and orderBy to control pagination and sorting.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

GEThttps://b-api.longbridge.xyz/v1/datasets/atm_rival_brokers

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

Authorizationstringheadercmbc.broker_rivalRequired

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

Query parameters

filtersobject

Filters. Combines business filters. Omit a filter field to disable that filter.

Child attributes
idstring

ID. Filters results by ID.

updated_atobject

Update Time. Filters results by Update Time.

Child attributes
gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

marketstring

Market. Filters results by Market.

Allowed values: HK, US, CN (CN Market), SG

HKUSCNSG

ticket_operationstring

Audit Status. Filters results by Audit Status.

Allowed values:

  • 0 - Initial
  • 1 - New to approve
  • 2 - Edit to approve
  • 3 - Delete to approve

0123

statestring

Status. Filters results by Status.

Allowed values:

  • 1 - Enabled
  • 2 - Disabled

12

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated Sending Brokerage Firm records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List. Returned value: List of list.

Child attributes
idstring

ID. Returned value: Unique identifier of the current record.

marketstring

Market. Returned value: Market.

market_valstring

Market (raw value). Raw value of market. The market field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

multi_namestring

Name of broker. Returned value: Name of broker.

multi_local_app_namestring

Broker App Name. Returned value: Broker App Name.

codestring

Code. Returned value: Code.

us_codestring

Participant Number. Returned value: Participant Number.

contactstring

The Contact. Returned value: The Contact.

contact_phonestring

Contact Phone Number. Returned value: Contact Phone Number.

contact_emailstring

Contact Email. Returned value: Contact Email.

tpl_emailstring

Template key for transfer email. Returned value: Template key for transfer email.

stock_limitstring

Stock number limited. Returned value: Stock number limited.

account_limitstring

Account Number format. Returned value: Account Number format.

iconstring

Brokerage logo. Returned value: Brokerage logo.

is_has_attachmentstring

Any Attachment. Returned value: Indicates whether any attachment.

is_has_attachment_valstring

Any Attachment (raw value). Raw value of is_has_attachment. The is_has_attachment field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

show_namestring

Brokerage name how to show. Returned value: Brokerage name how to show.

show_name_valstring

Brokerage name how to show (raw value). Raw value of show_name. The show_name field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

websitestring

Website. Returned value: Website.

statestring

Status. Returned value: Status.

state_valstring

Status (raw value). Raw value of state. The state field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

prioritystring

Priority. Returned value: Priority.

ticket_operationstring

Audit Status. Returned value: Audit Status.

ticket_operation_valstring

Audit Status (raw value). Raw value of ticket_operation. The ticket_operation field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

created_atstring

Creation Time. Returned value: Creation Time. The date or time format follows the value returned by the API.

updated_atstring

Update Time. Returned value: Update Time. The date or time format follows the value returned by the API.

totalintegerrequired

Total. Returned value: Total number of matching records, used for pagination.

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