Skip to main content

Unsubscribe Quote

This API is used to unsubscribe quote.

Request

Parameters

NameTypeRequiredDescription
symbolstring[]YesSecurity code list, for example: [700.HK]

Check rules:
The maximum number of symbols that can be passed in each request is 500
sub_typeint32[]YesSubscription type list, for example: [1,2], see SubType
unsub_allboolYesIs unsubscribe all.
- When symbol is empty, unsubscribe all subscriptions
- When symbol is not empty, unsubscribe these all subscriptions of these symbols

Protobuf

message UnsubscribeRequest {
repeated string symbol = 1;
repeated SubType sub_type = 2;
bool unsub_all = 3;
}

Request Example

# Unsubscribe Quote
# https://open.longportapp.com/docs/quote/subscribe/unsubscribe
# To subscribe quotes data, please check whether "Developers" - "Quote authority" is correct.
# https://open.longportapp.com/account
#
# - HK Market - BMP basic quotation is unable to subscribe with WebSocket as it has no real-time quote push.
# - US Market - LV1 Nasdaq Basic (Only Open API).
#
# Before running, please visit the "Developers" to ensure that the account has the correct quotes authority.
# If you do not have the quotes authority, you can enter "Me - My Quotes - Store" to purchase the authority through the "LongPort" mobile app.
from longport.openapi import QuoteContext, Config, SubType
config = Config.from_env()
ctx = QuoteContext(config)

ctx.subscribe(["700.HK", "AAPL.US"], [SubType.Quote])
ctx.unsubscribe(["AAPL.US"], [SubType.Quote])

Response

Protobuf

message UnsubscribeResponse{
}

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
7301600Invalue request parametersPlease check the request parameter: sub_type