# 照会ポジション
- Python
- Proto
- C#
- Java
- C++
- JavaScript
position_list_query(code='', position_market=TrdMarket.NONE, pl_ratio_min=None, pl_ratio_max=None, trd_env=TrdEnv.REAL, acc_id=0, acc_index=0, refresh_cache=False, asset_category=AssetCategory.NONE)
概要
取引口座のポジションリストを照会します
パラメータ
パラメータ 型 説明 code str 銘柄コードフィルタ - このコードに対応するポジションデータのみを返します。未指定の場合はすべて返します
- 注意:先物ポジションのコードフィルタには、具体的な限月を含む限月コードを指定する必要があります。つなぎ足コードではフィルタできません
position_market TrdMarket ポジション所属市場フィルタ - 指定市場のポジションデータを返します
- デフォルトの場合、すべての市場のポジションデータを返します
pl_ratio_min float 現在の損益率下限フィルタ。この比率を超えるポジションのみ返します 証券口座は希薄化取得原価の損益率、先物口座は平均取得原価の損益率を使用します
例:10 を指定すると、損益率が +10% を超えるポジションを返しますpl_ratio_max float 現在の損益率上限フィルタ。この比率を下回るポジションを返します 証券口座は希薄化取得原価の損益率、先物口座は平均取得原価の損益率を使用します
例:10 を指定すると、損益率が +10% 未満のポジションを返しますtrd_env TrdEnv 取引環境 acc_id int 取引口座 ID - acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します。
- acc_id に 0 を指定した場合、acc_index で指定した口座が使用されます
- acc_id に ID 番号を指定した場合(0 以外)、acc_id で指定した口座が使用されます
acc_index int 取引口座リスト内の口座インデックス - acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します。acc_index は口座の新規開設や解約時に変動するため、指定した口座と実際の取引口座が一致しなくなる可能性があります。
- acc_index のデフォルトは 0 で、最初の取引口座を指定します
refresh_cache bool キャッシュを更新するかどうか - True:moomoo サーバーに即座にデータを再リクエストし、OpenD のキャッシュを使用しません。この場合、APIレート制限の対象となります
- False:OpenD のキャッシュを使用します(特殊な状況でキャッシュが適時に更新されない場合にのみ更新が必要です)
asset_category AssetCategory 資産類别 のみ対日本証券会社生效
戻り値
パラメータ 型 説明 ret RET_CODE API呼び出し結果 data pd.DataFrame 当 ret == RET_OK 时,返すポジションリスト str 当 ret != RET_OK 时,返すエラー説明 - ポジションリスト
フィールド タイプ 説明 position_side PositionSide ポジション方向 code str 銘柄コード stock_name str 銘柄名 position_market TrdMarket ポジション所属市場 qty float 保有数量 オプションと先物の単位は「枚」ですcan_sell_qty float 売却可能数量 売却可能数量とは、保有しているうち決済可能な数量です。
売却可能数量 = 保有数量 - 凍結数量
オプションと先物の単位は「枚」です。currency Currency 取引通貨 nominal_price float 市価 小数点以下3桁、超過分は四捨五入されますcost_price float 希薄化取得原価(証券口座)、平均建値(先物口座) ポジションの取得原価を取得するには average_cost、diluted_cost フィールドの使用を推奨しますcost_price_valid bool 成本価是否有効 True:有効
False:無効average_cost float 平均成本価 デモ証券口座不適用
最低OpenDバージョン要件:9.2.5208diluted_cost float 摊薄成本価 先物口座不適用
最低OpenDバージョン要件:9.2.5208market_val float 時価 精度:3 位小数(A株 2 位小数,先物 0 位小数)pl_ratio float 損益率(希薄化取得原価モード) 先物には適用されません
このフィールドはパーセント値で、デフォルトでは % を表示しません。例: 20 は実際には 20% に対応pl_ratio_valid bool 損益比例是否有効 True:有効
False:無効pl_ratio_avg_cost float 損益率(平均取得原価モード) デモ証券口座には適用されません
このフィールドはパーセント値で、デフォルトでは % を表示しません。例: 20 は実際には 20% に対応
最低 OpenD バージョン要件:9.2.5208pl_val float 損益金额 精度:3 位小数(A株 2 位小数)pl_val_valid bool 損益金额是否有効 True:有効
False:無効today_pl_val float 今日損益金额 只在本番取引環境下有効
精度:3 位小数(A株 2 位小数,先物 2 位小数)today_trd_val float 今日取引金额 只在本番取引環境下有効
精度:3 位小数(A株 2 位小数)
先物不適用today_buy_qty float 今日買い総数量 只在本番取引環境下有効
精度:3 位小数(A株 2 位小数)
先物不適用today_buy_val float 今日買い総額 只在本番取引環境下有効
精度:3 位小数(A株 2 位小数)
先物不適用today_sell_qty float 今日売り総数量 只在本番取引環境下有効
精度:3 位小数(A株 2 位小数)
先物不適用today_sell_val float 今日売り総額 只在本番取引環境下有効
精度:3 位小数(A株 2 位小数)
先物不適用unrealized_pl float 未実現損益 デモ証券口座には適用されません
総合証券口座では、平均取得原価モードでの未実現損益金額を返しますrealized_pl float 実現損益 デモ証券口座には適用されません
総合証券口座では、平均取得原価モードでの実現損益金額を返しますposition_id int ポジションID
- ポジションリスト
Example
from futu import *
trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.HK, host='127.0.0.1', port=11111, security_firm=SecurityFirm.FUTUSECURITIES)
ret, data = trd_ctx.position_list_query()
if ret == RET_OK:
print(data)
if data.shape[0] > 0: # ポジションリストが空でない場合
print(data['stock_name'][0]) # ポジションの最初の銘柄名を取得
print(data['stock_name'].values.tolist()) # list に変換
else:
print('position_list_query error: ', data)
trd_ctx.close() # この接続をクローズ
2
3
4
5
6
7
8
9
10
11
- Output
code stock_name position_market qty can_sell_qty cost_price cost_price_valid average_cost diluted_cost market_val nominal_price pl_ratio pl_ratio_valid pl_ratio_avg_cost pl_val pl_val_valid today_buy_qty today_buy_val today_pl_val today_trd_val today_sell_qty today_sell_val position_side unrealized_pl realized_pl currency asset_category position_id
0 HK.01810 小米集团-W HK 400.0 400.0 53.975 True 53.975 53.975 19820.0 49.55 -8.19824 True -8.19824 -1770.0 True 0.0 0.0 0.0 0.0 0.0 0.0 LONG 0.0 0.0 HKD N/A 6596101776329286054
小米集团-W
['小米集团-W']
2
3
4
# Trd_GetPositionList.proto
概要
取引口座のポジションリストを照会します
パラメータ
message C2S
{
required Trd_Common.TrdHeader header = 1; //取引共通パラメータヘッダー
optional Trd_Common.TrdFilterConditions filterConditions = 2; //フィルタ条件
optional double filterPLRatioMin = 3; //損益率の下限フィルタ。この比率を超えるものを返す。証券口座は希薄化取得原価の損益率、先物口座は平均取得原価の損益率を使用
optional double filterPLRatioMax = 4; //損益率の上限フィルタ。この比率を下回るものを返す。証券口座は希薄化取得原価の損益率、先物口座は平均取得原価の損益率を使用
optional bool refreshCache = 5; //OpenDのキャッシュデータを即座に更新。デフォルトは未入力。true の場合はサーバーから最新データを取得してキャッシュを更新し返却。false または未入力の場合はOpenDのキャッシュデータを返却し、サーバーへのリクエストは行いません。
//通常、サーバー側で更新があれば直ちにOpenDへプッシュされ、OpenDがデータをキャッシュします。APIリクエスト時にはキャッシュデータを同期的に返すため、通常はキャッシュの更新指定は不要です。高速なレスポンスの確保とサーバー負荷の軽減のため
//パケットロスなどが発生した場合、キャッシュデータとサーバーが不一致になることがあります。データ更新に異常がある場合は、キャッシュの更新を指定してデータ同期の問題を解決できます。
optional int32 assetCategory = 6; //口座資産タイプ。日本デリバティブ口座は必須。Trd_Common.TrdAssetCategory を参照
}
message Request
{
required C2S c2s = 1;
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
- 取引共通パラメータヘッダー構造体を参照 TrdHeader
- フィルタ条件構造体を参照 TrdFilterConditions
- 口座資産タイプ構造体を参照 TrdAssetCategory
- 戻り値
message S2C
{
required Trd_Common.TrdHeader header = 1; //取引共通パラメータヘッダー
repeated Trd_Common.Position positionList = 2; //ポジションリスト
}
message Response
{
//以下の3つのフィールドは各プロトコルに共通。コメント説明は InitConnect.proto を参照
required int32 retType = 1 [default = -400];
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
プロトコル ID
2102
uint GetPositionList(TrdGetPositionList.Request req);
virtual void OnReply_GetPositionList(FTAPI_Conn client, uint nSerialNo, TrdGetPositionList.Response rsp);
概要
取引口座のポジションリストを照会します
パラメータ
message C2S
{
required Trd_Common.TrdHeader header = 1; //取引共通パラメータヘッダー
optional Trd_Common.TrdFilterConditions filterConditions = 2; //フィルタ条件
optional double filterPLRatioMin = 3; //損益率の下限フィルタ。この比率を超えるものを返す。証券口座は希薄化取得原価の損益率、先物口座は平均取得原価の損益率を使用
optional double filterPLRatioMax = 4; //損益率の上限フィルタ。この比率を下回るものを返す。証券口座は希薄化取得原価の損益率、先物口座は平均取得原価の損益率を使用
optional bool refreshCache = 5; //OpenDのキャッシュデータを即座に更新。デフォルトは未入力。true の場合はサーバーから最新データを取得してキャッシュを更新し返却。false または未入力の場合はOpenDのキャッシュデータを返却し、サーバーへのリクエストは行いません。
//通常、サーバー側で更新があれば直ちにOpenDへプッシュされ、OpenDがデータをキャッシュします。APIリクエスト時にはキャッシュデータを同期的に返すため、通常はキャッシュの更新指定は不要です。高速なレスポンスの確保とサーバー負荷の軽減のため
//パケットロスなどが発生した場合、キャッシュデータとサーバーが不一致になることがあります。データ更新に異常がある場合は、キャッシュの更新を指定してデータ同期の問題を解決できます。
optional int32 assetCategory = 6; //口座資産タイプ。日本デリバティブ口座は必須。Trd_Common.TrdAssetCategory を参照
}
message Request
{
required C2S c2s = 1;
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
- 取引共通パラメータヘッダー構造体を参照 TrdHeader
- フィルタ条件構造体を参照 TrdFilterConditions
- 口座資産タイプ構造体を参照 TrdAssetCategory
- コールバック
message S2C
{
required Trd_Common.TrdHeader header = 1; //取引共通パラメータヘッダー
repeated Trd_Common.Position positionList = 2; //ポジションリスト
}
message Response
{
//以下の3つのフィールドは各プロトコルに共通。コメント説明は InitConnect.proto を参照
required int32 retType = 1 [default = -400];
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
- Example
public class Program: FTSPI_Trd, FTSPI_Conn {
FTAPI_Trd trd = new FTAPI_Trd();
public Program() {
trd.SetClientInfo("csharp", 1); //クライアント情報の設定
trd.SetConnCallback(this); //接続コールバックの設定
trd.SetTrdCallback(this); //取引コールバックの設定
}
public void Start() {
trd.InitConnect("127.0.0.1", (ushort)11111, false);
}
public void OnInitConnect(FTAPI_Conn client, long errCode, String desc)
{
Console.Write("Trd onInitConnect: ret={0} desc={1} connID={2}\n", errCode, desc, client.GetConnectID());
if (errCode != 0)
return;
TrdCommon.TrdHeader header = TrdCommon.TrdHeader.CreateBuilder()
.SetAccID(281756457888247915L)
.SetTrdEnv((int)TrdCommon.TrdEnv.TrdEnv_Real)
.SetTrdMarket((int)TrdCommon.TrdMarket.TrdMarket_HK)
.Build();
TrdGetPositionList.C2S c2s = TrdGetPositionList.C2S.CreateBuilder()
.SetHeader(header)
.Build();
TrdGetPositionList.Request req = TrdGetPositionList.Request.CreateBuilder().SetC2S(c2s).Build();
uint seqNo = trd.GetPositionList(req);
Console.Write("Send TrdGetPositionList: {0}\n", seqNo);
}
public void OnDisconnect(FTAPI_Conn client, long errCode) {
Console.Write("Trd onDisConnect: {0}\n", errCode);
}
public void OnReply_GetPositionList(FTAPI_Conn client, uint nSerialNo, TrdGetPositionList.Response rsp)
{
Console.Write("Reply: TrdGetPositionList: {0}\n", nSerialNo);
Console.Write("accID: {0}\n", rsp.S2C.Header.AccID);
}
public static void Main(String[] args) {
FTAPI.Init();
Program trd = new Program();
trd.Start();
while (true)
Thread.Sleep(1000 * 600);
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
- Output
Trd onInitConnect: ret=0 desc= connID=6826813359715968249
Send TrdGetPositionList: 3
Reply: TrdGetPositionList: 3
accID: 281756457888247915
2
3
4
int getPositionList(TrdGetPositionList.Request req);
void onReply_GetPositionList(FTAPI_Conn client, int nSerialNo, TrdGetPositionList.Response rsp);
概要
取引口座のポジションリストを照会します
パラメータ
message C2S
{
required Trd_Common.TrdHeader header = 1; //取引共通パラメータヘッダー
optional Trd_Common.TrdFilterConditions filterConditions = 2; //フィルタ条件
optional double filterPLRatioMin = 3; //損益率の下限フィルタ。この比率を超えるものを返す。証券口座は希薄化取得原価の損益率、先物口座は平均取得原価の損益率を使用
optional double filterPLRatioMax = 4; //損益率の上限フィルタ。この比率を下回るものを返す。証券口座は希薄化取得原価の損益率、先物口座は平均取得原価の損益率を使用
optional bool refreshCache = 5; //OpenDのキャッシュデータを即座に更新。デフォルトは未入力。true の場合はサーバーから最新データを取得してキャッシュを更新し返却。false または未入力の場合はOpenDのキャッシュデータを返却し、サーバーへのリクエストは行いません。
//通常、サーバー側で更新があれば直ちにOpenDへプッシュされ、OpenDがデータをキャッシュします。APIリクエスト時にはキャッシュデータを同期的に返すため、通常はキャッシュの更新指定は不要です。高速なレスポンスの確保とサーバー負荷の軽減のため
//パケットロスなどが発生した場合、キャッシュデータとサーバーが不一致になることがあります。データ更新に異常がある場合は、キャッシュの更新を指定してデータ同期の問題を解決できます。
optional int32 assetCategory = 6; //口座資産タイプ。日本デリバティブ口座は必須。Trd_Common.TrdAssetCategory を参照
}
message Request
{
required C2S c2s = 1;
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
- 取引共通パラメータヘッダー構造体を参照 TrdHeader
- フィルタ条件構造体を参照 TrdFilterConditions
- 口座資産タイプ構造体を参照 TrdAssetCategory
- コールバック
message S2C
{
required Trd_Common.TrdHeader header = 1; //取引共通パラメータヘッダー
repeated Trd_Common.Position positionList = 2; //ポジションリスト
}
message Response
{
//以下の3つのフィールドは各プロトコルに共通。コメント説明は InitConnect.proto を参照
required int32 retType = 1 [default = -400];
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
- Example
public class TrdDemo implements FTSPI_Trd, FTSPI_Conn {
FTAPI_Conn_Trd trd = new FTAPI_Conn_Trd();
public TrdDemo() {
trd.setClientInfo("javaclient", 1); //クライアント情報の設定
trd.setConnSpi(this); //接続コールバックの設定
trd.setTrdSpi(this); //取引コールバックの設定
}
public void start() {
trd.initConnect("127.0.0.1", (short)11111, false);
}
@Override
public void onInitConnect(FTAPI_Conn client, long errCode, String desc)
{
System.out.printf("Trd onInitConnect: ret=%b desc=%s connID=%d\n", errCode, desc, client.getConnectID());
if (errCode != 0)
return;
TrdCommon.TrdHeader header = TrdCommon.TrdHeader.newBuilder()
.setAccID(281756457888247915L)
.setTrdEnv(TrdCommon.TrdEnv.TrdEnv_Real_VALUE)
.setTrdMarket(TrdCommon.TrdMarket.TrdMarket_HK_VALUE)
.build();
TrdGetPositionList.C2S c2s = TrdGetPositionList.C2S.newBuilder()
.setHeader(header)
.build();
TrdGetPositionList.Request req = TrdGetPositionList.Request.newBuilder().setC2S(c2s).build();
int seqNo = trd.getPositionList(req);
System.out.printf("Send TrdGetPositionList: %d\n", seqNo);
}
@Override
public void onDisconnect(FTAPI_Conn client, long errCode) {
System.out.printf("Trd onDisConnect: %d\n", errCode);
}
@Override
public void onReply_GetPositionList(FTAPI_Conn client, int nSerialNo, TrdGetPositionList.Response rsp) {
if (rsp.getRetType() != 0) {
System.out.printf("TrdGetPositionList failed: %s\n", rsp.getRetMsg());
}
else {
try {
String json = JsonFormat.printer().print(rsp);
System.out.printf("Receive TrdGetPositionList: %s\n", json);
} catch (InvalidProtocolBufferException e) {
e.printStackTrace();
}
}
}
public static void main(String[] args) {
FTAPI.init();
TrdDemo trd = new TrdDemo();
trd.start();
while (true) {
try {
Thread.sleep(1000 * 600);
} catch (InterruptedException exc) {
}
}
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
- Output
Send TrdGetPositionList: 2
Receive TrdGetPositionList: {
"retType": 0,
"retMsg": "",
"errCode": 0,
"s2c": {
"header": {
"trdEnv": 0,
"accID": "281756457888247915",
"trdMarket": 1
},
"positionList": [{
"positionID": "804953599703017051",
"positionSide": 0,
"code": "00700",
"name": "腾讯控股",
"qty": 100.0,
"canSellQty": 100.0,
"price": 594.0,
"costPrice": 594.0,
"val": 59400.0,
"plVal": 0.0,
"plRatio": 0.0,
"secMarket": 1,
"dilutedCostPrice": 594.0,
"averageCostPrice": 594.0,
"averagePlRatio": 0.0
}]
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
Futu::u32_t GetPositionList(const Trd_GetPositionList::Request &stReq);
virtual void OnReply_GetPositionList(Futu::u32_t nSerialNo, const Trd_GetPositionList::Response &stRsp) = 0;
概要
取引口座のポジションリストを照会します
パラメータ
message C2S
{
required Trd_Common.TrdHeader header = 1; //取引共通パラメータヘッダー
optional Trd_Common.TrdFilterConditions filterConditions = 2; //フィルタ条件
optional double filterPLRatioMin = 3; //損益率の下限フィルタ。この比率を超えるものを返す。証券口座は希薄化取得原価の損益率、先物口座は平均取得原価の損益率を使用
optional double filterPLRatioMax = 4; //損益率の上限フィルタ。この比率を下回るものを返す。証券口座は希薄化取得原価の損益率、先物口座は平均取得原価の損益率を使用
optional bool refreshCache = 5; //OpenDのキャッシュデータを即座に更新。デフォルトは未入力。true の場合はサーバーから最新データを取得してキャッシュを更新し返却。false または未入力の場合はOpenDのキャッシュデータを返却し、サーバーへのリクエストは行いません。
//通常、サーバー側で更新があれば直ちにOpenDへプッシュされ、OpenDがデータをキャッシュします。APIリクエスト時にはキャッシュデータを同期的に返すため、通常はキャッシュの更新指定は不要です。高速なレスポンスの確保とサーバー負荷の軽減のため
//パケットロスなどが発生した場合、キャッシュデータとサーバーが不一致になることがあります。データ更新に異常がある場合は、キャッシュの更新を指定してデータ同期の問題を解決できます。
optional int32 assetCategory = 6; //口座資産タイプ。日本デリバティブ口座は必須。Trd_Common.TrdAssetCategory を参照
}
message Request
{
required C2S c2s = 1;
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
- 取引共通パラメータヘッダー構造体を参照 TrdHeader
- フィルタ条件構造体を参照 TrdFilterConditions
- 口座資産タイプ構造体を参照 TrdAssetCategory
- コールバック
message S2C
{
required Trd_Common.TrdHeader header = 1; //取引共通パラメータヘッダー
repeated Trd_Common.Position positionList = 2; //ポジションリスト
}
message Response
{
//以下の3つのフィールドは各プロトコルに共通。コメント説明は InitConnect.proto を参照
required int32 retType = 1 [default = -400];
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
- Example
class Program : public FTSPI_Qot, public FTSPI_Trd, public FTSPI_Conn
{
public:
Program() {
m_pTrdApi = FTAPI::CreateTrdApi();
m_pTrdApi->RegisterTrdSpi(this);
m_pTrdApi->RegisterConnSpi(this);
}
~Program() {
if (m_pTrdApi != nullptr)
{
m_pTrdApi->UnregisterTrdSpi();
m_pTrdApi->UnregisterConnSpi();
FTAPI::ReleaseTrdApi(m_pTrdApi);
m_pTrdApi = nullptr;
}
}
void Start() {
m_pTrdApi->InitConnect("127.0.0.1", 11111, false);
}
virtual void OnInitConnect(FTAPI_Conn* pConn, Futu::i64_t nErrCode, const char* strDesc) {
cout << "connect" << endl;
// パケット生成
Trd_GetPositionList::Request req;
Trd_GetPositionList::C2S *c2s = req.mutable_c2s();
Trd_Common::TrdHeader *header = c2s->mutable_header();
header->set_accid(3637840);
header->set_trdenv(0);
header->set_trdmarket(1);
m_GetPositionListSerialNo = m_pTrdApi->GetPositionList(req);
cout << "Request GetPositionList SerialNo: " << m_GetPositionListSerialNo << endl;
}
virtual void OnReply_GetPositionList(Futu::u32_t nSerialNo, const Trd_GetPositionList::Response &stRsp){
if(nSerialNo == m_GetPositionListSerialNo)
{
cout << "OnReply_GetPositionList SerialNo: " << nSerialNo << endl;
// 内部構造を解析して出力
// ProtoBufToBodyData と UTF8ToLocal 関数の定義は Sample の tool.h ファイルを参照
string resp_str;
ProtoBufToBodyData(stRsp, resp_str);
cout << UTF8ToLocal(resp_str) << endl;
}
}
protected:
FTAPI_Trd *m_pTrdApi;
Futu::u32_t m_GetPositionListSerialNo;
};
int32_t main(int32_t argc, char** argv)
{
FTAPI::Init();
{
Program program;
program.Start();
getchar();
}
protobuf::ShutdownProtobufLibrary();
FTAPI::UnInit();
return 0;
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
- Output
connect
Request GetPositionList SerialNo: 4
OnReply_GetPositionList SerialNo: 4
{
"retType": 0,
"retMsg": "",
"errCode": 0,
"s2c": {
"header": {
"trdEnv": 0,
"accID": "3637840",
"trdMarket": 1
},
"positionList": [
{
"positionID": "806833430706896474",
"positionSide": 0,
"code": "00700",
"name": "腾讯控股",
"qty": 300,
"canSellQty": 300,
"price": 604.5,
"costPrice": 611.5,
"val": 181350,
"plVal": -2100,
"plRatio": -0.011447260834015,
"secMarket": 1,
"dilutedCostPrice": 611.5,
"averageCostPrice": 611.5,
"averagePlRatio": -0.011447260834015
}
]
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
GetPositionList(req);
概要
取引口座のポジションリストを照会します
パラメータ
message C2S
{
required Trd_Common.TrdHeader header = 1; //取引共通パラメータヘッダー
optional Trd_Common.TrdFilterConditions filterConditions = 2; //フィルタ条件
optional double filterPLRatioMin = 3; //損益率の下限フィルタ。この比率を超えるものを返す。証券口座は希薄化取得原価の損益率、先物口座は平均取得原価の損益率を使用
optional double filterPLRatioMax = 4; //損益率の上限フィルタ。この比率を下回るものを返す。証券口座は希薄化取得原価の損益率、先物口座は平均取得原価の損益率を使用
optional bool refreshCache = 5; //OpenDのキャッシュデータを即座に更新。デフォルトは未入力。true の場合はサーバーから最新データを取得してキャッシュを更新し返却。false または未入力の場合はOpenDのキャッシュデータを返却し、サーバーへのリクエストは行いません。
//通常、サーバー側で更新があれば直ちにOpenDへプッシュされ、OpenDがデータをキャッシュします。APIリクエスト時にはキャッシュデータを同期的に返すため、通常はキャッシュの更新指定は不要です。高速なレスポンスの確保とサーバー負荷の軽減のため
//パケットロスなどが発生した場合、キャッシュデータとサーバーが不一致になることがあります。データ更新に異常がある場合は、キャッシュの更新を指定してデータ同期の問題を解決できます。
optional int32 assetCategory = 6; //口座資産タイプ。日本デリバティブ口座は必須。Trd_Common.TrdAssetCategory を参照
}
message Request
{
required C2S c2s = 1;
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
- 取引共通パラメータヘッダー構造体を参照 TrdHeader
- フィルタ条件構造体を参照 TrdFilterConditions
- 口座資産タイプ構造体を参照 TrdAssetCategory
- 戻り値
message S2C
{
required Trd_Common.TrdHeader header = 1; //取引共通パラメータヘッダー
repeated Trd_Common.Position positionList = 2; //ポジションリスト
}
message Response
{
//以下の3つのフィールドは各プロトコルに共通。コメント説明は InitConnect.proto を参照
required int32 retType = 1 [default = -400];
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
- Example
import ftWebsocket from "futu-api";
import { ftCmdID } from "futu-api";
import { Common, Qot_Common, Trd_Common } from "futu-api/proto";
import beautify from "js-beautify";
function TrdGetPositionList(){
const { RetType } = Common
const { TrdEnv, TrdMarket } = Trd_Common
let [addr, port, enable_ssl, key] = ["127.0.0.1", 33333, false, 'ced92e472b40c92a'];
let websocket = new ftWebsocket();
websocket.onlogin = (ret, msg)=>{
if (ret) { // ログイン成功
websocket.GetAccList({
c2s: {
userID: 0,
},
}).then((res) => {
let { retType,s2c: { accList } } = res
if(retType == RetType.RetType_Succeed){
let acc = accList.filter((item)=>{
return item.trdEnv == TrdEnv.TrdEnv_Simulate && item.trdMarketAuthList.some((auth)=>{ return auth == TrdMarket.TrdMarket_HK})
})[0]; // サンプルは香港市場デモ環境の最初の口座を取得
const req = {
c2s: {
header: {
trdEnv: acc.trdEnv,
accID: acc.accID,
trdMarket: TrdMarket.TrdMarket_HK,
},
},
};
websocket.GetPositionList(req)
.then((res) => {
let { errCode, retMsg, retType,s2c } = res
console.log("GetPositionList: errCode %d, retMsg %s, retType %d", errCode, retMsg, retType);
if(retType == RetType.RetType_Succeed){
let data = beautify(JSON.stringify(s2c), {
indent_size: 2,
space_in_empty_paren: true,
});
console.log(data);
}
})
.catch((error) => {
console.log("error:", error);
});
}
})
.catch((error) => {
console.log("GetAccList error:", error);
});
} else {
console.log("error", msg);
}
};
websocket.start(addr, port, enable_ssl, key);
//相場接続をクローズ。使用後は接続をクローズしてください。不要なリソース占有を防ぎます
//OpenD は最大 128 接続に制限されています
//1 ページまたは 1 プロジェクトで 1 接続を維持することも可能。ここではサンプルとしてリクエストごとに 1 接続を作成
setTimeout(()=>{
websocket.stop();
console.log("stop");
}, 5000); // 5 秒後に切断
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
- Output
GetPositionList: errCode 0, retMsg , retType 0
{
"header": {
"trdEnv": 0,
"accID": "6684972",
"trdMarket": 1
},
"positionList": [{
"positionID": "3411713033831199757",
"positionSide": 0,
"code": "00700",
"name": "腾讯控股",
"qty": 1900,
"canSellQty": 1900,
"price": 479.8,
"costPrice": 454.558,
"val": 911620,
"plVal": 47960,
"plRatio": 0.05553111178009899,
"secMarket": 1,
"dilutedCostPrice": 454.558,
"averageCostPrice": 454.558,
"averagePlRatio": 0.05553111178009899
}]
}
stop
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
APIレート制限
- 同一口座ID(acc_id) 每 30 秒内最多リクエスト 10 次照会ポジションAPI
- このAPIの呼び出しは、キャッシュを更新する場合のみレート制限の対象となります
- Python
- Proto
- C#
- Java
- C++
- JavaScript
position_list_query(code='', position_market=TrdMarket.NONE, pl_ratio_min=None, pl_ratio_max=None, trd_env=TrdEnv.REAL, acc_id=0, acc_index=0, refresh_cache=False, asset_category=AssetCategory.NONE)
概要
取引口座のポジションリストを照会します
パラメータ
パラメータ 型 説明 code str 銘柄コードフィルタ - このコードに対応するポジションデータのみを返します。未指定の場合はすべて返します
- 注意:先物ポジションのコードフィルタには、具体的な限月を含む限月コードを指定する必要があります。つなぎ足コードではフィルタできません
position_market TrdMarket ポジション所属市場フィルタ - 指定市場のポジションデータを返します
- デフォルトの場合、すべての市場のポジションデータを返します
pl_ratio_min float 現在の損益率下限フィルタ。この比率を超えるポジションのみ返します 証券口座は希薄化取得原価の損益率、先物口座は平均取得原価の損益率を使用します
例:10 を指定すると、損益率が +10% を超えるポジションを返しますpl_ratio_max float 現在の損益率上限フィルタ。この比率を下回るポジションを返します 証券口座は希薄化取得原価の損益率、先物口座は平均取得原価の損益率を使用します
例:20 を指定すると、損益率が +20% 未満のポジションを返しますtrd_env TrdEnv 取引環境 acc_id int 取引口座 ID - acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します。
- acc_id に 0 を指定した場合、acc_index で指定した口座が使用されます
- acc_id に ID 番号を指定した場合(0 以外)、acc_id で指定した口座が使用されます
acc_index int 取引口座リスト内の口座インデックス - acc_id と acc_index はどちらも取引口座の指定に使用でき、いずれか一方を選択してください。acc_id の使用を推奨します。acc_index は口座の新規開設や解約時に変動するため、指定した口座と実際の取引口座が一致しなくなる可能性があります。
- acc_index のデフォルトは 0 で、最初の取引口座を指定します
refresh_cache bool キャッシュを更新するかどうか - True:moomoo サーバーに即座にデータを再リクエストし、OpenD のキャッシュを使用しません。この場合、APIレート制限の対象となります
- False:OpenD のキャッシュを使用します(特殊な状況でキャッシュが適時に更新されない場合にのみ更新が必要です)
asset_category AssetCategory 資産類别 のみ対日本証券会社生效
戻り値
パラメータ 型 説明 ret RET_CODE API呼び出し結果 data pd.DataFrame 当 ret == RET_OK 时,返すポジションリスト str 当 ret != RET_OK 时,返すエラー説明 - ポジションリスト
フィールド タイプ 説明 position_side PositionSide ポジション方向 code str 銘柄コード stock_name str 銘柄名 position_market TrdMarket ポジション所属市場 qty float 保有数量 オプションと先物の単位は「枚」ですcan_sell_qty float 売却可能数量 売却可能数量とは、保有しているうち決済可能な数量です。
売却可能数量 = 保有数量 - 凍結数量
オプションと先物の単位は「枚」です。currency Currency 取引通貨 nominal_price float 市価 小数点以下3桁、超過分は四捨五入されますcost_price float 希薄化取得原価(証券口座)、平均建値(先物口座) ポジションの取得原価を取得するには average_cost、diluted_cost フィールドの使用を推奨しますcost_price_valid bool 成本価是否有効 True:有効
False:無効average_cost float 平均成本価 デモ証券口座不適用
最低OpenDバージョン要件:9.2.5208diluted_cost float 摊薄成本価 先物口座不適用
最低OpenDバージョン要件:9.2.5208market_val float 時価 精度:3 位小数(A株 2 位小数,先物 0 位小数)pl_ratio float 損益率(希薄化取得原価モード) 先物には適用されません
このフィールドはパーセント値で、デフォルトでは % を表示しません。例: 20 は実際には 20% に対応pl_ratio_valid bool 損益比例是否有効 True:有効
False:無効pl_ratio_avg_cost float 損益率(平均取得原価モード) デモ証券口座には適用されません
このフィールドはパーセント値で、デフォルトでは % を表示しません。例: 20 は実際には 20% に対応
最低 OpenD バージョン要件:9.2.5208pl_val float 損益金额 精度:3 位小数(A株 2 位小数)pl_val_valid bool 損益金额是否有効 True:有効
False:無効today_pl_val float 今日損益金额 只在本番取引環境下有効
精度:3 位小数(A株 2 位小数,先物 2 位小数)today_trd_val float 今日取引金额 只在本番取引環境下有効
精度:3 位小数(A株 2 位小数)
先物不適用today_buy_qty float 今日買い総数量 只在本番取引環境下有効
精度:3 位小数(A株 2 位小数)
先物不適用today_buy_val float 今日買い総額 只在本番取引環境下有効
精度:3 位小数(A株 2 位小数)
先物不適用today_sell_qty float 今日売り総数量 只在本番取引環境下有効
精度:3 位小数(A株 2 位小数)
先物不適用today_sell_val float 今日売り総額 只在本番取引環境下有効
精度:3 位小数(A株 2 位小数)
先物不適用unrealized_pl float 未実現損益 デモ証券口座には適用されません
総合証券口座では、平均取得原価モードでの未実現損益金額を返しますrealized_pl float 実現損益 デモ証券口座には適用されません
総合証券口座では、平均取得原価モードでの実現損益金額を返しますposition_id int ポジションID
- ポジションリスト
Example
from futu import *
trd_ctx = OpenSecTradeContext(filter_trdmarket=TrdMarket.US, host='127.0.0.1', port=11111, security_firm=SecurityFirm.FUTUINC)
ret, data = trd_ctx.position_list_query()
if ret == RET_OK:
print(data)
if data.shape[0] > 0: # ポジションリストが空でない場合
print(data['stock_name'][0]) # ポジションの最初の銘柄名を取得
print(data['stock_name'].values.tolist()) # list に変換
else:
print('position_list_query error: ', data)
trd_ctx.close() # この接続をクローズ
2
3
4
5
6
7
8
9
10
11
- Output
code stock_name position_market qty can_sell_qty cost_price cost_price_valid average_cost diluted_cost market_val nominal_price pl_ratio pl_ratio_valid pl_ratio_avg_cost pl_val pl_val_valid today_buy_qty today_buy_val today_pl_val today_trd_val today_sell_qty today_sell_val position_side unrealized_pl realized_pl currency asset_category position_id
0 US.AAPL 苹果 HK 400.0 400.0 53.975 True N/A 53.975 19720.0 49.3 -8.661417 True N/A -1870.0 True N/A N/A N/A N/A N/A N/A LONG N/A N/A HKD N/A 6596101776329286054
苹果
['苹果']
2
3
4
# Trd_GetPositionList.proto
概要
取引口座のポジションリストを照会します
パラメータ
message C2S
{
required Trd_Common.TrdHeader header = 1; //取引共通パラメータヘッダー
optional Trd_Common.TrdFilterConditions filterConditions = 2; //フィルタ条件
optional double filterPLRatioMin = 3; //損益率の下限フィルタ。この比率を超えるものを返す。証券口座は希薄化取得原価の損益率、先物口座は平均取得原価の損益率を使用
optional double filterPLRatioMax = 4; //損益率の上限フィルタ。この比率を下回るものを返す。証券口座は希薄化取得原価の損益率、先物口座は平均取得原価の損益率を使用
optional bool refreshCache = 5; //OpenDのキャッシュデータを即座に更新。デフォルトは未入力。true の場合はサーバーから最新データを取得してキャッシュを更新し返却。false または未入力の場合はOpenDのキャッシュデータを返却し、サーバーへのリクエストは行いません。
//通常、サーバー側で更新があれば直ちにOpenDへプッシュされ、OpenDがデータをキャッシュします。APIリクエスト時にはキャッシュデータを同期的に返すため、通常はキャッシュの更新指定は不要です。高速なレスポンスの確保とサーバー負荷の軽減のため
//パケットロスなどが発生した場合、キャッシュデータとサーバーが不一致になることがあります。データ更新に異常がある場合は、キャッシュの更新を指定してデータ同期の問題を解決できます。
optional int32 assetCategory = 6; //口座資産タイプ。日本デリバティブ口座は必須。Trd_Common.TrdAssetCategory を参照
}
message Request
{
required C2S c2s = 1;
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
- 取引共通パラメータヘッダー構造体を参照 TrdHeader
- フィルタ条件構造体を参照 TrdFilterConditions
- 口座資産タイプ構造体を参照 TrdAssetCategory
- 戻り値
message S2C
{
required Trd_Common.TrdHeader header = 1; //取引共通パラメータヘッダー
repeated Trd_Common.Position positionList = 2; //ポジションリスト
}
message Response
{
//以下の3つのフィールドは各プロトコルに共通。コメント説明は InitConnect.proto を参照
required int32 retType = 1 [default = -400];
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
プロトコル ID
2102
uint GetPositionList(TrdGetPositionList.Request req);
virtual void OnReply_GetPositionList(FTAPI_Conn client, uint nSerialNo, TrdGetPositionList.Response rsp);
概要
取引口座のポジションリストを照会します
パラメータ
message C2S
{
required Trd_Common.TrdHeader header = 1; //取引共通パラメータヘッダー
optional Trd_Common.TrdFilterConditions filterConditions = 2; //フィルタ条件
optional double filterPLRatioMin = 3; //損益率の下限フィルタ。この比率を超えるものを返す。証券口座は希薄化取得原価の損益率、先物口座は平均取得原価の損益率を使用
optional double filterPLRatioMax = 4; //損益率の上限フィルタ。この比率を下回るものを返す。証券口座は希薄化取得原価の損益率、先物口座は平均取得原価の損益率を使用
optional bool refreshCache = 5; //OpenDのキャッシュデータを即座に更新。デフォルトは未入力。true の場合はサーバーから最新データを取得してキャッシュを更新し返却。false または未入力の場合はOpenDのキャッシュデータを返却し、サーバーへのリクエストは行いません。
//通常、サーバー側で更新があれば直ちにOpenDへプッシュされ、OpenDがデータをキャッシュします。APIリクエスト時にはキャッシュデータを同期的に返すため、通常はキャッシュの更新指定は不要です。高速なレスポンスの確保とサーバー負荷の軽減のため
//パケットロスなどが発生した場合、キャッシュデータとサーバーが不一致になることがあります。データ更新に異常がある場合は、キャッシュの更新を指定してデータ同期の問題を解決できます。
optional int32 assetCategory = 6; //口座資産タイプ。日本デリバティブ口座は必須。Trd_Common.TrdAssetCategory を参照
}
message Request
{
required C2S c2s = 1;
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
- 取引共通パラメータヘッダー構造体を参照 TrdHeader
- フィルタ条件構造体を参照 TrdFilterConditions
- 口座資産タイプ構造体を参照 TrdAssetCategory
- コールバック
message S2C
{
required Trd_Common.TrdHeader header = 1; //取引共通パラメータヘッダー
repeated Trd_Common.Position positionList = 2; //ポジションリスト
}
message Response
{
//以下の3つのフィールドは各プロトコルに共通。コメント説明は InitConnect.proto を参照
required int32 retType = 1 [default = -400];
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
- Example
public class Program: FTSPI_Trd, FTSPI_Conn {
FTAPI_Trd trd = new FTAPI_Trd();
public Program() {
trd.SetClientInfo("csharp", 1); //クライアント情報の設定
trd.SetConnCallback(this); //接続コールバックの設定
trd.SetTrdCallback(this); //取引コールバックの設定
}
public void Start() {
trd.InitConnect("127.0.0.1", (ushort)11111, false);
}
public void OnInitConnect(FTAPI_Conn client, long errCode, String desc)
{
Console.Write("Trd onInitConnect: ret={0} desc={1} connID={2}\n", errCode, desc, client.GetConnectID());
if (errCode != 0)
return;
TrdCommon.TrdHeader header = TrdCommon.TrdHeader.CreateBuilder()
.SetAccID(281756457888247915L)
.SetTrdEnv((int)TrdCommon.TrdEnv.TrdEnv_Real)
.SetTrdMarket((int)TrdCommon.TrdMarket.TrdMarket_HK)
.Build();
TrdGetPositionList.C2S c2s = TrdGetPositionList.C2S.CreateBuilder()
.SetHeader(header)
.Build();
TrdGetPositionList.Request req = TrdGetPositionList.Request.CreateBuilder().SetC2S(c2s).Build();
uint seqNo = trd.GetPositionList(req);
Console.Write("Send TrdGetPositionList: {0}\n", seqNo);
}
public void OnDisconnect(FTAPI_Conn client, long errCode) {
Console.Write("Trd onDisConnect: {0}\n", errCode);
}
public void OnReply_GetPositionList(FTAPI_Conn client, uint nSerialNo, TrdGetPositionList.Response rsp)
{
Console.Write("Reply: TrdGetPositionList: {0}\n", nSerialNo);
Console.Write("accID: {0}\n", rsp.S2C.Header.AccID);
}
public static void Main(String[] args) {
FTAPI.Init();
Program trd = new Program();
trd.Start();
while (true)
Thread.Sleep(1000 * 600);
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
- Output
Trd onInitConnect: ret=0 desc= connID=6826813359715968249
Send TrdGetPositionList: 3
Reply: TrdGetPositionList: 3
accID: 281756457888247915
2
3
4
int getPositionList(TrdGetPositionList.Request req);
void onReply_GetPositionList(FTAPI_Conn client, int nSerialNo, TrdGetPositionList.Response rsp);
概要
取引口座のポジションリストを照会します
パラメータ
message C2S
{
required Trd_Common.TrdHeader header = 1; //取引共通パラメータヘッダー
optional Trd_Common.TrdFilterConditions filterConditions = 2; //フィルタ条件
optional double filterPLRatioMin = 3; //損益率の下限フィルタ。この比率を超えるものを返す。証券口座は希薄化取得原価の損益率、先物口座は平均取得原価の損益率を使用
optional double filterPLRatioMax = 4; //損益率の上限フィルタ。この比率を下回るものを返す。証券口座は希薄化取得原価の損益率、先物口座は平均取得原価の損益率を使用
optional bool refreshCache = 5; //OpenDのキャッシュデータを即座に更新。デフォルトは未入力。true の場合はサーバーから最新データを取得してキャッシュを更新し返却。false または未入力の場合はOpenDのキャッシュデータを返却し、サーバーへのリクエストは行いません。
//通常、サーバー側で更新があれば直ちにOpenDへプッシュされ、OpenDがデータをキャッシュします。APIリクエスト時にはキャッシュデータを同期的に返すため、通常はキャッシュの更新指定は不要です。高速なレスポンスの確保とサーバー負荷の軽減のため
//パケットロスなどが発生した場合、キャッシュデータとサーバーが不一致になることがあります。データ更新に異常がある場合は、キャッシュの更新を指定してデータ同期の問題を解決できます。
optional int32 assetCategory = 6; //口座資産タイプ。日本デリバティブ口座は必須。Trd_Common.TrdAssetCategory を参照
}
message Request
{
required C2S c2s = 1;
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
- 取引共通パラメータヘッダー構造体を参照 TrdHeader
- フィルタ条件構造体を参照 TrdFilterConditions
- 口座資産タイプ構造体を参照 TrdAssetCategory
- コールバック
message S2C
{
required Trd_Common.TrdHeader header = 1; //取引共通パラメータヘッダー
repeated Trd_Common.Position positionList = 2; //ポジションリスト
}
message Response
{
//以下の3つのフィールドは各プロトコルに共通。コメント説明は InitConnect.proto を参照
required int32 retType = 1 [default = -400];
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
- Example
public class TrdDemo implements FTSPI_Trd, FTSPI_Conn {
FTAPI_Conn_Trd trd = new FTAPI_Conn_Trd();
public TrdDemo() {
trd.setClientInfo("javaclient", 1); //クライアント情報の設定
trd.setConnSpi(this); //接続コールバックの設定
trd.setTrdSpi(this); //取引コールバックの設定
}
public void start() {
trd.initConnect("127.0.0.1", (short)11111, false);
}
@Override
public void onInitConnect(FTAPI_Conn client, long errCode, String desc)
{
System.out.printf("Trd onInitConnect: ret=%b desc=%s connID=%d\n", errCode, desc, client.getConnectID());
if (errCode != 0)
return;
TrdCommon.TrdHeader header = TrdCommon.TrdHeader.newBuilder()
.setAccID(281756457888247915L)
.setTrdEnv(TrdCommon.TrdEnv.TrdEnv_Real_VALUE)
.setTrdMarket(TrdCommon.TrdMarket.TrdMarket_HK_VALUE)
.build();
TrdGetPositionList.C2S c2s = TrdGetPositionList.C2S.newBuilder()
.setHeader(header)
.build();
TrdGetPositionList.Request req = TrdGetPositionList.Request.newBuilder().setC2S(c2s).build();
int seqNo = trd.getPositionList(req);
System.out.printf("Send TrdGetPositionList: %d\n", seqNo);
}
@Override
public void onDisconnect(FTAPI_Conn client, long errCode) {
System.out.printf("Trd onDisConnect: %d\n", errCode);
}
@Override
public void onReply_GetPositionList(FTAPI_Conn client, int nSerialNo, TrdGetPositionList.Response rsp) {
if (rsp.getRetType() != 0) {
System.out.printf("TrdGetPositionList failed: %s\n", rsp.getRetMsg());
}
else {
try {
String json = JsonFormat.printer().print(rsp);
System.out.printf("Receive TrdGetPositionList: %s\n", json);
} catch (InvalidProtocolBufferException e) {
e.printStackTrace();
}
}
}
public static void main(String[] args) {
FTAPI.init();
TrdDemo trd = new TrdDemo();
trd.start();
while (true) {
try {
Thread.sleep(1000 * 600);
} catch (InterruptedException exc) {
}
}
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
- Output
Send TrdGetPositionList: 2
Receive TrdGetPositionList: {
"retType": 0,
"retMsg": "",
"errCode": 0,
"s2c": {
"header": {
"trdEnv": 0,
"accID": "281756457888247915",
"trdMarket": 1
},
"positionList": [{
"positionID": "804953599703017051",
"positionSide": 0,
"code": "00700",
"name": "腾讯控股",
"qty": 100.0,
"canSellQty": 100.0,
"price": 594.0,
"costPrice": 594.0,
"val": 59400.0,
"plVal": 0.0,
"plRatio": 0.0,
"secMarket": 1,
"dilutedCostPrice": 594.0,
"averageCostPrice": 594.0,
"averagePlRatio": 0.0
}]
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
Futu::u32_t GetPositionList(const Trd_GetPositionList::Request &stReq);
virtual void OnReply_GetPositionList(Futu::u32_t nSerialNo, const Trd_GetPositionList::Response &stRsp) = 0;
概要
取引口座のポジションリストを照会します
パラメータ
message C2S
{
required Trd_Common.TrdHeader header = 1; //取引共通パラメータヘッダー
optional Trd_Common.TrdFilterConditions filterConditions = 2; //フィルタ条件
optional double filterPLRatioMin = 3; //損益率の下限フィルタ。この比率を超えるものを返す。証券口座は希薄化取得原価の損益率、先物口座は平均取得原価の損益率を使用
optional double filterPLRatioMax = 4; //損益率の上限フィルタ。この比率を下回るものを返す。証券口座は希薄化取得原価の損益率、先物口座は平均取得原価の損益率を使用
optional bool refreshCache = 5; //OpenDのキャッシュデータを即座に更新。デフォルトは未入力。true の場合はサーバーから最新データを取得してキャッシュを更新し返却。false または未入力の場合はOpenDのキャッシュデータを返却し、サーバーへのリクエストは行いません。
//通常、サーバー側で更新があれば直ちにOpenDへプッシュされ、OpenDがデータをキャッシュします。APIリクエスト時にはキャッシュデータを同期的に返すため、通常はキャッシュの更新指定は不要です。高速なレスポンスの確保とサーバー負荷の軽減のため
//パケットロスなどが発生した場合、キャッシュデータとサーバーが不一致になることがあります。データ更新に異常がある場合は、キャッシュの更新を指定してデータ同期の問題を解決できます。
optional int32 assetCategory = 6; //口座資産タイプ。日本デリバティブ口座は必須。Trd_Common.TrdAssetCategory を参照
}
message Request
{
required C2S c2s = 1;
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
- 取引共通パラメータヘッダー構造体を参照 TrdHeader
- フィルタ条件構造体を参照 TrdFilterConditions
- 口座資産タイプ構造体を参照 TrdAssetCategory
- コールバック
message S2C
{
required Trd_Common.TrdHeader header = 1; //取引共通パラメータヘッダー
repeated Trd_Common.Position positionList = 2; //ポジションリスト
}
message Response
{
//以下の3つのフィールドは各プロトコルに共通。コメント説明は InitConnect.proto を参照
required int32 retType = 1 [default = -400];
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
- Example
class Program : public FTSPI_Qot, public FTSPI_Trd, public FTSPI_Conn
{
public:
Program() {
m_pTrdApi = FTAPI::CreateTrdApi();
m_pTrdApi->RegisterTrdSpi(this);
m_pTrdApi->RegisterConnSpi(this);
}
~Program() {
if (m_pTrdApi != nullptr)
{
m_pTrdApi->UnregisterTrdSpi();
m_pTrdApi->UnregisterConnSpi();
FTAPI::ReleaseTrdApi(m_pTrdApi);
m_pTrdApi = nullptr;
}
}
void Start() {
m_pTrdApi->InitConnect("127.0.0.1", 11111, false);
}
virtual void OnInitConnect(FTAPI_Conn* pConn, Futu::i64_t nErrCode, const char* strDesc) {
cout << "connect" << endl;
// パケット生成
Trd_GetPositionList::Request req;
Trd_GetPositionList::C2S *c2s = req.mutable_c2s();
Trd_Common::TrdHeader *header = c2s->mutable_header();
header->set_accid(3637840);
header->set_trdenv(0);
header->set_trdmarket(1);
m_GetPositionListSerialNo = m_pTrdApi->GetPositionList(req);
cout << "Request GetPositionList SerialNo: " << m_GetPositionListSerialNo << endl;
}
virtual void OnReply_GetPositionList(Futu::u32_t nSerialNo, const Trd_GetPositionList::Response &stRsp){
if(nSerialNo == m_GetPositionListSerialNo)
{
cout << "OnReply_GetPositionList SerialNo: " << nSerialNo << endl;
// 内部構造を解析して出力
// ProtoBufToBodyData と UTF8ToLocal 関数の定義は Sample の tool.h ファイルを参照
string resp_str;
ProtoBufToBodyData(stRsp, resp_str);
cout << UTF8ToLocal(resp_str) << endl;
}
}
protected:
FTAPI_Trd *m_pTrdApi;
Futu::u32_t m_GetPositionListSerialNo;
};
int32_t main(int32_t argc, char** argv)
{
FTAPI::Init();
{
Program program;
program.Start();
getchar();
}
protobuf::ShutdownProtobufLibrary();
FTAPI::UnInit();
return 0;
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
- Output
connect
Request GetPositionList SerialNo: 4
OnReply_GetPositionList SerialNo: 4
{
"retType": 0,
"retMsg": "",
"errCode": 0,
"s2c": {
"header": {
"trdEnv": 0,
"accID": "3637840",
"trdMarket": 1
},
"positionList": [
{
"positionID": "806833430706896474",
"positionSide": 0,
"code": "00700",
"name": "腾讯控股",
"qty": 300,
"canSellQty": 300,
"price": 604.5,
"costPrice": 611.5,
"val": 181350,
"plVal": -2100,
"plRatio": -0.011447260834015,
"secMarket": 1,
"dilutedCostPrice": 611.5,
"averageCostPrice": 611.5,
"averagePlRatio": -0.011447260834015
}
]
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
GetPositionList(req);
概要
取引口座のポジションリストを照会します
パラメータ
message C2S
{
required Trd_Common.TrdHeader header = 1; //取引共通パラメータヘッダー
optional Trd_Common.TrdFilterConditions filterConditions = 2; //フィルタ条件
optional double filterPLRatioMin = 3; //損益率の下限フィルタ。この比率を超えるものを返す。証券口座は希薄化取得原価の損益率、先物口座は平均取得原価の損益率を使用
optional double filterPLRatioMax = 4; //損益率の上限フィルタ。この比率を下回るものを返す。証券口座は希薄化取得原価の損益率、先物口座は平均取得原価の損益率を使用
optional bool refreshCache = 5; //OpenDのキャッシュデータを即座に更新。デフォルトは未入力。true の場合はサーバーから最新データを取得してキャッシュを更新し返却。false または未入力の場合はOpenDのキャッシュデータを返却し、サーバーへのリクエストは行いません。
//通常、サーバー側で更新があれば直ちにOpenDへプッシュされ、OpenDがデータをキャッシュします。APIリクエスト時にはキャッシュデータを同期的に返すため、通常はキャッシュの更新指定は不要です。高速なレスポンスの確保とサーバー負荷の軽減のため
//パケットロスなどが発生した場合、キャッシュデータとサーバーが不一致になることがあります。データ更新に異常がある場合は、キャッシュの更新を指定してデータ同期の問題を解決できます。
optional int32 assetCategory = 6; //口座資産タイプ。日本デリバティブ口座は必須。Trd_Common.TrdAssetCategory を参照
}
message Request
{
required C2S c2s = 1;
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
- 取引共通パラメータヘッダー構造体を参照 TrdHeader
- フィルタ条件構造体を参照 TrdFilterConditions
- 口座資産タイプ構造体を参照 TrdAssetCategory
- 戻り値
message S2C
{
required Trd_Common.TrdHeader header = 1; //取引共通パラメータヘッダー
repeated Trd_Common.Position positionList = 2; //ポジションリスト
}
message Response
{
//以下の3つのフィールドは各プロトコルに共通。コメント説明は InitConnect.proto を参照
required int32 retType = 1 [default = -400];
optional string retMsg = 2;
optional int32 errCode = 3;
optional S2C s2c = 4;
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
- Example
import ftWebsocket from "futu-api";
import { ftCmdID } from "futu-api";
import { Common, Qot_Common, Trd_Common } from "futu-api/proto";
import beautify from "js-beautify";
function TrdGetPositionList(){
const { RetType } = Common
const { TrdEnv, TrdMarket } = Trd_Common
let [addr, port, enable_ssl, key] = ["127.0.0.1", 33333, false, 'ced92e472b40c92a'];
let websocket = new ftWebsocket();
websocket.onlogin = (ret, msg)=>{
if (ret) { // ログイン成功
websocket.GetAccList({
c2s: {
userID: 0,
},
}).then((res) => {
let { retType,s2c: { accList } } = res
if(retType == RetType.RetType_Succeed){
let acc = accList.filter((item)=>{
return item.trdEnv == TrdEnv.TrdEnv_Simulate && item.trdMarketAuthList.some((auth)=>{ return auth == TrdMarket.TrdMarket_HK})
})[0]; // サンプルは香港市場デモ環境の最初の口座を取得
const req = {
c2s: {
header: {
trdEnv: acc.trdEnv,
accID: acc.accID,
trdMarket: TrdMarket.TrdMarket_HK,
},
},
};
websocket.GetPositionList(req)
.then((res) => {
let { errCode, retMsg, retType,s2c } = res
console.log("GetPositionList: errCode %d, retMsg %s, retType %d", errCode, retMsg, retType);
if(retType == RetType.RetType_Succeed){
let data = beautify(JSON.stringify(s2c), {
indent_size: 2,
space_in_empty_paren: true,
});
console.log(data);
}
})
.catch((error) => {
console.log("error:", error);
});
}
})
.catch((error) => {
console.log("GetAccList error:", error);
});
} else {
console.log("error", msg);
}
};
websocket.start(addr, port, enable_ssl, key);
//相場接続をクローズ。使用後は接続をクローズしてください。不要なリソース占有を防ぎます
//OpenD は最大 128 接続に制限されています
//1 ページまたは 1 プロジェクトで 1 接続を維持することも可能。ここではサンプルとしてリクエストごとに 1 接続を作成
setTimeout(()=>{
websocket.stop();
console.log("stop");
}, 5000); // 5 秒後に切断
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
- Output
GetPositionList: errCode 0, retMsg , retType 0
{
"header": {
"trdEnv": 0,
"accID": "6684972",
"trdMarket": 1
},
"positionList": [{
"positionID": "3411713033831199757",
"positionSide": 0,
"code": "00700",
"name": "腾讯控股",
"qty": 1900,
"canSellQty": 1900,
"price": 479.8,
"costPrice": 454.558,
"val": 911620,
"plVal": 47960,
"plRatio": 0.05553111178009899,
"secMarket": 1,
"dilutedCostPrice": 454.558,
"averageCostPrice": 454.558,
"averagePlRatio": 0.05553111178009899
}]
}
stop
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
APIレート制限
- 同一口座ID(acc_id) 每 30 秒内最多リクエスト 10 次照会ポジションAPI
- このAPIの呼び出しは、キャッシュを更新する場合のみレート制限の対象となります