# 查詢持倉
- 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,表示指定第 1 個交易業務賬户
refresh_cache bool 是否更新快取 - True:立即向富途伺服器重新請求數據,不使用 OpenD 的快取,此時會受到介面頻率限制的限制
- False:使用 OpenD 的快取(特殊情況導致快取沒有及時更新才需要更新)
asset_category AssetCategory 資產類別 僅對日本券商生效
回傳
參數 類型 說明 ret RET_CODE 接口執行結果 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 向伺服器獲取最新數據更新快取並回傳;flase 或沒填則回傳 OpenD 快取的數據,不會向伺服器請求。
//正常情況下,伺服器有更新就會立即推送到 OpenD,OpenD 快取着數據,API 請求過來,回傳同步的快取數據,一般不需要指定更新快取,保證快速回傳且減少對伺服器的壓力
//如果遇到丟包等情況,可能出現快取數據與伺服器不一致,用户如果發現數據更新有異樣,可指定更新快取,解決數據同步的問題。
optional int32 assetCategory = 6; //賬户資產類型,JP衍生品賬户必填,參考 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 向伺服器獲取最新數據更新快取並回傳;flase 或沒填則回傳 OpenD 快取的數據,不會向伺服器請求。
//正常情況下,伺服器有更新就會立即推送到 OpenD,OpenD 快取着數據,API 請求過來,回傳同步的快取數據,一般不需要指定更新快取,保證快速回傳且減少對伺服器的壓力
//如果遇到丟包等情況,可能出現快取數據與伺服器不一致,用户如果發現數據更新有異樣,可指定更新快取,解決數據同步的問題。
optional int32 assetCategory = 6; //賬户資產類型,JP衍生品賬户必填,參考 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 向伺服器獲取最新數據更新快取並回傳;flase 或沒填則回傳 OpenD 快取的數據,不會向伺服器請求。
//正常情況下,伺服器有更新就會立即推送到 OpenD,OpenD 快取着數據,API 請求過來,回傳同步的快取數據,一般不需要指定更新快取,保證快速回傳且減少對伺服器的壓力
//如果遇到丟包等情況,可能出現快取數據與伺服器不一致,用户如果發現數據更新有異樣,可指定更新快取,解決數據同步的問題。
optional int32 assetCategory = 6; //賬户資產類型,JP衍生品賬户必填,參考 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 向伺服器獲取最新數據更新快取並回傳;flase 或沒填則回傳 OpenD 快取的數據,不會向伺服器請求。
//正常情況下,伺服器有更新就會立即推送到 OpenD,OpenD 快取着數據,API 請求過來,回傳同步的快取數據,一般不需要指定更新快取,保證快速回傳且減少對伺服器的壓力
//如果遇到丟包等情況,可能出現快取數據與伺服器不一致,用户如果發現數據更新有異樣,可指定更新快取,解決數據同步的問題。
optional int32 assetCategory = 6; //賬户資產類型,JP衍生品賬户必填,參考 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 向伺服器獲取最新數據更新快取並回傳;flase 或沒填則回傳 OpenD 快取的數據,不會向伺服器請求。
//正常情況下,伺服器有更新就會立即推送到 OpenD,OpenD 快取着數據,API 請求過來,回傳同步的快取數據,一般不需要指定更新快取,保證快速回傳且減少對伺服器的壓力
//如果遇到丟包等情況,可能出現快取數據與伺服器不一致,用户如果發現數據更新有異樣,可指定更新快取,解決數據同步的問題。
optional int32 assetCategory = 6; //賬户資產類型,JP衍生品賬户必填,參考 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條連接
//也可以一個頁面或者一個項目維護一條連接,這裏範例請求一次創建一條連接
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
接口限制
- 同一賬户ID(acc_id) 每 30 秒內最多請求 10 次查詢持倉接口
- 執行此接口,只有在更新快取時,才受到限頻限制
- 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,表示指定第 1 個交易業務賬户
refresh_cache bool 是否更新快取 - True:立即向富途伺服器重新請求數據,不使用 OpenD 的快取,此時會受到介面頻率限制的限制
- False:使用 OpenD 的快取(特殊情況導致快取沒有及時更新才需要更新)
asset_category AssetCategory 資產類別 僅對日本券商生效
回傳
參數 類型 說明 ret RET_CODE 接口執行結果 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 向伺服器獲取最新數據更新快取並回傳;flase 或沒填則回傳 OpenD 快取的數據,不會向伺服器請求。
//正常情況下,伺服器有更新就會立即推送到 OpenD,OpenD 快取着數據,API 請求過來,回傳同步的快取數據,一般不需要指定更新快取,保證快速回傳且減少對伺服器的壓力
//如果遇到丟包等情況,可能出現快取數據與伺服器不一致,用户如果發現數據更新有異樣,可指定更新快取,解決數據同步的問題。
optional int32 assetCategory = 6; //賬户資產類型,JP衍生品賬户必填,參考 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 向伺服器獲取最新數據更新快取並回傳;flase 或沒填則回傳 OpenD 快取的數據,不會向伺服器請求。
//正常情況下,伺服器有更新就會立即推送到 OpenD,OpenD 快取着數據,API 請求過來,回傳同步的快取數據,一般不需要指定更新快取,保證快速回傳且減少對伺服器的壓力
//如果遇到丟包等情況,可能出現快取數據與伺服器不一致,用户如果發現數據更新有異樣,可指定更新快取,解決數據同步的問題。
optional int32 assetCategory = 6; //賬户資產類型,JP衍生品賬户必填,參考 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 向伺服器獲取最新數據更新快取並回傳;flase 或沒填則回傳 OpenD 快取的數據,不會向伺服器請求。
//正常情況下,伺服器有更新就會立即推送到 OpenD,OpenD 快取着數據,API 請求過來,回傳同步的快取數據,一般不需要指定更新快取,保證快速回傳且減少對伺服器的壓力
//如果遇到丟包等情況,可能出現快取數據與伺服器不一致,用户如果發現數據更新有異樣,可指定更新快取,解決數據同步的問題。
optional int32 assetCategory = 6; //賬户資產類型,JP衍生品賬户必填,參考 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 向伺服器獲取最新數據更新快取並回傳;flase 或沒填則回傳 OpenD 快取的數據,不會向伺服器請求。
//正常情況下,伺服器有更新就會立即推送到 OpenD,OpenD 快取着數據,API 請求過來,回傳同步的快取數據,一般不需要指定更新快取,保證快速回傳且減少對伺服器的壓力
//如果遇到丟包等情況,可能出現快取數據與伺服器不一致,用户如果發現數據更新有異樣,可指定更新快取,解決數據同步的問題。
optional int32 assetCategory = 6; //賬户資產類型,JP衍生品賬户必填,參考 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 向伺服器獲取最新數據更新快取並回傳;flase 或沒填則回傳 OpenD 快取的數據,不會向伺服器請求。
//正常情況下,伺服器有更新就會立即推送到 OpenD,OpenD 快取着數據,API 請求過來,回傳同步的快取數據,一般不需要指定更新快取,保證快速回傳且減少對伺服器的壓力
//如果遇到丟包等情況,可能出現快取數據與伺服器不一致,用户如果發現數據更新有異樣,可指定更新快取,解決數據同步的問題。
optional int32 assetCategory = 6; //賬户資產類型,JP衍生品賬户必填,參考 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條連接
//也可以一個頁面或者一個項目維護一條連接,這裏範例請求一次創建一條連接
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
接口限制
- 同一賬户ID(acc_id) 每 30 秒內最多請求 10 次查詢持倉接口
- 執行此接口,只有在更新快取時,才受到限頻限制