Broker IDs
This API is used to obtain participant IDs data (which can be synchronized once a day).
Quote Permission RequiredFree
Included with OpenAPI activation — no extra purchase needed.
SDK Links
Python |
Rust |
Go |
Node.js |
Java |
C++ |
Info
Business Command: 16
Request
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.participants()
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.participants()
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.participants()
for (const obj of resp) {
console.log(obj.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)) {
ParticipantInfo[] resp = ctx.getParticipants().get();
for (ParticipantInfo obj : resp) {
System.out.println(obj);
}
}
}
}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.participants().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.participants([](auto res) {
if (!res) {
std::cout << "failed: " << *res.status().message() << std::endl;
return;
}
for (const auto& p : *res) {
std::cout << p.broker_ids[0] << " " << p.name << 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()
participants, err := qctx.Participants(context.Background())
if err != nil {
log.Fatal(err)
}
for _, p := range participants {
fmt.Printf("%v %s\n", p.BrokerIds, p.ParticipantNameEn)
}
}Response
Response Properties
| Name | Type | Description |
|---|---|---|
| participant_broker_numbers | object[] | participant data |
| ∟ broker_ids | int32[] | broker IDs |
| ∟ participant_name_cn | string | participant name (zh-CN) |
| ∟ participant_name_en | string | participant name (en) |
| ∟ participant_name_hk | string | participant name (zh-HK) |
Protobuf
message ParticipantBrokerIdsResponse {
repeated ParticipantInfo participant_broker_numbers = 1;
}
message ParticipantInfo {
repeated int32 broker_ids = 1;
string participant_name_cn = 2;
string participant_name_en = 3;
string participant_name_hk = 4;
}
Response JSON Example
{
"participant_broker_numbers": [
{
"broker_ids": [7738, 7739],
"participant_name_cn": "华兴金融 (香港)",
"participant_name_en": "China Renaissance(HK)",
"participant_name_hk": "華興金融 (香港)"
},
{
"broker_ids": [6390, 6396, 6398, 6399],
"participant_name_cn": "国信 (香港)",
"participant_name_en": "Guosen(HK)",
"participant_name_hk": "國信 (香港)"
},
{
"broker_ids": [3168, 3169],
"participant_name_cn": "泰嘉",
"participant_name_en": "Tiger",
"participant_name_hk": "泰嘉"
}
]
}
Error Code
| Proto Error Code | Business Error Code | Descrption | 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 |