Skip to content
Broker Queue and Auctions

Get Broker Directory

Returns the mapping between broker numbers and broker names, used to show broker names instead of numbers in the HK broker queue.

The Broker App caches the directory and its version last_updated locally, and sends the cached version at startup. When brokers in the response is not empty, it replaces the whole local directory and stores the new version. When brokers is empty, it keeps using the local cache.

GEThttps://api.lbkrs.com/v1/quote/brokers

Parameters

last_updatedintegerquery

Version of the locally cached directory, which is last_updated from the previous response. Omit it on the first request

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Broker Directory” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
brokersarray<object>

Broker directory

Child attributes
marketstring

Market of the broker, such as HK

name_cnstring

Name in Simplified Chinese

name_enstring

Name in English

name_hkstring

Name in Traditional Chinese

codesarray<string>

Broker numbers used by this broker. One broker can have several numbers

last_updatedinteger

Directory version. Send it as last_updated on the next request

Whale Docs