数据对象

对象列表

本部分包含部分重要的通用对象的补充解释,包含的对象列表如下:

客户端

对象基本功能
TigerHttpClientHttp客户端,负责发送交易类和行情类请求
WebSocketClientWebsocket客户端,负责处理订阅请求

常用对象

常量
引用路径 com.tigerbrokers.stock.openapi.client.constant source

名称描述
MethodNameAPI请求方法
OrderChangeKey订单推送字段
PositionChangeKey持仓推送字段
AssetChangeKey资产推送字段

HTTP请求相关对象
引用路径 com.tigerbrokers.stock.openapi.client.https source

名称描述
client.TigerHttpClienthttp请求客户端
domain返回的业务数据对象
request封装的请求对象
response封装的返回对象

长连接相关
引用路径 com.tigerbrokers.stock.openapi.client.socket source

名称描述
ApiComposeCallback回调接口类
WebSocketClient长连接客户端

枚举,数据结构
引用路径 com.tigerbrokers.stock.openapi.client.struct source

工具类
引用路径 com.tigerbrokers.stock.openapi.client.util source


TigerHttpClient HTTP客户端

com.tigerbrokers.stock.openapi.client.https.client.TigerHttpClient

初始化方法:

  1. 构造含有个人账户及密钥的用户配置对象ClientConfig
public class TigerOpenClientConfig {
  static {
    ClientConfig clientConfig = ClientConfig.DEFAULT_CONFIG;
    clientConfig.tigerId = "your tiger id";
    clientConfig.defaultAccount = "your account";
    clientConfig.privateKey = "you private key string";
    // clientConfig.secretKey = "xxxxxx";
    // clientConfig.setEnv(Env.SANDBOX);
  }
  public static ClientConfig getDefaultClientConfig() {
    return ClientConfig.DEFAULT_CONFIG;
  }
}
  1. 使用com.tigerbrokers.stock.openapi.client.config.ClientConfig初始化HttpClient
private static TigerHttpClient client = TigerHttpClient.getInstance().clientConfig(TigerOpenClientConfig.getDefaultClientConfig());

WebSocketClient Websocket客户端

com.tigerbrokers.stock.openapi.client.socket.WebSocketClient

初始化方法:

  1. 构造认证类

使用com.tigerbrokers.stock.openapi.client.config.ClientConfig构造认证类com.tigerbrokers.stock.openapi.client.socket.ApiAuthentication,并在初始化WebSocketClient时传入,用于身份验证

示例如下:

ClientConfig clientConfig = TigerOpenClientConfig.getDefaultClientConfig(); 
ApiAuthentication authentication = ApiAuthentication.build(clientConfig.tigerId, clientConfig.privateKey);
  1. 构造Websocket客户端
private static ClientConfig clientConfig = TigerOpenClientConfig.getDefaultClientConfig();
private static WebSocketClient client =
    WebSocketClient.getInstance().clientConfig(clientConfig).apiComposeCallback(new DefaultApiComposeCallback());