Subscribe

The market data request is not supported via Webull OpenAPI at the moment. Please keep tuned.

Interface Description

caution

The subscription interface can only be used after establishing a long MQTT link. persistent connection building can refer to Market Push Quotes.

• Function description:

  • Real-time quotes unsubscribe interface is subscribed to real-time quotes pushes according to symbol and data type.

  • Each App ID has a maximum of 1 push connection. The number of subscription topics is limited to 100, and a sub_type of a symbol is 1 topic.

    • The following parameters initiate a subscription, then 6 topics are generated:

      • symbol: AAPL,TSLA

      • sub_types: QUOTE,SNAPSHOT,TICK

• Request URL: /market-data/streaming/subscribe

• Request method: Establish a gRPC through the Webull SDK to establish a persistent connection, and then call the interface to obtain it.

• Frequency limit: The calling frequency of each App ID is limited to 10 times per minute.

Request Parameters

Parameter	Type	Required fields	Description
token	String	Yes	Subscribe to the token returned by the pre-request, and the token needs to be a token that has already created a connection, for example: 2d29ea02-8a35-11ec-8356-020017000b7b
symbols	[]String	Yes	Securities code, for example: [AAPL,TSLA], up to 50 symbols at a time
category	String	Yes	Security Type. Reference: Category
sub_types	[]String	Yes	If there are multiple Subscription Data Types, please separate them by commas",". Reference: SubType, such as: [SNAPSHOT].

Request Example

Python

from webullsdktrade.grpc_api import API
from webullsdkquotescore.grpc.grpc_client import GrpcApiClient
from webullsdkcore.common.region import Region

grpc_client = GrpcApiClient(your_app_key, your_app_secret, Region.US.value)
api = API(grpc_client)
response = api.market_data.create_subscription_rel(token, symbols, category, sub_types)
if response.status_code == 200:
    print('subscribe successful')

Java

try (QuotesApiClient quotesApiClient = QuotesApiClient.builder()
        .appKey(Env.APP_KEY)
        .appSecret(Env.APP_SECRET)
        .regionId(Region.us.name())
        .build()) {
    quotesApiClient.subscribe(token, symbols, category, subTypes);
}

Response Example

No return value