Skip to main content

Get Subscription Information

This API is used to obtain the subscription information.

Request

Protobuf

message SubscriptionRequest {
}

Request Example

from time import sleep
from longport.openapi import QuoteContext, Config, SubType, PushQuote, Period, AdjustType

def on_quote(symbol: str, event: PushQuote):
print(symbol, event)

config = Config.from_env()
ctx = QuoteContext(config)
ctx.set_on_quote(on_quote)
ctx.subscribe(["700.HK", "AAPL.US", "TSLA.US", "NFLX.US"], [SubType.Quote], is_first_push=True)

Response

Response Properties

NameTypeDescription
sub_listobject[]Subscribed data
∟ symbolstringSecurity code
∟ sub_type[]int32Subscription type, see 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]
}
]
}

Error Code

Protocol Error CodeBusiness Error CodeDescriptionTroubleshooting Suggestions
3301600Invalid requestInvalid request parameters or unpacking request failed
3301606Request rate limitReduce the frequency of requests
7301602Server errorPlease try again or contact a technician to resolve the issue