Files
2022-06-01 15:24:12 +08:00

4.0 KiB
Raw Permalink Blame History

id, title, slug, sidebar_position
id title slug sidebar_position
quote_subscribe 订阅行情数据 subscribe 2

该接口用于订阅标的行情数据。

:::info

业务指令6

:::

Request

Parameters

Name Type Required Description
symbol string[] 订阅的标的代码,例如:[700.HK]

校验规则:
每次请求支持传入的标的数量上限是 500
每个用户同时订阅标的数量最多为 500
sub_type int32[] 订阅的数据类型,例如:[1,2],详见 SubType
is_first_push bool 订阅后是否立刻进行一次数据推送。( trade 不支持)

Protobuf

message SubscribeRequest {
  repeated string symbol = 1;
  repeated SubType sub_type = 2;
  bool is_first_push = 3;
}

Request Example

# 订阅行情数据
# https://open.longbridgeapp.com/docs/quote/subscribe/subscribe
# 订阅行情数据请检查“开发者中心” - “行情权限”是否正确
# https://open.longbridgeapp.com/account
#
# - 港股 - BMP 基础报价,无实时行情推送,无法用 WebSocket 订阅
# - 美股 - LV1 纳斯达克最优报价 (只限 Open API
#
# 运行前请访问“开发者中心”确保账户有正确的行情权限。
# 如没有开通行情权限,可以通过“长桥”手机客户端,并进入“我的 - 我的行情 - 行情商城”购买开通行情权限。
from time import sleep
from longbridge.openapi import QuoteContext, Config, SubType

class EventHandler:
    def on_event(self, symbol: str, msg):
        print(symbol, msg)

config = Config.from_env()
ctx = QuoteContext(config, EventHandler())

ctx.subscribe(["700.HK", "AAPL.US"], [SubType.Quote], is_first_push = True)
sleep(30)

Response

Response Properties

返回本次请求订阅成功的标的和类型。

Name Type Description
sub_list object[] 订阅的数据
∟ symbol string 标的代码
∟ sub_type int32[] 订阅的数据类型,详见:SubType

Protobuf

message SubscriptionResponse {
  repeated SubTypeList sub_list = 1;
}

message SubTypeList {
  string symbol = 1;
  repeated SubType sub_type = 2;
}

Response JSON Example

{
  "sub_list": [
    {
      "symbol": "700.HK",
      "sub_type": [1, 2, 3]
    },
    {
      "symbol": "AAPL.US",
      "sub_type": [2]
    }
  ]
}

接口限制

:::caution

  • 港股 BMP 行情不支持行情数据推送。

:::

错误码

协议错误码 业务错误码 描述 排查建议
3 301600 无效的请求 请求参数有误或解包失败
3 301606 限流 降低请求频次
7 301602 服务端内部错误 请重试或联系技术人员处理
7 301605 订阅数量超出限制 取消部分订阅
7 301600 请求参数有误 检查请求的 sub_type