Broker Queue
Not for Longbridge US Accounts
This method requires an AP data-center account (HK / SG). US data-center accounts will receive a region restriction error. AP accounts can call this method with any supported symbol, including US stocks.
This API is used to obtain the real-time broker queue data of security.
Quote Permission RequiredHK onlyLV2 Advanced
- HK-specific data: provides the top 40 bid/ask broker queues.
- No permission included by default — purchase "LV2 Advanced Quotes - Plus (OpenAPI)" in the Quote Store.
# broker queue for Tencent (HK market only)
longbridge brokers 700.HK
# broker queue for Alibaba
longbridge brokers 9988.HK
SDK Links
Python |
Rust |
Go |
Node.js |
Java |
C++ |
Info
Business Command: 15
Request
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | Security code, in ticker.region format, for example: 700.HK |
Protobuf
message SecurityRequest {
string symbol = 1;
}
Request Example
from longbridge.openapi import QuoteContext, Config, OAuthBuilder
oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url))
config = Config.from_oauth(oauth)
ctx = QuoteContext(config)
resp = ctx.brokers("700.HK")
print(resp)import asyncio
from longbridge.openapi import AsyncQuoteContext, Config, OAuthBuilder
async def main() -> None:
oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("Visit:", url))
config = Config.from_oauth(oauth)
ctx = AsyncQuoteContext.create(config)
resp = await ctx.brokers("700.HK")
print(resp)
if __name__ == "__main__":
asyncio.run(main())const { Config, QuoteContext, OAuth } = require('longbridge')
async function main() {
const oauth = await OAuth.build('your-client-id', (_, url) => {
console.log('Open this URL to authorize: ' + url)
})
const config = Config.fromOAuth(oauth)
const ctx = QuoteContext.new(config)
const resp = await ctx.brokers('700.HK')
console.log(resp.toString())
}
main().catch(console.error)import com.longbridge.*;
import com.longbridge.quote.*;
class Main {
public static void main(String[] args) throws Exception {
try (OAuth oauth = new OAuthBuilder("your-client-id")
.build(url -> System.out.println("Open to authorize: " + url))
.get();
Config config = Config.fromOAuth(oauth);
QuoteContext ctx = QuoteContext.create(config)) {
SecurityBrokers resp = ctx.getBrokers("700.HK").get();
System.out.println(resp);
}
}
}use std::sync::Arc;
use longbridge::{oauth::OAuthBuilder, quote::QuoteContext, Config};
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let oauth = OAuthBuilder::new("your-client-id")
.build(|url| println!("Open this URL to authorize: {url}"))
.await?;
let config = Arc::new(Config::from_oauth(oauth));
let (ctx, _) = QuoteContext::new(config);
let resp = ctx.brokers("700.HK").await?;
println!("{:?}", resp);
Ok(())
}#include <iostream>
#include <longbridge.hpp>
#ifdef WIN32
#include <windows.h>
#endif
using namespace longbridge;
using namespace longbridge::quote;
static void
run(const OAuth& oauth)
{
Config config = Config::from_oauth(oauth);
QuoteContext ctx = QuoteContext::create(config);
ctx.brokers("700.HK", [](auto res) {
if (!res) {
std::cout << "failed: " << *res.status().message() << std::endl;
return;
}
std::cout << "brokers: " << res->symbol << std::endl;
});
}
int main(int argc, char const* argv[]) {
#ifdef WIN32
SetConsoleOutputCP(CP_UTF8);
#endif
const std::string client_id = "your-client-id";
OAuthBuilder(client_id).build(
[](const std::string& url) {
std::cout << "Open this URL to authorize: " << url << std::endl;
},
[](auto res) {
if (!res) {
std::cout << "authorization failed: " << *res.status().message() << std::endl;
return;
}
run(*res);
});
std::cin.get();
return 0;
}package main
import (
"context"
"fmt"
"log"
"github.com/longbridge/openapi-go/config"
"github.com/longbridge/openapi-go/oauth"
"github.com/longbridge/openapi-go/quote"
)
func main() {
o := oauth.New("your-client-id").
OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) })
if err := o.Build(context.Background()); err != nil {
log.Fatal(err)
}
conf, err := config.New(config.WithOAuthClient(o))
if err != nil {
log.Fatal(err)
}
qctx, err := quote.NewFromCfg(conf)
if err != nil {
log.Fatal(err)
}
defer qctx.Close()
brokers, err := qctx.Brokers(context.Background(), "700.HK")
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", brokers)
}Response
Response Properties
| Name | Type | Description |
|---|---|---|
| symbol | string | Security code |
| ask_brokers | object[] | Ask brokers |
| ∟ position | int32 | Position |
| ∟ broker_ids | int32[] | Broker IDs, obtained through theGet Broker IDs API |
| bid_brokers | object[] | Bid brokers |
| ∟ position | int32 | Postition |
| ∟ broker_ids | int32[] | Broker IDs, obtained through theGet Broker IDs API |
Protobuf
message SecurityBrokersResponse {
string symbol = 1;
repeated Brokers ask_brokers = 2;
repeated Brokers bid_brokers = 3;
}
message Brokers {
int32 position = 1;
repeated int32 broker_ids = 2;
}
Response JSON Example
{
"symbol": "700.HK",
"ask_brokers": [
{
"position": 1,
"broker_ids": [7358, 9057, 9028, 7364]
},
{
"position": 2,
"broker_ids": [6968, 3448, 3348, 1049, 4973, 6997, 3448, 5465, 6997]
}
],
"bid_brokers": [
{
"position": 1,
"broker_ids": [6996, 5465, 8026, 8304, 4978]
},
{
"position": 2
}
]
}
Error Code
| Protocol Error Code | Business Error Code | Description | Troubleshooting Suggestions |
|---|---|---|---|
| 3 | 301600 | Invalid request | Invalid request parameters or unpacking request failed |
| 3 | 301606 | Request rate limit | Reduce the frequency of requests |
| 7 | 301602 | Server error | Please try again or contact a technician to resolve the issue |
| 7 | 301600 | Symbol not found | Check that the requested symbol is correct |
| 7 | 301603 | No quotes | Security no quote |
| 7 | 301604 | No access | No access to security quote |