SubscribeWatchlist / UnSubscribeWatchlist
行情報價表訂閱(指定欄位)/ 行情報價表解訂閱(指定欄位)
bool SubscribeWatchlist(LoginAcno, LstWatchlist, Lng)
bool UnSubscribeWatchlist(LoginAcno, LstWatchlist, Lng)
回傳:
| Type | Description |
|---|---|
| bool | True:此功能執行成功;False:此功能執行異常(結果請從回應事件 OnResponse 接收) |
Input Parameters
| Name | Type | Description | Memo |
|---|---|---|---|
| LoginAcno | string | 訂閱帳號 | 證券:S + 分公司代號(4) + 帳號(7) 例如:S98875005091 期貨:F + 分公司代號(7+3) + 帳號(7) 例如:FF021000P001234567 |
| LstWatchlist | List<Watchlist> | 訂閱商品清單 | |
| Lng | enumLangType | 語系 | 參考列舉物件-語系 預設為 Normal- Normal:Big5 - UTF8:UTF8 - SC:簡體中文 |
Watchlist 行情報價表(指定欄位)物件
| Name | Type | Description | Memo |
|---|---|---|---|
| IndexFlag | enumQuoteIndexType | 訂閱報價欄位 | 參考列舉物件-訂閱索引值類別 |
| MarketType | enumMarketType | 市場類別 | 參考列舉物件-市場類別 |
| StockCode | string | 商品代碼 |
Output Parameters
WatchListResult 行情報價表訂閱(指定欄位)回傳結果
| Name | Type | Description | Memo |
|---|---|---|---|
| Key | string | 鍵值 | IndexFlag + MarketNo + StkCode(不足補 0) |
| MarketType | enumMarketType | 市場類別 | 參考列舉物件-市場類別 |
| StkCode | string | 股票代碼 | |
| IndexFlag | enumQuoteIndexType | 索引值 | 參考列舉物件-訂閱索引值類別 |
| Value | double | 資料值 | 此值定義請參考IndexFlag IndexFlag=買價 市價買:999999999 IndexFlag=賣價 市價賣:-999999999 IndexFlag=單量 最高位元的Bit,表示內/外盤的旗標,0-內盤/1-外盤 IndexFlag=delay一秒的成交價 海外股無此資料,請使用索引值=7的成交價 IndexFlag=瞬間價格趨勢 10:一般揭示 12:暫緩撮合且瞬間趨漲 13:試算後延後收盤 14:暫停交易 15:恢復交易 16:試算後延後開盤 IndexFlag=交易狀態 0x00:初始狀態 0x01:收單階段 0x02:不可刪單階段 0x03:集合競價階段 IndexFlag=試撮量 最高位元的Bit,表示內/外盤的旗標, 0:內盤/1:外盤 |
範例
引用元件
import os, time, datetime, struct, pathlib, sys
from datetime import datetime
from pathlib import Path
from pythonnet import load
load("coreclr")
import clr, System
##透過Clr引用系統標準函式
clr.AddReference('System.Collections')
from System.Collections.Generic import List
##宣告增加模組、DLL的路徑(windows可抓取當前路徑 Linux跟MAC需指定路徑)
sys.path.append(Path(pathlib.Path(__file__).parent.resolve()))
if sys.platform == "win32":
os.add_dll_directory(Path(pathlib.Path(__file__).parent.resolve()))
##透過Clr引用YuantaSparkAPI.dll
##pythonnet引用元件不用加附檔名
try:
clr.AddReference("YuantaSparkAPI")
except Exception as e:
print(f"Error loading YuantaSparkAPI: {e}")
from YuantaOneAPI import YuantaSparkAPITrader, enumLogType, enumQuoteIndexType, enumMarketType, enumEnvironmentMode, Watchlist
# 建立 API 物件
objYuantaSparkAPI = YuantaSparkAPITrader()
objYuantaSparkAPI.SetLogType(enumLogType.COMMON)
using System;
using System.Collections.Generic;
using System.Text;
using System.Threading;
using YuantaOneAPI;
YuantaSparkAPITrader objYuantaSparkAPI = new YuantaSparkAPITrader();
string Account = "FF0210132243219588";
string Password = "abcd123";
enumEnvironmentMode enumEvenMode = enumEnvironmentMode.UAT;
objYuantaSparkAPI.OnResponse += objApi_OnResponse;
objYuantaSparkAPI.SetLogType(enumLogType.ALL);
objYuantaSparkAPI.Open(enumEvenMode);
Thread.Sleep(1000);
objYuantaSparkAPI.Login(Account, Password);
Thread.Sleep(1000);
List<Watchlist> lstWatchlist = new List<Watchlist>();
Watchlist stkInfo = new Watchlist
{
IndexFlag = (enumQuoteIndexType)7,
MarketType = enumMarketType.TAIFEX,
StockCode = "TXF8"
};
lstWatchlist.Add(stkInfo);
objYuantaSparkAPI.SubscribeWatchlist(Account, lstWatchlist);
Thread.Sleep(2000);
Onresponse
def on_response(intMark, dwIndex, strIndex, objHandle, objValue):
try:
result = ''
match intMark:
case 0: # 系統回應資訊
result = str(objValue)
case 1: # 查詢回應資訊
match strIndex:
case 'Login':
loginResult = objValue
status = loginResult.LoginStatus
strMsgCode = status.MsgCode # 訊息代碼
strMsgContent = status.MsgContent # 訊息內容
intCount = status.Count # 筆數
result = '{0},{1},帳號筆數:{2}\r\n'.format(strMsgCode,strMsgContent, str(intCount))
if strMsgCode == '0001' or strMsgCode == '00001' or intCount > 0 :
for i in objValue.LoginList:
result += f"{i.Account},{i.Name},{i.InvestorID},{i.SellerNo}\n"
case 2: # 訂閱回應資訊
match strIndex:
case 'SubscribeWatchlist':
# Watchlist指定欄位結果
wResult = objValue
result += 'Watchlist指定欄位結果:\r\n'
result += '{0},{1},{2},{3},{4}\r\n'.format(wResult.Key,str(wResult.MarketType),wResult.StkCode,str(wResult.IndexFlag),str(wResult.Value))
if result:
print('##================================================##\n')
print(result)
except Exception as error:
print(f"處理回應時發生錯誤: {error}")
objYuantaSparkAPI.OnResponse += on_response
#測試環境帳號:UAT 正式環境:PROD
objYuantaSparkAPI.Open(enumEnvironmentMode.UAT)
time.sleep(2)
objYuantaSparkAPI.Login('S98875005091', '1234')
time.sleep(2)
watchlist = List[Watchlist]()
watch = Watchlist()
watch.IndexFlag = enumQuoteIndexType(7)
watch.MarketType = enumMarketType.TWSE
watch.StockCode = '2330'
watchlist.Add(watch)
#行情報價表訂閱(指定欄位)
objYuantaSparkAPI.SubscribeWatchlist('S98875005091',watchlist)
#測試環境傳送後要休息一下
time.sleep(2)
# 保持程式運行
while True:
time.sleep(1)
void objApi_OnResponse(int intMark, uint dwIndex, string strIndex, object objHandle, object objValue)
{
string strResult = "";
try
{
if (intMark == 0)
{
Console.WriteLine(Convert.ToString(objValue));
return;
}
if (intMark == 1)
{
if (strIndex == "Login")
{
var result = (LoginResult)objValue;
string strMsgCode = result.LoginStatus.MsgCode;
string strMsgContent = result.LoginStatus.MsgContent;
int intCount = result.LoginStatus.Count;
strResult += $"{strMsgCode}, {strMsgContent}{Environment.NewLine}";
if (strMsgCode == "0001" || strMsgCode == "00001")
{
strResult += $"帳號筆數: {intCount.ToString()}{Environment.NewLine}";
result.LoginList.ForEach(r => strResult += $"{r.Account},{r.Name},{r.InvestorID},{r.SellerNo}\r\n");
}
else
{
Account = "";
}
Console.WriteLine("\n======================");
Console.WriteLine(strResult.ToString());
Console.WriteLine("======================\n");
return;
}
}
if (intMark == 2)
{
if (strIndex == "SubscribeWatchlist")
{
var result = (WatchListResult)objValue;
try
{
strResult += "WatchList指定欄位訂閱結果: \r\n";
strResult += $"{result.Key},{result.MarketType},{result.StkCode},{result.IndexFlag}:{result.Value}\r\n";
}
catch
{
strResult = "";
}
Console.WriteLine("\n======================");
Console.WriteLine(strResult);
Console.WriteLine("======================\n");
return;
}
Console.WriteLine($"[{strIndex}] {Convert.ToString(objValue)}");
return;
}
}
catch (Exception exc)
{
Console.WriteLine("OnResponse Error: " + exc.Message);
}
}
Response Body
{
"Result": {
"Key": "2330",
"MarketType": "TWSE",
"StkCode": "2330",
"IndexKey": "114801086501",
"Values": ["1527", "1652"]
}
}