# Get Short Interest
- Python
- Proto
- C#
- Java
- C++
- JavaScript
get_short_interest(code, next_key=None, num=None)
Description
Get the short interest history for a specified HK or US stock, with pagination support
Parameters
Parameter Type Description code str Stock code Supports HK and US equities and funds, e.g. US.AAPL, HK.00700next_key str Pagination key Leave empty for the first request; pass the next_key from the previous response to continue; "-1" means no more datanum int Page size Default 10, range 1~50Return
Parameter Type Description ret RET_CODE API call result us_df pd.DataFrame US short interest data; error string when ret != RET_OK hk_df pd.DataFrame HK short interest data; None when ret != RET_OK US DataFrame (us_df) fields:
Field Type Description timestamp int Trading day timestamp Unix timestamp in seconds, midnight of the trading daytimestamp_str str Trading day string Format YYYY-MM-DD, in the market's timezoneshares_short int Shares sold short short_percent float Short ratio Value before the percent sign, e.g. 12.34 means 12.34%avg_daily_share_volume int Average daily share volume days_to_cover float Days to cover close_price float Close price last_close_price float Previous close price US us_df.attrs additional attributes:
Attribute Type Description next_key str Pagination key "-1" means no more dataHK DataFrame (hk_df) fields:
Field Type Description timestamp int Trading day timestamp Unix timestamp in seconds, midnight of the trading daytimestamp_str str Trading day string Format YYYY-MM-DD, in the market's timezoneclose_price float Close price last_close_price float Previous close price aggregated_short int Aggregated short positions (shares) aggregated_short_ratio float Short ratio of shares outstanding Value before the percent sign, e.g. 12.34 means 12.34%HK hk_df.attrs additional attributes:
Attribute Type Description next_key str Pagination key "-1" means no more data
Example
from futu import *
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
ret, us_df, hk_df = quote_ctx.get_short_interest("HK.00700")
if ret == RET_OK:
print(hk_df)
else:
print('error:', hk_df)
quote_ctx.close()
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
- Output
timestamp timestamp_str aggregated_short aggregated_short_ratio close_price last_close_price
0 1777478400 2026-04-30 51480638 0.56 467.8 479.2
1 1776960000 2026-04-24 51888755 0.56 493.4 495.2
2 1776355200 2026-04-17 47974208 0.52 510.5 517.0
3 1775750400 2026-04-10 48424833 0.53 504.5 508.5
4 1775059200 2026-04-02 49982828 0.54 489.2 496.6
5 1774540800 2026-03-27 52744147 0.57 493.4 495.6
6 1773936000 2026-03-20 51710854 0.56 508.0 513.0
7 1773331200 2026-03-13 48105325 0.52 547.5 546.5
8 1772726400 2026-03-06 42404275 0.46 519.0 502.0
9 1772121600 2026-02-27 36037870 0.39 518.0 512.0
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
# Qot_GetShortInterest.proto
Description
Get short interest data
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock
optional string nextKey = 2; // Pagination key; leave empty for first request; pass previous nextKey to continue; "-1" means no more data
optional int32 num = 3; // Page size, default 10, range 1~50
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
- Security structure: see Security
- Return
// US short interest record
message UsShortInterestItem
{
optional int64 timestamp = 1; // Trading day timestamp (seconds)
optional string timestampStr = 2; // Trading day string, format YYYY-MM-DD, in the market's timezone
optional uint64 sharesShort = 3; // Shares sold short
optional double shortPercent = 4; // Short ratio; value before the percent sign, e.g. 12.34 means 12.34%
optional uint64 avgDailyShareVolume = 5; // Average daily share volume
optional double daysToCover = 6; // Days to cover
optional double closePrice = 7; // Close price
optional double lastClosePrice = 8; // Previous close price
}
// HK short interest record
message HkShortInterestItem
{
optional int64 timestamp = 1; // Trading day timestamp (seconds)
optional string timestampStr = 2; // Trading day string, format YYYY-MM-DD, in the market's timezone
optional double closePrice = 3; // Close price
optional double lastClosePrice = 4; // Previous close price
optional uint64 aggregatedShort = 5; // Aggregated short positions (shares)
optional double aggregatedShortRatio = 6; // Short ratio of shares outstanding; value before the percent sign, e.g. 12.34 means 12.34%
}
message S2C
{
repeated UsShortInterestItem usItemList = 1; // US short interest data list
repeated HkShortInterestItem hkItemList = 2; // HK short interest data list
optional string nextKey = 3; // Pagination key; "-1" means no more data
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, see Common.RetType
optional string retMsg = 2; // Return message
optional int32 errCode = 3; // Error code
optional S2C s2c = 4;
}
1
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
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
- API call result: see RetType
Protocol ID
3249
uint GetShortInterest(QotGetShortInterest.Request req);
virtual void OnReply_GetShortInterest(MMAPI_Conn client, uint nSerialNo, QotGetShortInterest.Response rsp);
Description
Get short interest data
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock
optional string nextKey = 2; // Pagination key; leave empty for first request; pass previous nextKey to continue; "-1" means no more data
optional int32 num = 3; // Page size, default 10, range 1~50
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
- Security structure: see Security
- Return
message S2C
{
repeated UsShortInterestItem usItemList = 1; // US short interest data list
repeated HkShortInterestItem hkItemList = 2; // HK short interest data list
optional string nextKey = 3; // Pagination key; "-1" means no more data
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, see Common.RetType
optional string retMsg = 2; // Return message
optional int32 errCode = 3; // Error code
optional S2C s2c = 4;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
- API call result: see 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();
QotGetShortInterest.C2S c2s = QotGetShortInterest.C2S.CreateBuilder()
.SetSecurity(sec)
.Build();
QotGetShortInterest.Request req = QotGetShortInterest.Request.CreateBuilder().SetC2S(c2s).Build();
uint seqNo = qot.GetShortInterest(req);
Console.Write("Send QotGetShortInterest: {0}\n", seqNo);
}
public void OnDisconnect(FTAPI_Conn client, long errCode)
{
Console.Write("Qot onDisConnect: {0}\n", errCode);
}
public void OnReply_GetShortInterest(FTAPI_Conn client, uint nSerialNo, QotGetShortInterest.Response rsp)
{
Console.Write("Reply: QotGetShortInterest: {0} {1}\n", nSerialNo, rsp.ToString());
}
public static void Main(String[] args)
{
FTAPI.Init();
Program qot = new Program();
qot.Start();
while (true)
Thread.Sleep(1000 * 600);
}
}
1
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
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
sent seqNo=3
retType: 0
retMsg: ""
errCode: 0
s2c {
hkItemList {
timestamp: 1777478400
timestampStr: "2026-04-30"
closePrice: 467.8
lastClosePrice: 479.2
aggregatedShort: 51480638
aggregatedShortRatio: 0.56
}
hkItemList {
//...
}
nextKey: "1772121600"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
int getShortInterest(QotGetShortInterest.Request req);
void onReply_GetShortInterest(MMAPI_Conn client, int nSerialNo, QotGetShortInterest.Response rsp);
Description
Get short interest data
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock
optional string nextKey = 2; // Pagination key; leave empty for first request; pass previous nextKey to continue; "-1" means no more data
optional int32 num = 3; // Page size, default 10, range 1~50
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
- Security structure: see Security
- Return
message S2C
{
repeated UsShortInterestItem usItemList = 1; // US short interest data list
repeated HkShortInterestItem hkItemList = 2; // HK short interest data list
optional string nextKey = 3; // Pagination key; "-1" means no more data
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, see Common.RetType
optional string retMsg = 2; // Return message
optional int32 errCode = 3; // Error code
optional S2C s2c = 4;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
- API call result: see 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();
QotGetShortInterest.C2S c2s = QotGetShortInterest.C2S.newBuilder()
.setSecurity(sec)
.build();
QotGetShortInterest.Request req = QotGetShortInterest.Request.newBuilder().setC2S(c2s).build();
int seqNo = qot.getShortInterest(req);
System.out.printf("Send QotGetShortInterest: %d\n", seqNo);
}
@Override
public void onDisconnect(FTAPI_Conn client, long errCode) {
System.out.printf("Qot onDisConnect: %d\n", errCode);
}
@Override
public void onReply_GetShortInterest(FTAPI_Conn client, int nSerialNo, QotGetShortInterest.Response rsp) {
if (rsp.getRetType() != 0) {
System.out.printf("QotGetShortInterest failed: %s\n", rsp.getRetMsg());
}
else {
try {
String json = JsonFormat.printer().print(rsp);
System.out.printf("Receive QotGetShortInterest: %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) {
}
}
}
}
1
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
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
Qot onInitConnect: ret=0 desc= connID=7459212718233353666
Send Qot_GetShortInterest: 2
Receive Qot_GetShortInterest: retType: 0
retMsg: ""
errCode: 0
s2c {
hkItemList {
timestamp: 1777478400
timestampStr: "2026-04-30"
closePrice: 467.8
lastClosePrice: 479.2
aggregatedShort: 51480638
aggregatedShortRatio: 0.56
}
hkItemList {
//...
}
nextKey: "1772121600"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
moomoo::u32_t GetShortInterest(const Qot_GetShortInterest::Request &stReq);
virtual void OnReply_GetShortInterest(moomoo::u32_t nSerialNo, const Qot_GetShortInterest::Response &stRsp) = 0;
Description
Get short interest data
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock
optional string nextKey = 2; // Pagination key; leave empty for first request; pass previous nextKey to continue; "-1" means no more data
optional int32 num = 3; // Page size, default 10, range 1~50
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
- Security structure: see Security
- Return
message S2C
{
repeated UsShortInterestItem usItemList = 1; // US short interest data list
repeated HkShortInterestItem hkItemList = 2; // HK short interest data list
optional string nextKey = 3; // Pagination key; "-1" means no more data
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, see Common.RetType
optional string retMsg = 2; // Return message
optional int32 errCode = 3; // Error code
optional S2C s2c = 4;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
- API call result: see 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;
// construct request message
Qot_GetShortInterest::Request req;
Qot_GetShortInterest::C2S *c2s = req.mutable_c2s();
Qot_Common::Security *sec = c2s->mutable_security();
sec->set_code("00700");
sec->set_market(Qot_Common::QotMarket::QotMarket_HK_Security);
m_pQotApi->GetShortInterest(req);
cout << "GetShortInterest" << endl;
}
virtual void OnReply_GetShortInterest(Futu::u32_t nSerialNo, const Qot_GetShortInterest::Response &stRsp){
cout << "OnReply_GetShortInterest:" << endl;
// print response
// ProtoBufToBodyData and UTF8ToLocal refer to tool.h in Samples
string resp_str;
ProtoBufToBodyData(stRsp, resp_str);
cout << UTF8ToLocal(resp_str) << endl;
}
protected:
FTAPI_Qot *m_pQotApi;
};
int32_t main(int32_t argc, char** argv)
{
FTAPI::Init();
{
Program program;
program.Start();
getchar();
}
protobuf::ShutdownProtobufLibrary();
FTAPI::UnInit();
return 0;
}
1
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
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
- Output
onInitConnect: ret=0 desc=Succeed!
Send Qot_GetShortInterest seqNo=3
retType: 0
retMsg: ""
errCode: 0
s2c {
hkItemList {
timestamp: 1777478400
timestampStr: "2026-04-30"
closePrice: 467.8
lastClosePrice: 479.2
aggregatedShort: 51480638
aggregatedShortRatio: 0.56
}
hkItemList {
//...
}
nextKey: "1772121600"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
GetShortInterest(req);
Description
Get short interest data
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock
optional string nextKey = 2; // Pagination key; leave empty for first request; pass previous nextKey to continue; "-1" means no more data
optional int32 num = 3; // Page size, default 10, range 1~50
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
- Security structure: see Security
- Return
message S2C
{
repeated UsShortInterestItem usItemList = 1; // US short interest data list
repeated HkShortInterestItem hkItemList = 2; // HK short interest data list
optional string nextKey = 3; // Pagination key; "-1" means no more data
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, see Common.RetType
optional string retMsg = 2; // Return message
optional int32 errCode = 3; // Error code
optional S2C s2c = 4;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
- API call result: see RetType
- Example
import ftWebsocket from "futu-api";
import { Common, Qot_Common } from "futu-api/proto";
import beautify from "js-beautify";
function QotGetShortInterest(){
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.GetShortInterest(req)
.then((res) => {
let { errCode, retMsg, retType,s2c } = res
console.log("GetShortInterest: 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);
setTimeout(()=>{
websocket.stop();
console.log("stop");
}, 5000);
}
1
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
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
- Output
GetShortInterest: errCode 0, retMsg , retType 0
{
"hkItemList": [{
"timestamp": "1777478400",
"timestampStr": "2026-04-30",
"closePrice": 467.8,
"lastClosePrice": 479.2,
"aggregatedShort": "51480638",
"aggregatedShortRatio": 0.56
//...
}],
"nextKey": "1772121600"
}
stop
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
Restrictions
- Maximum 30 requests per 30 seconds.
- Supports HK and US equities and funds.
- Python
- Proto
- C#
- Java
- C++
- JavaScript
get_short_interest(stock_code, next_key=None, num=None)
Description
Get the short interest history for a specified HK or US stock, with pagination support
Parameters
Parameter Type Description stock_code str Stock code Supports HK and US equities and funds, e.g. US.AAPL, HK.00700next_key str Pagination key Leave empty for the first request; pass the next_key from the previous response to continue; "-1" means no more datanum int Page size Default 10, range 1~50Return
Parameter Type Description ret RET_CODE API call result us_df pd.DataFrame US short interest data; error string when ret != RET_OK hk_df pd.DataFrame HK short interest data; None when ret != RET_OK US DataFrame (us_df) fields:
Field Type Description timestamp int Trading day timestamp Unix timestamp in seconds, midnight of the trading daytimestamp_str str Trading day string Format YYYY-MM-DD, in the market's timezoneshares_short int Shares sold short short_percent float Short ratio Value before the percent sign, e.g. 12.34 means 12.34%avg_daily_share_volume int Average daily share volume days_to_cover float Days to cover close_price float Close price last_close_price float Previous close price US us_df.attrs additional attributes:
Attribute Type Description next_key str Pagination key "-1" means no more dataHK DataFrame (hk_df) fields:
Field Type Description timestamp int Trading day timestamp Unix timestamp in seconds, midnight of the trading daytimestamp_str str Trading day string Format YYYY-MM-DD, in the market's timezoneclose_price float Close price last_close_price float Previous close price aggregated_short int Aggregated short positions (shares) aggregated_short_ratio float Short ratio of shares outstanding Value before the percent sign, e.g. 12.34 means 12.34%HK hk_df.attrs additional attributes:
Attribute Type Description next_key str Pagination key "-1" means no more data
Example
from moomoo import *
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
ret, us_df, hk_df = quote_ctx.get_short_interest("HK.00700")
if ret == RET_OK:
print(hk_df)
else:
print('error:', hk_df)
quote_ctx.close()
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
- Output
timestamp timestamp_str aggregated_short aggregated_short_ratio close_price last_close_price
0 1777478400 2026-04-30 51480638 0.56 467.8 479.2
1 1776960000 2026-04-24 51888755 0.56 493.4 495.2
2 1776355200 2026-04-17 47974208 0.52 510.5 517.0
3 1775750400 2026-04-10 48424833 0.53 504.5 508.5
4 1775059200 2026-04-02 49982828 0.54 489.2 496.6
5 1774540800 2026-03-27 52744147 0.57 493.4 495.6
6 1773936000 2026-03-20 51710854 0.56 508.0 513.0
7 1773331200 2026-03-13 48105325 0.52 547.5 546.5
8 1772726400 2026-03-06 42404275 0.46 519.0 502.0
9 1772121600 2026-02-27 36037870 0.39 518.0 512.0
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
# Qot_GetShortInterest.proto
Description
Get short interest data
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock
optional string nextKey = 2; // Pagination key; leave empty for first request; pass previous nextKey to continue; "-1" means no more data
optional int32 num = 3; // Page size, default 10, range 1~50
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
- Security structure: see Security
- Return
// US short interest record
message UsShortInterestItem
{
optional int64 timestamp = 1; // Trading day timestamp (seconds)
optional string timestampStr = 2; // Trading day string, format YYYY-MM-DD, in the market's timezone
optional uint64 sharesShort = 3; // Shares sold short
optional double shortPercent = 4; // Short ratio; value before the percent sign, e.g. 12.34 means 12.34%
optional uint64 avgDailyShareVolume = 5; // Average daily share volume
optional double daysToCover = 6; // Days to cover
optional double closePrice = 7; // Close price
optional double lastClosePrice = 8; // Previous close price
}
// HK short interest record
message HkShortInterestItem
{
optional int64 timestamp = 1; // Trading day timestamp (seconds)
optional string timestampStr = 2; // Trading day string, format YYYY-MM-DD, in the market's timezone
optional double closePrice = 3; // Close price
optional double lastClosePrice = 4; // Previous close price
optional uint64 aggregatedShort = 5; // Aggregated short positions (shares)
optional double aggregatedShortRatio = 6; // Short ratio of shares outstanding; value before the percent sign, e.g. 12.34 means 12.34%
}
message S2C
{
repeated UsShortInterestItem usItemList = 1; // US short interest data list
repeated HkShortInterestItem hkItemList = 2; // HK short interest data list
optional string nextKey = 3; // Pagination key; "-1" means no more data
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, see Common.RetType
optional string retMsg = 2; // Return message
optional int32 errCode = 3; // Error code
optional S2C s2c = 4;
}
1
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
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
- API call result: see RetType
Protocol ID
3249
uint GetShortInterest(QotGetShortInterest.Request req);
virtual void OnReply_GetShortInterest(MMAPI_Conn client, uint nSerialNo, QotGetShortInterest.Response rsp);
Description
Get short interest data
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock
optional string nextKey = 2; // Pagination key; leave empty for first request; pass previous nextKey to continue; "-1" means no more data
optional int32 num = 3; // Page size, default 10, range 1~50
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
- Security structure: see Security
- Return
message S2C
{
repeated UsShortInterestItem usItemList = 1; // US short interest data list
repeated HkShortInterestItem hkItemList = 2; // HK short interest data list
optional string nextKey = 3; // Pagination key; "-1" means no more data
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, see Common.RetType
optional string retMsg = 2; // Return message
optional int32 errCode = 3; // Error code
optional S2C s2c = 4;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
- API call result: see 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();
QotGetShortInterest.C2S c2s = QotGetShortInterest.C2S.CreateBuilder()
.SetSecurity(sec)
.Build();
QotGetShortInterest.Request req = QotGetShortInterest.Request.CreateBuilder().SetC2S(c2s).Build();
uint seqNo = qot.GetShortInterest(req);
Console.Write("Send QotGetShortInterest: {0}\n", seqNo);
}
public void OnDisconnect(MMAPI_Conn client, long errCode)
{
Console.Write("Qot onDisConnect: {0}\n", errCode);
}
public void OnReply_GetShortInterest(MMAPI_Conn client, uint nSerialNo, QotGetShortInterest.Response rsp)
{
Console.Write("Reply: QotGetShortInterest: {0} {1}\n", nSerialNo, rsp.ToString());
}
public static void Main(String[] args)
{
MMAPI.Init();
Program qot = new Program();
qot.Start();
while (true)
Thread.Sleep(1000 * 600);
}
}
1
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
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
sent seqNo=3
retType: 0
retMsg: ""
errCode: 0
s2c {
hkItemList {
timestamp: 1777478400
timestampStr: "2026-04-30"
closePrice: 467.8
lastClosePrice: 479.2
aggregatedShort: 51480638
aggregatedShortRatio: 0.56
}
hkItemList {
//...
}
nextKey: "1772121600"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
int getShortInterest(QotGetShortInterest.Request req);
void onReply_GetShortInterest(MMAPI_Conn client, int nSerialNo, QotGetShortInterest.Response rsp);
Description
Get short interest data
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock
optional string nextKey = 2; // Pagination key; leave empty for first request; pass previous nextKey to continue; "-1" means no more data
optional int32 num = 3; // Page size, default 10, range 1~50
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
- Security structure: see Security
- Return
message S2C
{
repeated UsShortInterestItem usItemList = 1; // US short interest data list
repeated HkShortInterestItem hkItemList = 2; // HK short interest data list
optional string nextKey = 3; // Pagination key; "-1" means no more data
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, see Common.RetType
optional string retMsg = 2; // Return message
optional int32 errCode = 3; // Error code
optional S2C s2c = 4;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
- API call result: see 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();
QotGetShortInterest.C2S c2s = QotGetShortInterest.C2S.newBuilder()
.setSecurity(sec)
.build();
QotGetShortInterest.Request req = QotGetShortInterest.Request.newBuilder().setC2S(c2s).build();
int seqNo = qot.getShortInterest(req);
System.out.printf("Send QotGetShortInterest: %d\n", seqNo);
}
@Override
public void onDisconnect(MMAPI_Conn client, long errCode) {
System.out.printf("Qot onDisConnect: %d\n", errCode);
}
@Override
public void onReply_GetShortInterest(MMAPI_Conn client, int nSerialNo, QotGetShortInterest.Response rsp) {
if (rsp.getRetType() != 0) {
System.out.printf("QotGetShortInterest failed: %s\n", rsp.getRetMsg());
}
else {
try {
String json = JsonFormat.printer().print(rsp);
System.out.printf("Receive QotGetShortInterest: %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) {
}
}
}
}
1
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
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
Qot onInitConnect: ret=0 desc= connID=7459212718233353666
Send Qot_GetShortInterest: 2
Receive Qot_GetShortInterest: retType: 0
retMsg: ""
errCode: 0
s2c {
hkItemList {
timestamp: 1777478400
timestampStr: "2026-04-30"
closePrice: 467.8
lastClosePrice: 479.2
aggregatedShort: 51480638
aggregatedShortRatio: 0.56
}
hkItemList {
//...
}
nextKey: "1772121600"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
moomoo::u32_t GetShortInterest(const Qot_GetShortInterest::Request &stReq);
virtual void OnReply_GetShortInterest(moomoo::u32_t nSerialNo, const Qot_GetShortInterest::Response &stRsp) = 0;
Description
Get short interest data
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock
optional string nextKey = 2; // Pagination key; leave empty for first request; pass previous nextKey to continue; "-1" means no more data
optional int32 num = 3; // Page size, default 10, range 1~50
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
- Security structure: see Security
- Return
message S2C
{
repeated UsShortInterestItem usItemList = 1; // US short interest data list
repeated HkShortInterestItem hkItemList = 2; // HK short interest data list
optional string nextKey = 3; // Pagination key; "-1" means no more data
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, see Common.RetType
optional string retMsg = 2; // Return message
optional int32 errCode = 3; // Error code
optional S2C s2c = 4;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
- API call result: see 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;
// construct request message
Qot_GetShortInterest::Request req;
Qot_GetShortInterest::C2S *c2s = req.mutable_c2s();
Qot_Common::Security *sec = c2s->mutable_security();
sec->set_code("00700");
sec->set_market(Qot_Common::QotMarket::QotMarket_HK_Security);
m_pQotApi->GetShortInterest(req);
cout << "GetShortInterest" << endl;
}
virtual void OnReply_GetShortInterest(moomoo::u32_t nSerialNo, const Qot_GetShortInterest::Response &stRsp){
cout << "OnReply_GetShortInterest:" << endl;
// print response
// ProtoBufToBodyData and UTF8ToLocal refer to tool.h in Samples
string resp_str;
ProtoBufToBodyData(stRsp, resp_str);
cout << UTF8ToLocal(resp_str) << endl;
}
protected:
MMAPI_Qot *m_pQotApi;
};
int32_t main(int32_t argc, char** argv)
{
MMAPI::Init();
{
Program program;
program.Start();
getchar();
}
protobuf::ShutdownProtobufLibrary();
MMAPI::UnInit();
return 0;
}
1
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
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
- Output
onInitConnect: ret=0 desc=Succeed!
Send Qot_GetShortInterest seqNo=3
retType: 0
retMsg: ""
errCode: 0
s2c {
hkItemList {
timestamp: 1777478400
timestampStr: "2026-04-30"
closePrice: 467.8
lastClosePrice: 479.2
aggregatedShort: 51480638
aggregatedShortRatio: 0.56
}
hkItemList {
//...
}
nextKey: "1772121600"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
GetShortInterest(req);
Description
Get short interest data
Parameters
message C2S
{
required Qot_Common.Security security = 1; // Stock
optional string nextKey = 2; // Pagination key; leave empty for first request; pass previous nextKey to continue; "-1" means no more data
optional int32 num = 3; // Page size, default 10, range 1~50
}
message Request
{
required C2S c2s = 1;
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
- Security structure: see Security
- Return
message S2C
{
repeated UsShortInterestItem usItemList = 1; // US short interest data list
repeated HkShortInterestItem hkItemList = 2; // HK short interest data list
optional string nextKey = 3; // Pagination key; "-1" means no more data
}
message Response
{
required int32 retType = 1 [default = -400]; // Return result, see Common.RetType
optional string retMsg = 2; // Return message
optional int32 errCode = 3; // Error code
optional S2C s2c = 4;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
- API call result: see RetType
- Example
import mmWebsocket from "moomoo-api";
import { Common, Qot_Common } from "moomoo-api/proto";
import beautify from "js-beautify";
function QotGetShortInterest(){
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.GetShortInterest(req)
.then((res) => {
let { errCode, retMsg, retType,s2c } = res
console.log("GetShortInterest: 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);
setTimeout(()=>{
websocket.stop();
console.log("stop");
}, 5000);
}
1
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
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
- Output
GetShortInterest: errCode 0, retMsg , retType 0
{
"hkItemList": [{
"timestamp": "1777478400",
"timestampStr": "2026-04-30",
"closePrice": 467.8,
"lastClosePrice": 479.2,
"aggregatedShort": "51480638",
"aggregatedShortRatio": 0.56
//...
}],
"nextKey": "1772121600"
}
stop
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
Restrictions
- Maximum 30 requests per 30 seconds.
- Supports HK and US equities and funds.