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 三. 委託傳送...8 1 下單 FUNCTION...8 1.1 傳入值...8 1.2 MSGXML...9 2 下單 FUNCTION( 組合單 )...10 2.1 傳入值...10 2.2 MSGXML...11 3 刪 / 改單 FUNCTION...12 3.1 傳入值...12 3.2 MSGXML...12 四. 事件 EVENT...13 1 委託 / 成交主動回報 EVENT 定義...13 1.1 Event.bsData 定義...13 1.2 OP Code 定義...14 2 回報伺服器狀態主動通知 EVENT 定義...15 2.1 Event.nStatus 定義...15 五. 查詢...16 1 委託回報查詢 FUNCTION...16 1.1 傳入值...16 1.2 MSGXML...16 2 成交回報查詢 FUNCTION...19 2.1 傳入值...19 2.2 MSGXML...19 3 版本查詢 FUNCTION...20 2

4 API 連線主機查詢 FUNCTION...20 5 交易日查詢 FUNCTION...21 5.1 傳入值...21 5.2 MSGXML...21 六. 錯誤代碼表...22 七. 商品代碼表...23 3

一.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: 期貨 } Credit Y/N 可否信用交易 ( 證 ) Key 客戶下單所需要帶的參數 Creator 登入者 ID Underwriting 申購合約 Y/N 4

IOrder 智慧單合約 Y/N CLSID 認證憑證的元件名稱 CAID CASubject( 給 client 找 CA 用 ) CAKey CAVerifyKey( 驗章 Key) VerifyCA 是否需要憑證下單 InitParam optional parameter to initialize this CA component Message 定義一段 HTML, 當 client 端收到這個欄位, 會在登入後 顯示這個 HTML, 用意是通知客戶 CA 的申請 ( 尚未申 請 ), 展期 ( 即將過期 / 已經過期 ), or 其他動作 ( 更換 CA) 等狀態 InitSignString optional string, 如果不是空白的話, client 會登入後馬 上做簽章檢查的動作 5

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

二. 憑證函式 1 認證 Function Function 說明 AddPreSignData(ByVal lpcszpid As String, 認證憑證 ByVal lpcszpwd As String, ByVal lpcszfile 取得憑證存放路徑與檔案進行認證 As String) As Boolean 若是 EC 的憑證, 需將憑證匯入 IE 個人憑證中 ( 粗略判斷 :EC 的檔案只有一個 ) 回傳值 false 為失敗,true 為成功 1.1 傳入值 型態 變數名稱 備註 String lpcszpid CA 的身份證 String lpcszpwd CA 的密碼 String lpcszfile CA 的檔案 ( 完整路徑 + 檔案名稱 ) 7

三. 委託傳送 1 下單 Function Function 說明 修改變數 eforder(byval MsgKey_ As String, ByVal TDate As String, ByVal ProductType As String, ByVal CommID As String, ByVal CommID_EP As String, ByVal CommID_YM As String, ByVal CommID_CP As String, ByVal BS As String, ByVal PriceType As String, ByVal Price As String, ByVal Qty As String, ByVal Offset As String, ByVal Cond As String, ByRef MSGXML As String) As Long 委託輸入傳入值進行委託 MSGXML 委託時給予空值 MSGXML 回傳值負值為失敗, 其餘成功, 失敗請參考錯誤代碼表 1.1 傳入值 型態 變數名稱 備註 String MsgKey 分公司 + 帳號 (F026000995XXXX), 可由登入後 MSGXML 讀取的到 String TDate 交易日, 可以為空字串 String ProductType 商品別 { 0: 期貨 1: 選擇權 } String CommID 商品代碼 String CommID_EP 參考價 ( 期貨為空白 ) String CommID_YM 年月 (EX. 200901) String CommID_CP C 代表 Call;P 代表 Put ( 期貨為空白 ) String BS 買賣別 { B: 買進 S: 賣出 } String PriceType 價位別 { 0: 限價 4: 市價 } String Price 委託價格 ( 市價為空白 ) String Qty 口數 String Offset 倉別 { 0: 新倉 1: 平倉 2: 自動倉 4: 當沖 } String Cond 委託別 { R: ROD F: FOK I: IOC } 8

1.2 MSGXML Title 說明 Mode 模式 { 0: 兩段式下單 1: 一段式下單 } AID 帳號 ( 前面包含 FBID + BID) TDate 交易日 OID 網路單流水號 OrderNo 委託書號 ProductType 期貨 (0) 選擇權 (1) 選擇權複式單 (2) 期貨複式單 (3) CommID 商品代碼 (Trade ID) BS 商品買賣別 CommID2 商品代碼 2 ( 複式單 ) BS2 商品買賣別 2 ( 複式單 ) PriceType 價位別 { 0: 限價 4: 市價 } Price 委託價格 CreateTime 委託時間 : YYYYMMDD HHmmSS Cond 委託別 { R: ROD F: FOK I: IOC } Offset 倉別 { 0: 新倉 1: 平倉 2: 自動倉 4: 當沖 } Qoriginal 原委託口數 Qcurrent 改量後委託口數 Qmatched 成交口數 ConfirmTime 委託回報時間 : HHmmSS Code 系統錯誤代碼 (Server 端 ) CodeMsg Code Message CanCancel Y/N 可否刪單 CanModify Y/N 可否改量 Source 電子單 / 現場單 / OrgID 複式單原商品代碼 ( 後端組合單代碼 ) IsPreOrder Y: 預約單, N: 盤中單 AvgPrice 成交均價 UpdateTime 異動時間 State 委託單狀態 (0. 收到 9. 交易所回覆失敗 10. 成功 20 改量 30 刪除 50 全部成交 90. 委託失敗, 若為 0 時表示預收 單 ) StateMsg 委託單狀態訊息 9

2 下單 Function( 組合單 ) Function 說明修改變數 eforder_2(byval MsgKey_ As String, ByVal 組合單委託 MSGXML TDate As String, ByVal ProductType As 輸入傳入值進行委託 String, ByVal CommID As String, ByVal MSGXML 委託時給予空值 CommID_EP As String, ByVal CommID_YM As String, ByVal CommID_CP As String, ByVal BS As String, ByVal PriceType As String, ByVal Price As String, ByVal Qty As String, ByVal Offset As String, ByVal Cond As String, ByVal CommID2 As String, ByVal CommID_EP2 As String, ByVal CommID_YM2 As String, ByVal CommID_CP2 As String, ByVal BS2 As String, ByRef MSGXML As String) As Long 回傳值負值為失敗, 其餘成功, 失敗請參考錯誤代碼表 2.1 傳入值 型態 變數名稱 備註 String MsgKey 分公司 + 帳號 (F026000995XXXX), 可由登入後 MSGXML 讀取的到 String TDate 交易日 String ProductType 商品別 { 2: 選擇權組合單 3: 期貨組合單 } String CommID 商品代碼 String CommID_EP 參考價 ( 期貨為空白 ) String CommID_YM 年月 (EX. 200901) String CommID_CP C 代表 Call;P 代表 Put ( 期貨為空白 ) String BS 買賣別 { B: 買進 S: 賣出 } String PriceType 價位別 { 0: 限價 4: 市價 } String Price 委託價格 ( 市價為空白 ) String Qty 口數 String Offset 倉別 { 0: 新倉 1: 平倉 2: 自動倉 4: 當沖 } String Cond 委託別 { R: ROD F: FOK I: IOC } 10

String CommID2 商品代碼 String CommID_EP2 參考價 ( 期貨為空白 ) String CommID_YM2 年月 (EX. 200901) String CommID_CP2 C 代表 Call;P 代表 Put ( 期貨為空白 ) 應檢查輸入之合法性 2.2 MSGXML 同下單 MSGXML 11

3 刪 / 改單 Function Function 說明 修改變數 efmodifyorder(byval MsgKey_ As String, ByVal Type_ As String, ByVal OID As 刪單 / 改單輸入傳入值進行刪 / 改單 MSGXML String, ByVal OrderNo As String, ByVal Qty MSGXML 委託時給予空值 As String, ByVal ProductType As String, ByVal Qcurrent As String, ByVal Qmatch As String, ByVal PreOrder As String, ByRef MSGXML As String) As Long 回傳值負值為失敗, 其餘成功, 失敗請參考錯誤代碼表 3.1 傳入值 型態 變數名稱 備註 String MsgKey 分公司 + 帳號 (F026000995XXXX), 可由登入後 MSGXML 讀取的到 String Type_ 修改別 { 0: 改單 1: 刪單 } String OID 網路單流水號 String OrderNo 委託書號 String Qty 刪減口數 String ProductType 商品別 { 0: 期貨 1: 期權 2: 期權組合單 3: 期貨組合單 } String Qcurrent 有效口數 String Qmatch 成交口數 String PreOrder 是否為預掛單 { 0: 是 1: 否 } 3.2 MSGXML 同下單 MSGXML 12

四. 事件 Event 1 委託 / 成交主動回報 Event 定義 Event OnInstantData( ) 說明當委託 / 成交時產生 bsmsgid 為期權 (TFE00) bsmsgkey 為分公司 + 帳號 (F026000995XXXX) bsdata 為主動訊息 1.1 Event.bsData 定義 欄位 長度 ( 總長 125 bytes) 內容 1 argroup 2 04: 期權格式 (TFE00) 2 cprodtype 1 期貨 'F'/ 選擇權 'O' 3 arop 2 OP Code ( 如下委託 / 成交主動回報 OP Code 說明 ) 4 arbrokerid 7 分公司代碼 5 artradeid 7 帳號 6 arorderno] 5 委託書號 7 cbuysell 1 B/S 8 cordertype 1 市價 'M'/ 限價 'L' 9 corderkind 1 委託條件 : FOK'F'/IOC'I'/ROD'R', 唯市價不支援 ROD 10 copencode 1 開平倉碼, 開倉 '0'/ 平倉 '1'/ 當沖 '2', ( 當沖僅適用期貨 ) 11 arcommid1 10 商品代號 1 12 cbs1 1 買賣別 1, B/S 13 arprice1 10 價位 1, S9(6)V9(3) : 複式單委託, 為價差 / 價和 14 arcommid2 10 商品代號 2 15 cbs2 1 買賣別 2, B/S 16 arprice2 10 價位 2, S9(6)V9(3) : 以上 3 個欄位只用在複式單 17 arqty 4 數量 : 改量 : 更改後數量, 刪單 : 取消數量, 均不含 成交 18 arqtybefore 4 改量前 (only valid for 改量 ): 改量前數量, 均不含成 交 19 ardate 8 委託 / 成交日期, YYYYMMDD 13

20 artime 6 委託 / 成交時間, HHMMSS 21 arsales 3 營業員 22 cdatasrc 1 交易管道平台 23 armatchno 8 交易所成交序號 24 arseqno 8 網路流水號同 OID 25 arerror 13 錯誤代碼, 請參考錯誤代碼表 1.2 OP Code 定義 說明 02 預約失敗 11 委託成功 12 委託失敗 21 刪單成功 22 刪單失敗 31 改量成功 32 改量失敗 40 成交 14

2 回報伺服器狀態主動通知 Event 定義 Event OnStatus( ) 說明當回報伺服器狀態異動時產生 bsmsgid 為期權 (TFE00) bsmsgkey 為分公司 + 帳號 (F026000995XXXX) nstatus 為主動訊息 2.1 Event.nStatus 定義 說明 100 回報伺服器登入登入成功 101 回報伺服器連線連線正常 200 回報伺服器連線連線異常 201 回報伺服器連線連線關閉 202 回報伺服器登入失敗 204 回報伺服器重新連線 205 回報伺服器連線警告 300 回報伺服器系統內部錯誤 15

五. 查詢 1 委託回報查詢 Function Function 說明 修改變數 efqueryall(byval MsgKey_ As String, ByRef MSGXML As String) As Long 手動查詢委託狀態輸入傳入值進行查詢 MSGXML 委託時給予空值 MSGXML 回傳值負值為失敗, 其餘成功, 失敗請參考錯誤代碼表 1.1 傳入值 型態變數名稱備註 String MsgKey 分公司 + 帳號 (F026000995XXXX), 可由登入後 MSGXML 讀取的到 1.2 MSGXML Title 說明 AID 帳號 ( 前面包含 FBID + BID) TDate 交易日 OID 網路單流水號 OrderNo 委託書號 ProductType 期貨 (0) 選擇權 (1) 選擇權複式單 (2) 期貨複式單 (3) CommID 商品代碼 (Trade ID) CommName 商品名稱 BS 商品買賣別 B 買 / S 賣 /OB 沖買 /OS 沖賣 CommID2 商品代碼 2 ( 複式單 ) CommName2 商品名稱 2 BS2 商品買賣別 2 ( 複式單 ) PriceType 價位別 { 0: 限價 4: 市價 } Price 委託價格 CreateTime 委託時間 : YYYYMMDD HHmmSS 16

Cond 委託別 { R: ROD F: FOK I: IOC } Offset 倉別 { 0: 新倉 1: 平倉 2: 自動倉 4: 當沖 } Qoriginal 原委託口數 Qcurrent 改量後委託口數 Qmatched 成交口數 ConfirmTime 委託回報時間 : HHmmSS Code 系統錯誤代碼 (Server 端 ) CodeMsg Code Message CanCancel Y/N 可否刪單 CanModify Y/N 可否改量 Source 電子單 / 現場單 / OrgID 複式單原商品代碼 ( 後端組合單代碼 ) IsPreOrder Y: 預約單, N: 盤中單 AvgPrice 成交均價 UpdateTime 異動時間 State 委託單狀態 (0. 收到 9. 交易所回覆失敗 10. 成功 20 改量 30 刪除 50 全部成交 90. 委託失敗, 若為 0 時表示預收 單 ) StateMsg 委託單狀態訊息 LastStatus 最後委託單狀態 (0. 收到 9. 交易所回覆失敗 10. 成功 20 改量 30 刪除 50 全部成交 90. 委託失敗, 若為 0 時表示 預收單 ) Closed 'Y' 收盤 Detail 回報部分用 <Detail> <Subrow /> <Subrow /> </Detail> append 在委託回報的 childnode 改單 / 刪單 Sub Row: Title Action CreateTime Qcurrent Qcancel ODID 說明 3: 改 / 4: 刪委託時間 : YYYYMMDD HHmmSS 改量後委託口數取消口數刪改編號 17

成交 Sub Row: Title 說明 Action 5 OMID 對應的委託書號 TDate 交易日 OID 網路單流水號 OrderNo 委託書號 ProductType 期貨 (0) 選擇權 (1) 選擇權複式單 (2) 期貨複式單 (3) CommID 商品 1 代碼 ( 交易所回報 ID) BS 商品 1 買賣別 PriceMatch 成交價格 QtyMatch 成交數量 CommID2 商品 2 代碼 ( 複式單 ) BS2 商品 2 買賣別 ( 複式單 ) PriceMatch2 成交價格 2 ( 複式單 ) QtyMatch2 成交數量 2 ( 複式單 ) CreateTime 委託時間 : YYYYMMDD HHmmSS MatchTime HHmmSS Fee 手續費 Tax 交易稅 Currency 幣別 18

2 成交回報查詢 Function Function 說明 修改變數 efmatch(byval MsgKey_ As String, ByRef MSGXML As String) As Long 手動查詢成交狀態輸入傳入值進行查詢 MSGXML 委託時給予空值 MSGXML 回傳值負值為失敗, 其餘成功, 失敗請參考錯誤代碼表 2.1 傳入值 型態變數名稱備註 String MsgKey 分公司 + 帳號 (F026000995XXXX), 可由登入後 MSGXML 讀取的到 2.2 MSGXML Title 說明 TDate 交易日 OMID 對應的委託書號 OID 網路單流水號 OrderNo 委託書號 ProductType 期貨 (0) 選擇權 (1) 選擇權複式單 (2) 期貨複式單 (3) Offset 倉別 ( 0: 新倉 /1: 平倉 /2: 自動倉 /4: 當沖 ) CommID 商品代碼 (Trade ID) CommName 商品名稱 BS 商品買賣別 B 買 / S 賣 /OB 沖買 /OS 沖賣 PriceMatch 成交價格 QtyMatch 成交數量 CommID2 商品代碼 2 ( 複式單 ) CommName2 商品名稱 2 BS2 商品買賣別 2 ( 複式單 ) PriceMatch2 成交價格 2 ( 複式單 ) QtyMatch2 成交數量 2 ( 複式單 ) CreateTime 委託時間 : YYYYMMDD HHmmSS MatchTime HHmmSS 19

Fee Tax Currency 手續費 交易稅 幣別 富邦期貨 API 說明書 V1.0 3 版本查詢 Function Function 說明回傳值 eshowversion() As String API 版本查詢 EX. 0.0.0.9 4 API 連線主機查詢 Function Function 說明 回傳值 eshowreg_server_ip(byval Kind As API 連線主機查詢 EX. E01API.fbs.com.tw String) As String 20

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

六. 錯誤代碼表 代碼 說明 -100002 使用者未登入 -100001 內部元件錯誤 -100000 元件錯誤 -99999 登入與帳號不符 -99998 簽章失敗 -99997 網路異常 (Timer OUT) -99996 商品錯誤 -99995 價格有誤 -99994 數量有誤 -99993 倉別有誤 -99992 委託方式有誤 -99991 刪改方式有誤 (Type 0: 改單 /1: 刪單 ) -99990 刪改方式有誤 (OID) -99989 刪改方式有誤 (OrderNo) -99988 刪改方式有誤 (Qty 刪減口數 ) -99987 ' 刪改方式有誤 (ProductType 0: 期貨,1: 選擇權,2: 選擇 權複式,3: 期貨複式 ) -99986 刪改方式有誤 (Qcurrent 有效張數 -99985 刪改方式有誤 (Qmatch 成交張數 ) -99984 刪改方式有誤 (PreOrder 0/1 ) 22

七. 商品代碼表 富邦期貨 API 說明書 V1.0 代碼小型臺指期貨電子期貨金融期貨黃金期貨臺股期貨非金電期貨櫃買選擇權電子選擇權金融選擇權黃金選擇權臺指選擇權非金電選擇權 商品 MXF EXF FXF GDF TXF XIF GTO TEO TFO TGO TXO XIO 23