一.API 連線登入 ( 不含主動回報 )FUNCTION 傳入值 MSGXML 登入 ( 含主動回報 )FUNCTION 傳入值 MSGXML 登出 FUNCTION...6 二. 委託傳送...

Size: px

Start display at page:

Download "一.API 連線登入 ( 不含主動回報 )FUNCTION 傳入值 MSGXML 登入 ( 含主動回報 )FUNCTION 傳入值 MSGXML 登出 FUNCTION...6 二. 委託傳送..."

桐詹
5 years ago
Views:

1 富邦證券 OCX API 規格說明書 1

2 一.API 連線登入 ( 不含主動回報 )FUNCTION 傳入值 MSGXML 登入 ( 含主動回報 )FUNCTION 傳入值 MSGXML 登出 FUNCTION...6 二. 委託傳送下單 FUNCTION 傳入值 MSGXML 刪 / 改單 FUNCTION 傳入值 MSGXML...12 三. 事件 EVENT 委託 / 成交主動回報 EVENT 定義 Event.bsData 定義 OP Code 定義回報伺服器狀態主動通知 EVENT 定義 Event.nStatus 定義...14 四. 查詢委託回報查詢 FUNCTION 傳入值 MSGXML 成交回報查詢 FUNCTION 傳入值

3 2.2 MSGXML 即時庫存查詢 FUNCTION 傳入值 MSGXML 版本查詢 FUNCTION API 連線主機查詢 FUNCTION 交易日查詢 FUNCTION 傳入值 MSGXML...20 五. 錯誤代碼表

4 一. API 連線 1 登入 ( 不含主動回報 )Function Function 說明修改變數 elogin(byval login_id As String, 登入 ( 不含主動回報 ) MSGXML ByVal login_pass As String, ByRef MSGXML As String) As Long 回傳值負值為失敗, 其餘成功, 失敗請參考錯誤代碼表 1.1 傳入值型態變數名稱備註 String login_id 客戶 ID String login_pass 交易密碼 String MSGXML 空值即可 1.2 MSGXML Title 說明 FBID 證券商代號 BID(IBNO) 分公司代號 AID 帳號 ( 前面包含 FBID + BID) Name 帳戶名稱 ID 身分證 ID NeedNewPWD 需修改密碼 Disp-aid UI 顯示帳號 Type 帳號種類 { S: 證券 F: 期貨 } Creator 登入者 ID IApi Y/N 可否使用 API 功能 CLSID 認證憑證的元件名稱 CAKey CAVerifyKey( 驗章 Key) 4

5 InitParam Message parameter to initialize this CA component 定義一段 HTML, 當 client 端收到這個欄位, 會在登入後顯示這個 HTML, 用意是通知客戶 CA 的申請 ( 尚未申請 ), 展期 ( 即將過期 / 已經過期 ), or 其他動作 ( 更換 CA) 等狀態 5

6 2 登入 ( 含主動回報 )Function Function 說明修改變數 elogin_msgserv (ByVal login_id As String, ByVal login_pass As String, ByVal ObjMsgServ As Variant, ByRef MSGXML As String) As Long 登入 ( 含主動回報功能 ) MSGXML 回傳值負值為失敗, 其餘成功, 失敗請參考錯誤代碼表 2.1 傳入值型態變數名稱備註 String login_id 客戶 ID String login_pass 交易密碼 Variant ObjMsgServ 傳入訊息回報物件, 接收主動回報 String MSGXML 空值即可 2.2 MSGXML 同登入 ( 不含主動回報 ) 之 MSGXML 3 登出 Function Function 說明修改變數 elogout() As Long 登出回傳值負值為失敗, 其餘成功, 失敗請參考錯誤代碼表 6

7 二. 委託傳送 1 下單 Function Function 說明修改變數 eorder (ByVal MsgKey_ As String, ByVal TT As String, ByVal OT As String, ByVal BS As String, ByVal stockid As String, ByVal Qty As String, ByVal PriceType As String, ByVal Price As String, ByRef MSGXML As String ) As Long 委託輸入傳入值進行委託 MSGXML 委託時給予空值 MSGXML 回傳值負值為失敗, 其餘成功, 失敗請參考錯誤代碼表 1.1 傳入值型態變數名稱備註 String MsgKey 分公司 + 帳號 ( XXXX), 可由登入後 MSGXML 讀取的到 String TT 盤別 {0: 普通 1: 零股 2: 盤後 } String OT 交易別 {0: 現股 1: 融資 2: 融券 22: 先賣 } String BS 買賣別 {B: 買進 S: 賣出 } String stockid 股票代碼 String Qty 普通 & 盤後 ( 張數 ) 零股 ( 股數 ) String PriceType 價位別 {0: 限價 1: 漲停 2: 跌停 3: 平盤 } String Price 委託價格 ( 市價為空白 ) 1.2 MSGXML 7

8 Title OID AID CreateTime Tdate TT OT Closed BS StockID Qoriginal Price PriceType OrderNo Qcurrent Qnext Qmatched ConfirmTime Code CodeMsg CanCancel CanModify Source IsPreOrder AvgPrice 說明網路單流水號帳號 ( 前面包含 FBID + BID) 委託時間 : YYYYMMDD HHmmSS YYYYMMDD 0: 普通 / 1: 零股 / 2: 盤後 0: 現股 / 1: 融資 / 2: 融券 / 22: 先賣 Y for 收盤買 ( B ), 賣 ( S ), 超買 ( MB ), 超賣 ( MS ) 股票代碼原始張 / 股數 Real price 0: 限價 / 1: 漲停 / 2: 跌停 / 3: 平盤委託書號修改後張 / 股數欲修改張 / 股數成交數量委託回報時間 : HHmmSS 系統錯誤代碼 (Server 端 ) Code Message Y/N 可否刪單 Y/N 可否改量來源別 : 電子單 / 現場單 / Y: 預約單, N: 盤中單成交均價 8

9 UpdateTime State StateMsg 異動時間委託單狀態 (0. 收到 9. 交易所回覆失敗 10. 成功 20 量 30 刪除 50 全部成交 90. 委託失敗, 若為 0 時表示預收單 ) 委託單狀態訊息 2 刪 / 改單 Function Function 說明修改變數 9

10 emodifyorder( ByVal MsgKey_ As String, ByVal Type_ As String, ByVal TT As String, ByVal OT As String, ByVal OID As String, ByVal OrderNo As String, ByVal stockid As String, ByVal BS As String, ByVal Qty As String, ByVal Qcurrent As String, ByVal Qmatch As String, ByVal PreOrder As String, ByRef MSGXML As String) As Long 刪單 / 改單輸入傳入值進行刪 / 改單 MSGXML 委託時給予空值 MSGXML 回傳值負值為失敗, 其餘成功, 失敗請參考錯誤代碼表 2.1 傳入值型態變數名稱備註 String MsgKey 分公司 + 帳號 ( XXXX), 可由登入後 MSGXML 讀取的到 String Type_ 修改別 { 0: 改單 1: 刪單 } String TT 盤別 {0: 普通 1: 零股 2: 盤後 } String OT 交易別 {0: 現股 1: 融資 2: 融券 22: 先賣 } String OID 網路單流水號 String OrderNo 委託書號 String stockid 股票代碼 String BS 買賣別 {B: 買進 S: 賣出 } String Qty 刪減口數 String Qcurrent 有效口數 String Qmatch 成交口數 String PreOrder 是否為預掛單 { 0: 是 1: 否 } 10

11 2.2 MSGXML 同下單 MSGXML 三. 事件 Event 1 委託 / 成交主動回報 Event 定義 11

12 Event OnInstantData( ) 說明當委託 / 成交時產生 bsmsgid 為證券 (TWEMG00) bsmsgkey 為分公司 + 帳號 ( XXXX) bsdata 為主動訊息 1.1 Event.bsData 定義欄位長度 ( 總長 100 bytes) 內容 1 argroup 2 03: 證券格式 (TWEMG00) 2 arop 2 OP Code ( 如下委託 / 成交主動回報 OP Code 說明 ) 3 arbrokerid 4 分公司代碼 4 artradeid 7 帳號 5 arorderno 5 委託書號 6 ctt 1 盤別 { 普通 '0'/ 零股 '2'/ 盤後 '3'} 7 cot 1 交易別 { 現股 '0'/ 融資 '3'/ 融券 '4'} 8 arprodid 6 股票代號 9 arprice 8 價位 : 9(6)V9(2) 10 cpt 1 限價 '0'/ 漲停價 '1'/ 跌停價 '2'/ 平盤價 '3'/ 市價 '4'/ 超限價 '5' 11 cbs 1 買賣別, B/S 12 arqty 8 數量 { 改量 : 更改後數量 / 刪單 : 取消數量, 均不含成交 } 13 arqtybefore 8 改量前 (only valid for 改量 ): 改量前數量, 均不含成交 14 ardate 8 委託 / 成交日期, YYYYMMDD 15 artime 6 委託 / 成交時間, HHMMSS 16 arsales 3 營業員 17 cdatasrc 1 交易管道平台 18 armatchno 8 交易所成交序號 19 arseqno 8 網路流水號同 OID 20 csettletype 1 '1' 餘額交割 /'2' 逐筆交割 21 arrbrokerid 4 推薦券商代號 22 arerror 7 錯誤代碼, 請參考錯誤代碼表 1.2 OP Code 定義 12

13 說明 02 預約失敗 11 委託成功 12 委託失敗 21 刪單成功 22 刪單失敗 31 改量成功 32 改量失敗 40 成交回傳值為固定長度的純字串 ( 含逗點 ) 非 XML 字串 2 回報伺服器狀態主動通知 Event 定義 Event OnStatus( ) 說明當回報伺服器狀態異動時產生 bsmsgid 為證券 (TWEMG00) bsmsgkey 為分公司 + 帳號 ( XXXX) nstatus 為主動訊息 2.1 Event.nStatus 定義說明 100 回報伺服器登入成功 101 回報伺服器連線正常 200 回報伺服器連線異常 201 回報伺服器連線詉閉 202 回報伺服器登入失敗 204 回報伺服器重新連線 205 回報伺服器連線警告 300 回報伺服器系統內部錯誤四. 查詢 1 委託回報查詢 Function 13

14 Function 說明修改變數 equeryall(byval MsgKey_ As String, 手動查詢委託狀態 MSGXML 輸入傳入值進行查詢 ByVal TT As String, MSGXML 委託時給予空值 ByRef MSGXML As String) As Long 回傳值負值為失敗, 其餘成功, 失敗請參考錯誤代碼表 1.1 傳入值型態變數名稱備註 String MsgKey String TT 1.2 MSGXML Title OID AID CreateTime TDate TT OT Closed BS StockID Qoriginal Price PriceType OrderNo Qcurrent 分公司 + 帳號 ( XXXX), 可由登入後盤別 {0: 上市上櫃 : 全部 } 說明網路單流水號帳號 ( 前面包含 FBID + BID) 委託時間 : YYYYMMDD HHmmSS YYYYMMDD 0: 普通 / 1: 零股 / 2: 盤後 0: 現股 / 1: 融資 / 2: 融券 Y for 收盤買 ( B ), 賣 ( S ), 超買 ( MB ), 超賣 ( MS ) 股票代碼原始張 / 股數委託價格 0: 限價 / 1: 漲停 / 2: 跌停 / 3: 平盤委託書號修改後張 / 股數 14

15 Qnext Qmatched ConfirmTime Code CodeMsg CanCancel CanModify Source IsPreOrder PayType PromoteBroker AvgPrice UpdateTime State 欲修改張 / 股數成交數量委託回報時間 : HHmmSS 系統錯誤代碼 (Server 端 ) Code Message Y/N 可否刪單 Y/N 可否改量來源別 : 電子單 / 現場單 / Y: 預約單, N: 盤中單 0: 餘額交割 / 1: 逐筆交割 (for 興櫃 ) 推薦券商 (for 興櫃 ) 成交均價異動時間委託單狀態 (0. 收到 9. 交易所回覆失敗 10. 成功 20 改量 30 刪除 50 全部成交 90. 委託失敗, 若為 0 時表示預收單 ) LastStatus StateMsg 委託單狀態訊息最後委託單狀態 (0 收到 9 交易所回覆失敗 10 成功 20 改量 30 刪除 50 全部成交 90 委託失敗, 若為 0 時表示預 Detail 回報部分用收單 ) <Detail> <Subrow /> <Subrow /> </Detail> append 在委託回報的 childnode 改單 / 刪單 Sub Row: 15

16 Title Action CreateTime Qcurrent Qcancel ODID 成交 Sub Row: Title Action OMID OID OrderNo AID CreateTime TT OT BS StockID Price Qmatched TDate MatchTime Fee Tax 說明 3: 改 / 4: 刪委託時間 : YYYYMMDD HHmmSS 改量後委託口數取消口數刪改編號說明 5 對應的委託書號交易日網路單流水號帳號 ( 前面包含 FBID + BID) 委託時間 YYYYMMDD HHmmSS 0: 普通 / 1: 零股 / 2: 盤後 / 5: 興櫃 0: 現股 / 1: 融資 / 2: 融券買 ( B ), 賣 ( S ) 股票代碼成交價格成交數量交易日 YYYYMMDD HHmmSS 手續費交易稅 2 成交回報查詢 Function 16

17 Function 說明修改變數 ematch(byval MsgKey_ As String, 手動查詢成交狀態 MSGXML 輸入傳入值進行查詢 ByVal TT As String, MSGXML 委託時給予空值 ByRef MSGXML As String) As Long 回傳值負值為失敗, 其餘成功, 失敗請參考錯誤代碼表 2.1 傳入值型態變數名稱備註 String MsgKey 分公司 + 帳號 ( XXXX), 可由登入後 String TT 盤別 {0: 普通 1: 零股 2: 盤後 } 2.2 MSGXML Title OMID OID OrderNo AID CreateTime TT OT BS StockID Price Qmatched TDate MatchTime Fee Tax 說明對應的委託書號交易日網路單流水號帳號 ( 前面包含 FBID + BID) 委託時間 YYYYMMDD HHmmSS 0: 普通 / 1: 零股 / 2: 盤後 0: 現股 / 1: 融資 / 2: 融券買 ( B ), 賣 ( S ) 股票代碼成交價格成交數量交易日 YYYYMMDD HHmmSS 手續費交易稅 17

18 3 即時庫存查詢 Function Function 說明修改變數 ertposition(byval MsgKey As String, ByRef MSGXML As String) As Long 手動查詢即時庫存狀態輸入傳入值進行查詢 MSGXML 委託時給予空值 MSGXML 回傳值負值為失敗, 其餘成功, 失敗請參考錯誤代碼表 3.1 傳入值型態變數名稱備註 String MsgKey 分公司 + 帳號 ( XXXX), 可由登入後 MSGXML 讀取的到 3.2 MSGXML Title 說明 StockID 股票代碼 StockName 股票名稱 TT 0: 普通 / 5: 興櫃 Qty0Info1 集保 / 興櫃昨日庫存 ( 股數 ) Qty0Info2 集保 / 興櫃今日委託買進 Qty0Info3 集保 / 興櫃今日委託賣出 Qty0Info4 集保 / 興櫃今日成交買進 Qty0Info5 集保 / 興櫃今日成交賣出 Qty1Info1 融資昨日庫存 ( 股數 ) Qty1Info2 融資今日委託買進 Qty1Info3 融資今日委託賣出 Qty1Info4 融資今日成交買進 Qty1Info5 融資今日成交賣出 Qty2Info1 融券昨日庫存 ( 股數 ) Qty2Info2 融券今日委託買進 Qty2Info3 融券今日委託賣出 Qty2Info4 融券今日成交買進 18

19 Qty2Info5 融券今日成交賣出 Qty3Info1 零股昨日庫存 ( 股數 ) Qty3Info2 零股今日委託買進 Qty3Info3 零股今日委託賣出 Qty3Info4 零股今日成交買進 Qty3Info5 零股今日成交賣出 4 版本查詢 Function Function 說明回傳值 eshowversion() As String API 版本查詢 EX API 連線主機查詢 Function Function 說明回傳值 eshowreg_server_ip(byval Kind As API 連線主機查詢 E01API.fbs.com.tw String) As String ( 暫定 ) 6 交易日查詢 Function Function 說明修改變數 19

20 etdate(byval Type_Kind As String, ByRef 交易日查詢 TradeDate As String, ByRef MSGXML As String) As Long 回傳值負值為失敗, 其餘成功, 失敗請參考錯誤代碼表 MSGXML TradeDate 6.1 傳入值型態變數名稱備註 String Type_Kind ''( 空字串 ): 全 'F': 期貨 'S': 證券 6.2 MSGXML Title TDate TT LastTDate NextTDate TradeTime HaltTime State NextState NextChangTime 說明交易日 0: 普通 1: 零股 2: 盤後 3: 期權最近交易日次交易日目前盤中交易時間暫停交易時間目前狀態 : 0: 盤中 / 1: 預約 / 2: 暫停下次狀態 0: 盤中 / 1: 預約 / 2: 暫停下次更改時間 Type S( 股票 )/F( 期權 ) 五. 錯誤代碼表代碼說明 20

21 線上已被其他登入系統忙碌中, 請稍後再試 ( 無權使用 ) 無申請 API( 無權使用 ) 此元件版本使用最大時間使用者未登入內部元件錯誤元件錯誤登入與帳號不符簽章失敗網路異常 (Timer OUT) 商品錯誤價格有誤數量有誤倉別有誤委託方式有誤刪改方式有誤 (Type 0: 改單 /1: 刪單 ) 刪改方式有誤 (OID) 刪改方式有誤 (OrderNo) 刪改方式有誤 (Qty 刪減口數 ) 刪改方式有誤 (ProductType 0: 期貨,1: 選擇權,2: 選擇權複式,3: 期貨複式 ) 刪改方式有誤 (Qcurrent 有效張數刪改方式有誤 (Qmatch 成交張數 ) 刪改方式有誤 (PreOrder 0/1 ) 第一次登入時必須重設密碼, 請利用他管道系統修改密碼 21

22 盤別有誤現股 / 融資 / 融券有誤買賣別誤商品代碼有誤張 ( 股 ) 數有誤價格別有誤價格值有誤價格跳動點有誤回傳錯誤代碼長度值為四碼 ( < X <-999 ), 即為 Server 端回傳錯誤碼 22

2

富邦期貨 OCX API 規格說明書 1 一.API 連線...4 1 登入 ( 不含主動回報 )FUNCTION...4 1.1 傳入值...4 1.2 MSGXML...4 2 登入 ( 含主動回報 )FUNCTION...6 2.1 傳入值...6 2.2 MSGXML...6 3 登出 FUNCTION...6 二. 憑證函式...7 1 認證 FUNCTION...7 1.1 傳入值...7

一.API 連線 登入 ( 不含主動回報 )FUNCTION 傳入值 MSGXML 登入 ( 含主動回報 )FUNCTION 傳入值 MSGXML 登出 FUNCTION...6 二. 委託傳送...

一.API 連線登入 ( 不含主動回報 )FUNCTION 傳入值 MSGXML 登入 ( 含主動回報 )FUNCTION 傳入值 MSGXML 登出 FUNCTION...6 二. 委託傳送...