快速开始

要求

• 请首先在Webull美国官网生成 app key和app secret。
• 编程语言版本要求：

Python

需要安装Python 3.7或以上版本。

Java

需要安装JDK 8或以上版本。

SDK 说明

包依赖说明

Python

无论使用哪个产品的开发工具包，必须安装的包

• webull-python-sdk-core

使用行情订阅产品，必须安装的包

• webull-python-sdk-quotes-core

使用交易事件订阅产品，必须安装的包

• webull-python-sdk-trade-events-core

对行情sdk的完整使用，默认需要安装的包

• webull-python-sdk-core
• webull-python-sdk-quotes-core
• webull-python-sdk-mdata

对交易sdk的完整使用，默认需要安装的包

• webull-python-sdk-core
• webull-python-sdk-trade-events-core
• webull-python-sdk-trade

Java

对行情sdk的完整使用，必须添加的库

• webull-java-sdk-quotes

使用交易事件订阅产品，必须添加的库

• webull-java-sdk-trade-events

对交易sdk的完整使用，默认需要添加的库

• webull-java-sdk-trade-events
• webull-java-sdk-trade

SDK 安装

Python

通过pip方式安装

pip3 install --upgrade webull-python-sdk-core
pip3 install --upgrade webull-python-sdk-quotes-core
pip3 install --upgrade webull-python-sdk-mdata
pip3 install --upgrade webull-python-sdk-trade-events-core
pip3 install --upgrade webull-python-sdk-trade

Java

Maven配置

<dependencies>
    <dependency>
        <groupId>com.webull.openapi</groupId>
        <artifactId>webull-java-sdk-quotes</artifactId>
        <version>0.2.0</version>
    </dependency>
    
    <dependency>
        <groupId>com.webull.openapi</groupId>
        <artifactId>webull-java-sdk-trade-events</artifactId>
        <version>0.2.0</version>
    </dependency>
    
    <dependency>
        <groupId>com.webull.openapi</groupId>
        <artifactId>webull-java-sdk-trade</artifactId>
        <version>0.2.0</version>
    </dependency>
</dependencies>

API Host

提示

Http API地址用于普通Http请求。

交易消息推送地址用于订单状态变化等实时消息推送。

行情消息推送地址用于实时行情消息推送。

生产环境

HTTP API: api.webull.com
交易消息推送: events-api.webull.com
行情消息推送: usquotes-api.webullfintech.com

调用示列

注意

以下接口示列，默认连接地址为生产环境。

Http接口示列

Python

from webullsdkcore.client import ApiClient
from webullsdktrade.api import API
from webullsdkcore.common.region import Region

your_app_key = "<your_app_key>"
your_app_secret = "<your_app_secret>"
api_client = ApiClient(your_app_key, your_app_secret, Region.US.value)
api = API(api_client)
if __name__ == '__main__':
    res = api.account.get_app_subscriptions()
    account_id = None
    if res.status_code == 200:
        print('app subscriptions:', res.json())
        result = res.json()
        account_id = result[0]['account_id']
        print("account id:", account_id)

    if account_id is None:
        print("account id is null")

Java

import com.webull.openapi.common.Region;
import com.webull.openapi.example.config.Env;
import com.webull.openapi.http.HttpApiConfig;
import com.webull.openapi.trade.api.TradeApiService;
import com.webull.openapi.trade.api.http.TradeHttpApiService;
import com.webull.openapi.trade.api.response.Account;
import com.webull.openapi.logger.Logger;
import com.webull.openapi.logger.LoggerFactory;
import com.webull.openapi.utils.CollectionUtils;
import com.webull.openapi.utils.StringUtils;

import java.util.List;

public class TradeAccountId {

    private static final Logger logger = LoggerFactory.getLogger(TradeAccountId.class);

    public static void main(String[] args) {
        HttpApiConfig apiConfig = HttpApiConfig.builder()
                .appKey(Env.APP_KEY)
                .appSecret(Env.APP_SECRET)
                .regionId(Region.us.name())
                .build();
        TradeApiService apiService = new TradeHttpApiService(apiConfig);

        List<Account> accounts = apiService.getAccountList("");

        if (CollectionUtils.isNotEmpty(accounts)) {
            String accountId = accounts.get(0).getAccountId();
            if (StringUtils.isNotBlank(accountId)) {
                logger.info("Account id: {}", accountId);
                return;
            }
        }
        logger.info("Account id is empty.");
    }
}

交易消息推送示列

Python

import logging

from webullsdktradeeventscore.events_client import EventsClient
from webullsdkcore.common.region import Region

your_app_key = "<your_app_key>"
your_app_secret = "<your_app_secret>"
account_id = "<your_account_id>"


def _on_log(level, log_content):
    print(logging.getLevelName(level), log_content)


if __name__ == '__main__':
    client = EventsClient(your_app_key, your_app_secret, Region.US.value)
    client.on_log = _on_log
    print("subscribe account", [account_id])
    client.do_subscribe([account_id])

Java

import com.webull.openapi.common.Region;
import com.webull.openapi.example.config.Env;
import com.webull.openapi.logger.Logger;
import com.webull.openapi.logger.LoggerFactory;
import com.webull.openapi.trade.events.subscribe.EventClient;
import com.webull.openapi.trade.events.subscribe.Subscription;
import com.webull.openapi.trade.events.subscribe.message.SubscribeRequest;
import com.webull.openapi.trade.events.subscribe.message.SubscribeResponse;

public class TradeEvents {

    private static final Logger logger = LoggerFactory.getLogger(TradeEvents.class);

    public static void main(String[] args) {
        try (EventClient client = EventClient.builder()
                .appKey(Env.APP_KEY)
                .appSecret(Env.APP_SECRET)
                .regionId(Region.us.name())
                .onMessage(TradeEvents::handleEventMessage)
                .build()) {

            SubscribeRequest request = new SubscribeRequest("<your_account_id>");

            Subscription subscription = client.subscribe(request);
            subscription.blockingAwait();
        } catch (Exception ex) {
            logger.error("Subscribe trade events error", ex);
        }
    }

    private static void handleEventMessage(SubscribeResponse response) {
        logger.info("Received trade event={}", response.getPayload());
    }
}

行情消息推送示列

Python

from webullsdkmdata.common.category import Category
from webullsdkmdata.common.subscribe_type import SubscribeType
from webullsdkmdata.quotes.subscribe.default_client import DefaultQuotesClient
from webullsdkcore.common.region import Region

your_app_key = "<your_app_key>"
your_app_secret = "<your_app_secret>"


def pt_logs(client, userdata, level, buf):
    print("userdata:%s, level:%s, buf:%s" % (userdata, level, buf))


def on_message(client, userdata, message):
    print("Received message '" + str(message.payload) + "' on topic '"
          + message.topic + "' with QoS " + str(message.qos))


if __name__ == '__main__':
    client = DefaultQuotesClient(your_app_key, your_app_secret, Region.US.value)
    client.init_default_settings('AAPL', Category.US_STOCK.name, SubscribeType.SNAPSHOT.name)
    client.on_log = pt_logs
    client.on_message = on_message
    client.connect_and_loop_forever()

Java

import com.webull.openapi.common.Region;
import com.webull.openapi.common.dict.Category;
import com.webull.openapi.common.dict.SubscribeType;
import com.webull.openapi.example.config.Env;
import com.webull.openapi.logger.Logger;
import com.webull.openapi.logger.LoggerFactory;
import com.webull.openapi.quotes.subsribe.QuotesSubsClient;
import com.webull.openapi.quotes.subsribe.message.MarketData;
import com.webull.openapi.serialize.JsonSerializer;

import java.util.HashSet;
import java.util.Set;

public class QuotesSubscribe {

    private static final Logger logger = LoggerFactory.getLogger(QuotesSubscribe.class);

    public static void main(String[] args) {
        Set<String> symbols = new HashSet<>();
        symbols.add("AAPL");

        Set<String> subTypes = new HashSet<>();
        subTypes.add(SubscribeType.SNAPSHOT.name());

        try (QuotesSubsClient client = QuotesSubsClient.builder()
                .appKey(Env.APP_KEY)
                .appSecret(Env.APP_SECRET)
                .regionId(Region.us.name())
                .onMessage(QuotesSubscribe::handleMarketData)
                .addSubscription(symbols, Category.US_STOCK.name(), subTypes)
                .build()) {
            client.connectBlocking();
            client.subscribeBlocking();
        } catch (Exception ex) {
            logger.error("Subscribe market data error", ex);
        }
    }

    private static void handleMarketData(MarketData marketData) {
        logger.info("Received market data: {}", JsonSerializer.toJson(marketData));
    }
}

反馈与沟通

可通过Webull API服务邮箱联系到我们工作人员，邮箱地址是：api@webull-us.com