# 獲取到價提醒列表
- Python
- Proto
- C#
- Java
- C++
- JavaScript
get_price_reminder(code=None, market=None)
介紹
獲取對指定股票 / 指定市場設定的到價提醒列表
參數
參數 類型 説明 code str 股票代碼 market Market 市場類型 輸入滬股市場和深股市場,都會認為是 A 股市場注:code 和 market 都存在的情況下,code 優先。
返回
參數 類型 説明 ret RET_CODE 介面呼叫結果 data pd.DataFrame 當 ret == RET_OK,返回到價提醒數據 str 當 ret != RET_OK,返回錯誤描述 - 到價提醒數據格式如下:
欄位 類型 説明 code str 股票代碼 key int 標識,用於修改到價提醒 reminder_type PriceReminderType 到價提醒的類型 reminder_freq PriceReminderFreq 到價提醒的頻率 value float 提醒值 enable bool 是否啓用 note str 備註 僅支援 20 個以內的中文字符reminder_session_list list 美股到價提醒時段列表 list中元素類型是PriceReminderMarketStatus
- 到價提醒數據格式如下:
Example
from futu import *
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
ret, data = quote_ctx.get_price_reminder(code='US.AAPL')
if ret == RET_OK:
print(data)
print(data['key'].values.tolist()) # 轉為 list
else:
print('error:', data)
print('******************************************')
ret, data = quote_ctx.get_price_reminder(code=None, market=Market.US)
if ret == RET_OK:
print(data)
if data.shape[0] > 0: # 如果到價提醒列表不為空
print(data['code'][0]) # 取第一條的股票代碼
print(data['code'].values.tolist()) # 轉為 list
else:
print('error:', data)
quote_ctx.close() # 結束後記得關閉當條連線,防止連線條數用盡
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
- Output
code name key reminder_type reminder_freq value enable note reminder_session_list
0 US.AAPL 蘋果 1744021708234288125 BID_PRICE_UP ALWAYS 184.37 True 456 [US_AFTER]
1 US.AAPL 蘋果 1744022257052794489 BID_PRICE_UP ALWAYS 185.50 True 456 [OPEN, US_PRE, US_AFTER, US_OVERNIGHT]
2 US.AAPL 蘋果 1744021708211891867 ASK_PRICE_DOWN ALWAYS 182.54 True 123 [US_AFTER]
3 US.AAPL 蘋果 1744022257023211123 ASK_PRICE_DOWN ALWAYS 183.70 True 123 [OPEN, US_PRE, US_AFTER, US_OVERNIGHT]
[1744021708234288125, 1744022257052794489, 1744021708211891867, 1744022257023211123]
******************************************
code name key reminder_type reminder_freq value enable note reminder_session_list
0 US.AAPL 蘋果 1744021708234288125 BID_PRICE_UP ALWAYS 184.37 True 456 [US_AFTER]
1 US.AAPL 蘋果 1744022257052794489 BID_PRICE_UP ALWAYS 185.50 True 456 [OPEN, US_PRE, US_AFTER, US_OVERNIGHT]
2 US.AAPL 蘋果 1744021708211891867 ASK_PRICE_DOWN ALWAYS 182.54 True 123 [US_AFTER]
3 US.AAPL 蘋果 1744022257023211123 ASK_PRICE_DOWN ALWAYS 183.70 True 123 [OPEN, US_PRE, US_AFTER, US_OVERNIGHT]
4 US.NVDA 英偉達 1739697581665326308 PRICE_DOWN ALWAYS 102.00 True [OPEN, US_PRE, US_AFTER, US_OVERNIGHT]
US.AAPL
['US.AAPL', 'US.AAPL', 'US.AAPL', 'US.AAPL', 'US.NVDA']
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# Qot_GetPriceReminder.proto
介紹
獲取對指定股票 / 指定市場設定的到價提醒列表
參數
message C2S
{
//security 和 market 二選一,都存在的情況下 security 優先。
optional Qot_Common.Security security = 1; // 查詢指定股票下的到價提醒
optional int32 market = 2; //Qot_Common::QotMarket 市場,查詢市場下的到價提醒項,不區分滬深
}
message Request
{
required C2S c2s = 1;
}
2
3
4
5
6
7
8
9
10
11
- 返回
// 提醒資訊列表
message PriceReminderItem
{
required int64 key = 1; // 每個提醒的唯一標識
required int32 type = 2; // Qot_Common::PriceReminderType 提醒類型
required double value = 3; // 提醒參數值
required string note = 4; // 備註僅支援 20 個以內的中文字符
required int32 freq = 5; // Qot_Common::PriceReminderFreq 提醒頻率類型
required bool isEnable = 6; // 該提醒設定是否生效。false 不生效,true 生效
}
message PriceReminder
{
required Qot_Common.Security security = 1; // 股票
optional string name = 3; // 股票名稱
repeated PriceReminderItem itemList = 2; // 提醒資訊列表
}
message S2C
{
repeated PriceReminder priceReminderList = 1; //到價提醒
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType,返回結果
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
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
- 股票結構參見 Security
- 提醒類型枚舉參見 PriceReminderType
- 提醒頻率枚舉參見 PriceReminderFreq
- 介面呼叫結果,結構參見 RetType
協議 ID
3221
uint GetPriceReminder(QotGetPriceReminder.Request req);
virtual void OnReply_GetPriceReminder(FTAPI_Conn client, uint nSerialNo, QotGetPriceReminder.Response rsp);
介紹
獲取對指定股票 / 指定市場設定的到價提醒列表
參數
message C2S
{
//security 和 market 二選一,都存在的情況下 security 優先。
optional Qot_Common.Security security = 1; // 查詢指定股票下的到價提醒
optional int32 market = 2; //Qot_Common::QotMarket 市場,查詢市場下的到價提醒項,不區分滬深
}
message Request
{
required C2S c2s = 1;
}
2
3
4
5
6
7
8
9
10
11
- 返回
// 提醒資訊列表
message PriceReminderItem
{
required int64 key = 1; // 每個提醒的唯一標識
required int32 type = 2; // Qot_Common::PriceReminderType 提醒類型
required double value = 3; // 提醒參數值
required string note = 4; // 備註僅支援 20 個以內的中文字符
required int32 freq = 5; // Qot_Common::PriceReminderFreq 提醒頻率類型
required bool isEnable = 6; // 該提醒設定是否生效。false 不生效,true 生效
}
message PriceReminder
{
required Qot_Common.Security security = 1; // 股票
optional string name = 3; // 股票名稱
repeated PriceReminderItem itemList = 2; // 提醒資訊列表
}
message S2C
{
repeated PriceReminder priceReminderList = 1; //到價提醒
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType,返回結果
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
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
- 股票結構參見 Security
- 提醒類型枚舉參見 PriceReminderType
- 提醒頻率枚舉參見 PriceReminderFreq
- 介面呼叫結果,結構參見 RetType
- Example
public class Program : FTSPI_Qot, FTSPI_Conn {
FTAPI_Qot qot = new FTAPI_Qot();
public Program() {
qot.SetClientInfo("csharp", 1); //設定用戶端資訊
qot.SetConnCallback(this); //設定連線回呼
qot.SetQotCallback(this); //設定交易回呼
}
public void Start() {
qot.InitConnect("127.0.0.1", (ushort)11111, false);
}
public void OnInitConnect(FTAPI_Conn client, long errCode, String desc)
{
Console.Write("Qot onInitConnect: ret={0} desc={1} connID={2}\n", errCode, desc, client.GetConnectID());
if (errCode != 0)
return;
QotCommon.Security sec = QotCommon.Security.CreateBuilder()
.SetMarket((int)QotCommon.QotMarket.QotMarket_HK_Security)
.SetCode("00700")
.Build();
QotGetPriceReminder.C2S c2s = QotGetPriceReminder.C2S.CreateBuilder()
.SetSecurity(sec)
.Build();
QotGetPriceReminder.Request req = QotGetPriceReminder.Request.CreateBuilder().SetC2S(c2s).Build();
uint seqNo = qot.GetPriceReminder(req);
Console.Write("Send QotGetPriceReminder: {0}\n", seqNo);
}
public void OnDisconnect(FTAPI_Conn client, long errCode) {
Console.Write("Qot onDisConnect: {0}\n", errCode);
}
public void OnReply_GetPriceReminder(FTAPI_Conn client, uint nSerialNo, QotGetPriceReminder.Response rsp)
{
Console.Write("Reply: QotGetPriceReminder: {0} {1}\n", nSerialNo, rsp.ToString());
if(rsp.S2C.PriceReminderListCount > 0)
{
Console.Write("key: {0} \n", rsp.S2C.PriceReminderListList[0].ItemListList[0].Key);
}
}
public static void Main(String[] args) {
FTAPI.Init();
Program qot = new Program();
qot.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
55
56
- Output
Reply: QotGetPriceReminder: 3 retType: 0
retMsg: ""
errCode: 0
s2c {
priceReminderList {
security {
market: 1
code: "00700"
}
itemList {
key: 162763183755472101
type: 1
value: 5
note: ""
freq: 3
isEnable: true
}
itemList {
key: 162763177551063501
type: 1
value: 5
note: ""
freq: 3
isEnable: true
}
}
}
key: 162763183755472101
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
int getPriceReminder(QotGetPriceReminder.Request req);
void onReply_GetPriceReminder(FTAPI_Conn client, int nSerialNo, QotGetPriceReminder.Response rsp);
介紹
獲取對指定股票 / 指定市場設定的到價提醒列表
參數
message C2S
{
//security 和 market 二選一,都存在的情況下 security 優先。
optional Qot_Common.Security security = 1; // 查詢指定股票下的到價提醒
optional int32 market = 2; //Qot_Common::QotMarket 市場,查詢市場下的到價提醒項,不區分滬深
}
message Request
{
required C2S c2s = 1;
}
2
3
4
5
6
7
8
9
10
11
- 返回
// 提醒資訊列表
message PriceReminderItem
{
required int64 key = 1; // 每個提醒的唯一標識
required int32 type = 2; // Qot_Common::PriceReminderType 提醒類型
required double value = 3; // 提醒參數值
required string note = 4; // 備註僅支援 20 個以內的中文字符
required int32 freq = 5; // Qot_Common::PriceReminderFreq 提醒頻率類型
required bool isEnable = 6; // 該提醒設定是否生效。false 不生效,true 生效
}
message PriceReminder
{
required Qot_Common.Security security = 1; // 股票
optional string name = 3; // 股票名稱
repeated PriceReminderItem itemList = 2; // 提醒資訊列表
}
message S2C
{
repeated PriceReminder priceReminderList = 1; //到價提醒
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType,返回結果
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
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
- 股票結構參見 Security
- 提醒類型枚舉參見 PriceReminderType
- 提醒頻率枚舉參見 PriceReminderFreq
- 介面呼叫結果,結構參見 RetType
- Example
public class QotDemo implements FTSPI_Qot, FTSPI_Conn {
FTAPI_Conn_Qot qot = new FTAPI_Conn_Qot();
public QotDemo() {
qot.setClientInfo("javaclient", 1); //設定用戶端資訊
qot.setConnSpi(this); //設定連線回呼
qot.setQotSpi(this); //設定交易回呼
}
public void start() {
qot.initConnect("127.0.0.1", (short)11111, false);
}
@Override
public void onInitConnect(FTAPI_Conn client, long errCode, String desc)
{
System.out.printf("Qot onInitConnect: ret=%b desc=%s connID=%d\n", errCode, desc, client.getConnectID());
if (errCode != 0)
return;
QotCommon.Security sec = QotCommon.Security.newBuilder()
.setMarket(QotCommon.QotMarket.QotMarket_HK_Security_VALUE)
.setCode("00700")
.build();
QotGetPriceReminder.C2S c2s = QotGetPriceReminder.C2S.newBuilder()
.setSecurity(sec)
.build();
QotGetPriceReminder.Request req = QotGetPriceReminder.Request.newBuilder().setC2S(c2s).build();
int seqNo = qot.getPriceReminder(req);
System.out.printf("Send QotGetPriceReminder: %d\n", seqNo);
}
@Override
public void onDisconnect(FTAPI_Conn client, long errCode) {
System.out.printf("Qot onDisConnect: %d\n", errCode);
}
@Override
public void onReply_GetPriceReminder(FTAPI_Conn client, int nSerialNo, QotGetPriceReminder.Response rsp) {
if (rsp.getRetType() != 0) {
System.out.printf("QotGetPriceReminder failed: %s\n", rsp.getRetMsg());
}
else {
try {
String json = JsonFormat.printer().print(rsp);
System.out.printf("Receive QotGetPriceReminder: %s\n", json);
} catch (InvalidProtocolBufferException e) {
e.printStackTrace();
}
}
}
public static void main(String[] args) {
FTAPI.init();
QotDemo qot = new QotDemo();
qot.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
- Output
Send QotGetPriceReminder: 2
Receive QotGetPriceReminder: {
"retType": 0,
"retMsg": "",
"errCode": 0,
"s2c": {
"priceReminderList": [{
"security": {
"market": 1,
"code": "00700"
},
"itemList": [{
"key": "162452649832682701",
"type": 1,
"value": 5.0,
"note": "",
"freq": 3,
"isEnable": true
}]
}]
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
Futu::u32_t GetPriceReminder(const Qot_GetPriceReminder::Request &stReq);
virtual void OnReply_GetPriceReminder(Futu::u32_t nSerialNo, const Qot_GetPriceReminder::Response &stRsp) = 0;
介紹
獲取對指定股票 / 指定市場設定的到價提醒列表
參數
message C2S
{
//security 和 market 二選一,都存在的情況下 security 優先。
optional Qot_Common.Security security = 1; // 查詢指定股票下的到價提醒
optional int32 market = 2; //Qot_Common::QotMarket 市場,查詢市場下的到價提醒項,不區分滬深
}
message Request
{
required C2S c2s = 1;
}
2
3
4
5
6
7
8
9
10
11
- 返回
// 提醒資訊列表
message PriceReminderItem
{
required int64 key = 1; // 每個提醒的唯一標識
required int32 type = 2; // Qot_Common::PriceReminderType 提醒類型
required double value = 3; // 提醒參數值
required string note = 4; // 備註僅支援 20 個以內的中文字符
required int32 freq = 5; // Qot_Common::PriceReminderFreq 提醒頻率類型
required bool isEnable = 6; // 該提醒設定是否生效。false 不生效,true 生效
}
message PriceReminder
{
required Qot_Common.Security security = 1; // 股票
optional string name = 3; // 股票名稱
repeated PriceReminderItem itemList = 2; // 提醒資訊列表
}
message S2C
{
repeated PriceReminder priceReminderList = 1; //到價提醒
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType,返回結果
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
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
- 股票結構參見 Security
- 提醒類型枚舉參見 PriceReminderType
- 提醒頻率枚舉參見 PriceReminderFreq
- 介面呼叫結果,結構參見 RetType
- Example
class Program : public FTSPI_Qot, public FTSPI_Trd, public FTSPI_Conn
{
public:
Program() {
m_pQotApi = FTAPI::CreateQotApi();
m_pQotApi->RegisterQotSpi(this);
m_pQotApi->RegisterConnSpi(this);
}
~Program() {
if (m_pQotApi != nullptr)
{
m_pQotApi->UnregisterQotSpi();
m_pQotApi->UnregisterConnSpi();
FTAPI::ReleaseQotApi(m_pQotApi);
m_pQotApi = nullptr;
}
}
void Start() {
m_pQotApi->InitConnect("127.0.0.1", 11111, false);
}
virtual void OnInitConnect(FTAPI_Conn* pConn, Futu::i64_t nErrCode, const char* strDesc) {
cout << "connect" << endl;
// 組包
Qot_GetPriceReminder::Request req;
Qot_GetPriceReminder::C2S *c2s = req.mutable_c2s();
c2s->set_market(Qot_Common::QotMarket::QotMarket_HK_Security);
m_GetPriceReminderSerialNo = m_pQotApi->GetPriceReminder(req);
cout << "Request GetPriceReminder SerialNo: " << m_GetPriceReminderSerialNo << endl;
}
virtual void OnReply_GetPriceReminder(Futu::u32_t nSerialNo, const Qot_GetPriceReminder::Response &stRsp){
if(nSerialNo == m_GetPriceReminderSerialNo)
{
cout << "OnReply_GetPriceReminder SerialNo: " << nSerialNo << endl;
// 解析內部結構列印出來
// ProtoBufToBodyData和UTF8ToLocal函數的定義參見Sample中的tool.h檔案
string resp_str;
ProtoBufToBodyData(stRsp, resp_str);
cout << UTF8ToLocal(resp_str) << endl;
}
}
protected:
FTAPI_Qot *m_pQotApi;
Futu::u32_t m_GetPriceReminderSerialNo;
};
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
- Output
connect
Request GetPriceReminder SerialNo: 4
OnReply_GetPriceReminder SerialNo: 4
{
"retType": 0,
"retMsg": "",
"errCode": 0,
"s2c": {
"priceReminderList": [
{
"security": {
"market": 1,
"code": "00700"
},
"itemList": [
{
"key": "162320791658522901",
"type": 1,
"value": 5,
"note": "",
"freq": 3,
"isEnable": true
}
]
}
]
}
}
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
GetPriceReminder(req);
介紹
獲取對指定股票 / 指定市場設定的到價提醒列表
參數
message C2S
{
//security 和 market 二選一,都存在的情況下 security 優先。
optional Qot_Common.Security security = 1; // 查詢指定股票下的到價提醒
optional int32 market = 2; //Qot_Common::QotMarket 市場,查詢市場下的到價提醒項,不區分滬深
}
message Request
{
required C2S c2s = 1;
}
2
3
4
5
6
7
8
9
10
11
- 返回
// 提醒資訊列表
message PriceReminderItem
{
required int64 key = 1; // 每個提醒的唯一標識
required int32 type = 2; // Qot_Common::PriceReminderType 提醒類型
required double value = 3; // 提醒參數值
required string note = 4; // 備註僅支援 20 個以內的中文字符
required int32 freq = 5; // Qot_Common::PriceReminderFreq 提醒頻率類型
required bool isEnable = 6; // 該提醒設定是否生效。false 不生效,true 生效
}
message PriceReminder
{
required Qot_Common.Security security = 1; // 股票
optional string name = 3; // 股票名稱
repeated PriceReminderItem itemList = 2; // 提醒資訊列表
}
message S2C
{
repeated PriceReminder priceReminderList = 1; //到價提醒
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType,返回結果
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
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
- 股票結構參見 Security
- 提醒類型枚舉參見 PriceReminderType
- 提醒頻率枚舉參見 PriceReminderFreq
- 介面呼叫結果,結構參見 RetType
- Example
import ftWebsocket from "futu-api";
import { ftCmdID } from "futu-api";
import { Common, Qot_Common } from "futu-api/proto";
import beautify from "js-beautify";
function QotGetPriceReminder(){
const { RetType } = Common
const { QotMarket } = Qot_Common
let [addr, port, enable_ssl, key] = ["127.0.0.1", 33333, false, '7522027ccf5a06b1'];
let websocket = new ftWebsocket();
websocket.onlogin = (ret, msg)=>{
if (ret) { // 登入成功
const req = {
c2s: {
security: {
market: QotMarket.QotMarket_HK_Security,
code: "00700",
},
},
};
websocket.GetPriceReminder(req)
.then((res) => {
let { errCode, retMsg, retType,s2c } = res
console.log("PriceReminder: 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);
});
} 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
- Output
PriceReminder: errCode 0, retMsg , retType 0
{
"priceReminderList": [{
"security": {
"market": 1,
"code": "00700"
},
"itemList": [{
"key": "163126377342664201",
"type": 1,
"value": 600,
"note": "",
"freq": 1,
"isEnable": true
}]
}]
}
stop
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
介面限制
- 每 30 秒內最多請求 10 次獲取到價提醒列表介面
- Python
- Proto
- C#
- Java
- C++
- JavaScript
get_price_reminder(code=None, market=None)
介紹
獲取對指定股票 / 指定市場設定的到價提醒列表
參數
參數 類型 説明 code str 股票代碼 market Market 市場類型 輸入滬股市場和深股市場,都會認為是 A 股市場注:code 和 market 都存在的情況下,code 優先。
返回
參數 類型 説明 ret RET_CODE 介面呼叫結果 data pd.DataFrame 當 ret == RET_OK,返回到價提醒數據 str 當 ret != RET_OK,返回錯誤描述 - 到價提醒數據格式如下:
欄位 類型 説明 code str 股票代碼 key int 標識,用於修改到價提醒 reminder_type PriceReminderType 到價提醒的類型 reminder_freq PriceReminderFreq 到價提醒的頻率 value float 提醒值 enable bool 是否啓用 note str 備註 僅支援 20 個以內的中文字符reminder_session_list list 美股到價提醒時段列表 list中元素類型是PriceReminderMarketStatus
- 到價提醒數據格式如下:
Example
from moomoo import *
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
ret, data = quote_ctx.get_price_reminder(code='US.AAPL')
if ret == RET_OK:
print(data)
print(data['key'].values.tolist()) # 轉為 list
else:
print('error:', data)
print('******************************************')
ret, data = quote_ctx.get_price_reminder(code=None, market=Market.US)
if ret == RET_OK:
print(data)
if data.shape[0] > 0: # 如果到價提醒列表不為空
print(data['code'][0]) # 取第一條的股票代碼
print(data['code'].values.tolist()) # 轉為 list
else:
print('error:', data)
quote_ctx.close() # 結束後記得關閉當條連線,防止連線條數用盡
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
- Output
code name key reminder_type reminder_freq value enable note reminder_session_list
0 US.AAPL 蘋果 1744021708234288125 BID_PRICE_UP ALWAYS 184.37 True 456 [US_AFTER]
1 US.AAPL 蘋果 1744022257052794489 BID_PRICE_UP ALWAYS 185.50 True 456 [OPEN, US_PRE, US_AFTER, US_OVERNIGHT]
2 US.AAPL 蘋果 1744021708211891867 ASK_PRICE_DOWN ALWAYS 182.54 True 123 [US_AFTER]
3 US.AAPL 蘋果 1744022257023211123 ASK_PRICE_DOWN ALWAYS 183.70 True 123 [OPEN, US_PRE, US_AFTER, US_OVERNIGHT]
[1744021708234288125, 1744022257052794489, 1744021708211891867, 1744022257023211123]
******************************************
code name key reminder_type reminder_freq value enable note reminder_session_list
0 US.AAPL 蘋果 1744021708234288125 BID_PRICE_UP ALWAYS 184.37 True 456 [US_AFTER]
1 US.AAPL 蘋果 1744022257052794489 BID_PRICE_UP ALWAYS 185.50 True 456 [OPEN, US_PRE, US_AFTER, US_OVERNIGHT]
2 US.AAPL 蘋果 1744021708211891867 ASK_PRICE_DOWN ALWAYS 182.54 True 123 [US_AFTER]
3 US.AAPL 蘋果 1744022257023211123 ASK_PRICE_DOWN ALWAYS 183.70 True 123 [OPEN, US_PRE, US_AFTER, US_OVERNIGHT]
4 US.NVDA 英偉達 1739697581665326308 PRICE_DOWN ALWAYS 102.00 True [OPEN, US_PRE, US_AFTER, US_OVERNIGHT]
US.AAPL
['US.AAPL', 'US.AAPL', 'US.AAPL', 'US.AAPL', 'US.NVDA']
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# Qot_GetPriceReminder.proto
介紹
獲取對指定股票 / 指定市場設定的到價提醒列表
參數
message C2S
{
//security 和 market 二選一,都存在的情況下 security 優先。
optional Qot_Common.Security security = 1; // 查詢指定股票下的到價提醒
optional int32 market = 2; //Qot_Common::QotMarket 市場,查詢市場下的到價提醒項,不區分滬深
}
message Request
{
required C2S c2s = 1;
}
2
3
4
5
6
7
8
9
10
11
- 返回
// 提醒資訊列表
message PriceReminderItem
{
required int64 key = 1; // 每個提醒的唯一標識
required int32 type = 2; // Qot_Common::PriceReminderType 提醒類型
required double value = 3; // 提醒參數值
required string note = 4; // 備註僅支援 20 個以內的中文字符
required int32 freq = 5; // Qot_Common::PriceReminderFreq 提醒頻率類型
required bool isEnable = 6; // 該提醒設定是否生效。false 不生效,true 生效
}
message PriceReminder
{
required Qot_Common.Security security = 1; // 股票
optional string name = 3; // 股票名稱
repeated PriceReminderItem itemList = 2; // 提醒資訊列表
}
message S2C
{
repeated PriceReminder priceReminderList = 1; //到價提醒
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType,返回結果
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
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
- 股票結構參見 Security
- 提醒類型枚舉參見 PriceReminderType
- 提醒頻率枚舉參見 PriceReminderFreq
- 介面呼叫結果,結構參見 RetType
協議 ID
3221
uint GetPriceReminder(QotGetPriceReminder.Request req);
virtual void OnReply_GetPriceReminder(MMAPI_Conn client, uint nSerialNo, QotGetPriceReminder.Response rsp);
介紹
獲取對指定股票 / 指定市場設定的到價提醒列表
參數
message C2S
{
//security 和 market 二選一,都存在的情況下 security 優先。
optional Qot_Common.Security security = 1; // 查詢指定股票下的到價提醒
optional int32 market = 2; //Qot_Common::QotMarket 市場,查詢市場下的到價提醒項,不區分滬深
}
message Request
{
required C2S c2s = 1;
}
2
3
4
5
6
7
8
9
10
11
- 返回
// 提醒資訊列表
message PriceReminderItem
{
required int64 key = 1; // 每個提醒的唯一標識
required int32 type = 2; // Qot_Common::PriceReminderType 提醒類型
required double value = 3; // 提醒參數值
required string note = 4; // 備註僅支援 20 個以內的中文字符
required int32 freq = 5; // Qot_Common::PriceReminderFreq 提醒頻率類型
required bool isEnable = 6; // 該提醒設定是否生效。false 不生效,true 生效
}
message PriceReminder
{
required Qot_Common.Security security = 1; // 股票
optional string name = 3; // 股票名稱
repeated PriceReminderItem itemList = 2; // 提醒資訊列表
}
message S2C
{
repeated PriceReminder priceReminderList = 1; //到價提醒
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType,返回結果
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
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
- 股票結構參見 Security
- 提醒類型枚舉參見 PriceReminderType
- 提醒頻率枚舉參見 PriceReminderFreq
- 介面呼叫結果,結構參見 RetType
- Example
public class Program : MMSPI_Qot, MMSPI_Conn {
MMAPI_Qot qot = new MMAPI_Qot();
public Program() {
qot.SetClientInfo("csharp", 1); //設定用戶端資訊
qot.SetConnCallback(this); //設定連線回呼
qot.SetQotCallback(this); //設定交易回呼
}
public void Start() {
qot.InitConnect("127.0.0.1", (ushort)11111, false);
}
public void OnInitConnect(MMAPI_Conn client, long errCode, String desc)
{
Console.Write("Qot onInitConnect: ret={0} desc={1} connID={2}\n", errCode, desc, client.GetConnectID());
if (errCode != 0)
return;
QotCommon.Security sec = QotCommon.Security.CreateBuilder()
.SetMarket((int)QotCommon.QotMarket.QotMarket_HK_Security)
.SetCode("00700")
.Build();
QotGetPriceReminder.C2S c2s = QotGetPriceReminder.C2S.CreateBuilder()
.SetSecurity(sec)
.Build();
QotGetPriceReminder.Request req = QotGetPriceReminder.Request.CreateBuilder().SetC2S(c2s).Build();
uint seqNo = qot.GetPriceReminder(req);
Console.Write("Send QotGetPriceReminder: {0}\n", seqNo);
}
public void OnDisconnect(MMAPI_Conn client, long errCode) {
Console.Write("Qot onDisConnect: {0}\n", errCode);
}
public void OnReply_GetPriceReminder(MMAPI_Conn client, uint nSerialNo, QotGetPriceReminder.Response rsp)
{
Console.Write("Reply: QotGetPriceReminder: {0} {1}\n", nSerialNo, rsp.ToString());
if(rsp.S2C.PriceReminderListCount > 0)
{
Console.Write("key: {0} \n", rsp.S2C.PriceReminderListList[0].ItemListList[0].Key);
}
}
public static void Main(String[] args) {
MMAPI.Init();
Program qot = new Program();
qot.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
55
56
- Output
Reply: QotGetPriceReminder: 3 retType: 0
retMsg: ""
errCode: 0
s2c {
priceReminderList {
security {
market: 1
code: "00700"
}
itemList {
key: 162763183755472101
type: 1
value: 5
note: ""
freq: 3
isEnable: true
}
itemList {
key: 162763177551063501
type: 1
value: 5
note: ""
freq: 3
isEnable: true
}
}
}
key: 162763183755472101
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
int getPriceReminder(QotGetPriceReminder.Request req);
void onReply_GetPriceReminder(MMAPI_Conn client, int nSerialNo, QotGetPriceReminder.Response rsp);
介紹
獲取對指定股票 / 指定市場設定的到價提醒列表
參數
message C2S
{
//security 和 market 二選一,都存在的情況下 security 優先。
optional Qot_Common.Security security = 1; // 查詢指定股票下的到價提醒
optional int32 market = 2; //Qot_Common::QotMarket 市場,查詢市場下的到價提醒項,不區分滬深
}
message Request
{
required C2S c2s = 1;
}
2
3
4
5
6
7
8
9
10
11
- 返回
// 提醒資訊列表
message PriceReminderItem
{
required int64 key = 1; // 每個提醒的唯一標識
required int32 type = 2; // Qot_Common::PriceReminderType 提醒類型
required double value = 3; // 提醒參數值
required string note = 4; // 備註僅支援 20 個以內的中文字符
required int32 freq = 5; // Qot_Common::PriceReminderFreq 提醒頻率類型
required bool isEnable = 6; // 該提醒設定是否生效。false 不生效,true 生效
}
message PriceReminder
{
required Qot_Common.Security security = 1; // 股票
optional string name = 3; // 股票名稱
repeated PriceReminderItem itemList = 2; // 提醒資訊列表
}
message S2C
{
repeated PriceReminder priceReminderList = 1; //到價提醒
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType,返回結果
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
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
- 股票結構參見 Security
- 提醒類型枚舉參見 PriceReminderType
- 提醒頻率枚舉參見 PriceReminderFreq
- 介面呼叫結果,結構參見 RetType
- Example
public class QotDemo implements MMSPI_Qot, MMSPI_Conn {
MMAPI_Conn_Qot qot = new MMAPI_Conn_Qot();
public QotDemo() {
qot.setClientInfo("javaclient", 1); //設定用戶端資訊
qot.setConnSpi(this); //設定連線回呼
qot.setQotSpi(this); //設定交易回呼
}
public void start() {
qot.initConnect("127.0.0.1", (short)11111, false);
}
@Override
public void onInitConnect(MMAPI_Conn client, long errCode, String desc)
{
System.out.printf("Qot onInitConnect: ret=%b desc=%s connID=%d\n", errCode, desc, client.getConnectID());
if (errCode != 0)
return;
QotCommon.Security sec = QotCommon.Security.newBuilder()
.setMarket(QotCommon.QotMarket.QotMarket_HK_Security_VALUE)
.setCode("00700")
.build();
QotGetPriceReminder.C2S c2s = QotGetPriceReminder.C2S.newBuilder()
.setSecurity(sec)
.build();
QotGetPriceReminder.Request req = QotGetPriceReminder.Request.newBuilder().setC2S(c2s).build();
int seqNo = qot.getPriceReminder(req);
System.out.printf("Send QotGetPriceReminder: %d\n", seqNo);
}
@Override
public void onDisconnect(MMAPI_Conn client, long errCode) {
System.out.printf("Qot onDisConnect: %d\n", errCode);
}
@Override
public void onReply_GetPriceReminder(MMAPI_Conn client, int nSerialNo, QotGetPriceReminder.Response rsp) {
if (rsp.getRetType() != 0) {
System.out.printf("QotGetPriceReminder failed: %s\n", rsp.getRetMsg());
}
else {
try {
String json = JsonFormat.printer().print(rsp);
System.out.printf("Receive QotGetPriceReminder: %s\n", json);
} catch (InvalidProtocolBufferException e) {
e.printStackTrace();
}
}
}
public static void main(String[] args) {
MMAPI.init();
QotDemo qot = new QotDemo();
qot.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
- Output
Send QotGetPriceReminder: 2
Receive QotGetPriceReminder: {
"retType": 0,
"retMsg": "",
"errCode": 0,
"s2c": {
"priceReminderList": [{
"security": {
"market": 1,
"code": "00700"
},
"itemList": [{
"key": "162452649832682701",
"type": 1,
"value": 5.0,
"note": "",
"freq": 3,
"isEnable": true
}]
}]
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
moomoo::u32_t GetPriceReminder(const Qot_GetPriceReminder::Request &stReq);
virtual void OnReply_GetPriceReminder(moomoo::u32_t nSerialNo, const Qot_GetPriceReminder::Response &stRsp) = 0;
介紹
獲取對指定股票 / 指定市場設定的到價提醒列表
參數
message C2S
{
//security 和 market 二選一,都存在的情況下 security 優先。
optional Qot_Common.Security security = 1; // 查詢指定股票下的到價提醒
optional int32 market = 2; //Qot_Common::QotMarket 市場,查詢市場下的到價提醒項,不區分滬深
}
message Request
{
required C2S c2s = 1;
}
2
3
4
5
6
7
8
9
10
11
- 返回
// 提醒資訊列表
message PriceReminderItem
{
required int64 key = 1; // 每個提醒的唯一標識
required int32 type = 2; // Qot_Common::PriceReminderType 提醒類型
required double value = 3; // 提醒參數值
required string note = 4; // 備註僅支援 20 個以內的中文字符
required int32 freq = 5; // Qot_Common::PriceReminderFreq 提醒頻率類型
required bool isEnable = 6; // 該提醒設定是否生效。false 不生效,true 生效
}
message PriceReminder
{
required Qot_Common.Security security = 1; // 股票
optional string name = 3; // 股票名稱
repeated PriceReminderItem itemList = 2; // 提醒資訊列表
}
message S2C
{
repeated PriceReminder priceReminderList = 1; //到價提醒
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType,返回結果
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
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
- 股票結構參見 Security
- 提醒類型枚舉參見 PriceReminderType
- 提醒頻率枚舉參見 PriceReminderFreq
- 介面呼叫結果,結構參見 RetType
- Example
class Program : public MMSPI_Qot, public MMSPI_Trd, public MMSPI_Conn
{
public:
Program() {
m_pQotApi = MMAPI::CreateQotApi();
m_pQotApi->RegisterQotSpi(this);
m_pQotApi->RegisterConnSpi(this);
}
~Program() {
if (m_pQotApi != nullptr)
{
m_pQotApi->UnregisterQotSpi();
m_pQotApi->UnregisterConnSpi();
MMAPI::ReleaseQotApi(m_pQotApi);
m_pQotApi = nullptr;
}
}
void Start() {
m_pQotApi->InitConnect("127.0.0.1", 11111, false);
}
virtual void OnInitConnect(MMAPI_Conn* pConn, moomoo::i64_t nErrCode, const char* strDesc) {
cout << "connect" << endl;
// 組包
Qot_GetPriceReminder::Request req;
Qot_GetPriceReminder::C2S *c2s = req.mutable_c2s();
c2s->set_market(Qot_Common::QotMarket::QotMarket_HK_Security);
m_GetPriceReminderSerialNo = m_pQotApi->GetPriceReminder(req);
cout << "Request GetPriceReminder SerialNo: " << m_GetPriceReminderSerialNo << endl;
}
virtual void OnReply_GetPriceReminder(moomoo::u32_t nSerialNo, const Qot_GetPriceReminder::Response &stRsp){
if(nSerialNo == m_GetPriceReminderSerialNo)
{
cout << "OnReply_GetPriceReminder SerialNo: " << nSerialNo << endl;
// 解析內部結構列印出來
// ProtoBufToBodyData和UTF8ToLocal函數的定義參見Sample中的tool.h檔案
string resp_str;
ProtoBufToBodyData(stRsp, resp_str);
cout << UTF8ToLocal(resp_str) << endl;
}
}
protected:
MMAPI_Qot *m_pQotApi;
moomoo::u32_t m_GetPriceReminderSerialNo;
};
int32_t main(int32_t argc, char** argv)
{
MMAPI::Init();
{
Program program;
program.Start();
getchar();
}
protobuf::ShutdownProtobufLibrary();
MMAPI::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
- Output
connect
Request GetPriceReminder SerialNo: 4
OnReply_GetPriceReminder SerialNo: 4
{
"retType": 0,
"retMsg": "",
"errCode": 0,
"s2c": {
"priceReminderList": [
{
"security": {
"market": 1,
"code": "00700"
},
"itemList": [
{
"key": "162320791658522901",
"type": 1,
"value": 5,
"note": "",
"freq": 3,
"isEnable": true
}
]
}
]
}
}
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
GetPriceReminder(req);
介紹
獲取對指定股票 / 指定市場設定的到價提醒列表
參數
message C2S
{
//security 和 market 二選一,都存在的情況下 security 優先。
optional Qot_Common.Security security = 1; // 查詢指定股票下的到價提醒
optional int32 market = 2; //Qot_Common::QotMarket 市場,查詢市場下的到價提醒項,不區分滬深
}
message Request
{
required C2S c2s = 1;
}
2
3
4
5
6
7
8
9
10
11
- 返回
// 提醒資訊列表
message PriceReminderItem
{
required int64 key = 1; // 每個提醒的唯一標識
required int32 type = 2; // Qot_Common::PriceReminderType 提醒類型
required double value = 3; // 提醒參數值
required string note = 4; // 備註僅支援 20 個以內的中文字符
required int32 freq = 5; // Qot_Common::PriceReminderFreq 提醒頻率類型
required bool isEnable = 6; // 該提醒設定是否生效。false 不生效,true 生效
}
message PriceReminder
{
required Qot_Common.Security security = 1; // 股票
optional string name = 3; // 股票名稱
repeated PriceReminderItem itemList = 2; // 提醒資訊列表
}
message S2C
{
repeated PriceReminder priceReminderList = 1; //到價提醒
}
message Response
{
required int32 retType = 1 [default = -400]; //RetType,返回結果
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
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
- 股票結構參見 Security
- 提醒類型枚舉參見 PriceReminderType
- 提醒頻率枚舉參見 PriceReminderFreq
- 介面呼叫結果,結構參見 RetType
- Example
import mmWebsocket from "moomoo-api";
import { mmCmdID } from "moomoo-api";
import { Common, Qot_Common } from "moomoo-api/proto";
import beautify from "js-beautify";
function QotGetPriceReminder(){
const { RetType } = Common
const { QotMarket } = Qot_Common
let [addr, port, enable_ssl, key] = ["127.0.0.1", 33333, false, '7522027ccf5a06b1'];
let websocket = new mmWebsocket();
websocket.onlogin = (ret, msg)=>{
if (ret) { // 登入成功
const req = {
c2s: {
security: {
market: QotMarket.QotMarket_HK_Security,
code: "00700",
},
},
};
websocket.GetPriceReminder(req)
.then((res) => {
let { errCode, retMsg, retType,s2c } = res
console.log("PriceReminder: 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);
});
} 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
- Output
PriceReminder: errCode 0, retMsg , retType 0
{
"priceReminderList": [{
"security": {
"market": 1,
"code": "00700"
},
"itemList": [{
"key": "163126377342664201",
"type": 1,
"value": 600,
"note": "",
"freq": 1,
"isEnable": true
}]
}]
}
stop
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
介面限制
- 每 30 秒內最多請求 10 次獲取到價提醒列表介面