RestApi協議

不限合約,可查行情和歷史。支持合約查詢
密鑰信息和次數消耗明細:這裏查詢
代碼範例:下載範例

單個合約行情查詢

查詢單個合約行情,可以帶出最新交易明細,可以帶出當前k線
命令
地址:http://map.fxnapi.com:10002/queryrm/single
方法:GET
認證:設置請求頭 Authorization=密鑰Token或從QueryString傳遞,參考
請求參數:
名稱類型必填備註
symbolstring完整代碼如HKEXHSI2212,請參考品種合約代碼信息查詢
withticksint是否帶出最新交易明細(默認0否,1是)
withksint是否帶出當前k線數據(默認0否,1是)
請求範例
http://map.fxnapi.com:10002/queryrm/single?symbol=EURUSD&withticks=0&withks=0
http://map.fxnapi.com:10002/queryrm/single?symbol=EURUSD&withticks=0&withks=0&token=密鑰
輸出
名稱類型備註
CodeintCode>=0為成功
Msgstring錯誤描述
Objdata object輸出数据結構參考
輸出範例
{"Code":0,"Msg":"","Obj":{"TS":"1561417986,6.87330,2,0;1561417987,6.87330,2,0;1561418227,6.87340,1,1;1561418227,6.87340,2,0;1561418227,6.87352,1,1;1561418237,6.87349,1,-1;1561418239,6.87349,1,0;1561418246,6.87347,1,-1;1561418255,6.87346,1,-1;1561418261,6.87344,1,-1;1561418273,6.87341,1,-1;1561418279,6.87339,1,-1;1561418286,6.87360,1,1;1561418287,6.87350,3,-1;1561418347,6.87360,1,1","N":"","M":"","S":"USDCNH","C":"","FS":"USDCNH","P":6.87360,"NV":0,"Tick":1561418347,"B1":6.87360,"B2":0,"B3":0,"B4":0,"B5":0,"B1V":0,"B2V":0,"B3V":0,"B4V":0,"B5V":0,"S1":6.87570,"S2":0,"S3":0,"S4":0,"S5":0,"S1V":0,"S2V":0,"S3V":0,"S4V":0,"S5V":0,"ZT":0,"DT":0,"O":6.87558,"H":6.87558,"L":6.87118,"YC":6.87432,"A":0,"V":369,"OV":0,"IV":0,"SY":0.000,"SJ":0,"HS":0,"ZS":0,"LS":0,"Z":0.00,"Z2":0.00,"VF":0.064,"ZF":-0.010,"JS":0,"YJS":0,"HD":0,"YHD":0,"AVP":0,"A1":""}}

多個合約行情查詢

查詢多個指定品種合約行情,最多10個
命令
地址:http://map.fxnapi.com:10002/queryrm/multiple
方法:GET
認證:設置請求頭 Authorization=密鑰Token或從QueryString傳遞,參考
請求參數:
名稱類型必填備註
symbolsstring多個完整代碼逗號鏈接如SH600138,BTC,USDCNH, 請參考品種合約代碼信息查詢
請求範例
http://map.fxnapi.com:10002/queryrm/multiple?symbols=BTC,EURUSD,USDJPY
http://map.fxnapi.com:10002/queryrm/multiple?symbols=BTC,EURUSD,USDJPY&token=密鑰
輸出:
名稱類型備註
CodeintCode>=0為成功
Msgstring錯誤描述
Objarray為輸出實體數組 實體結構參考
輸出範例
{"Code":0,"Msg":"","Obj":[{行情1},{行情2},{行情3}]}

合約分頁搜索查詢

按分頁查詢品種合約行情,每頁最多10個
命令
地址:http://map.fxnapi.com:10002/queryrm/search
方法:GET
認證:設置請求頭 Authorization=密鑰Token或從QueryString傳遞,參考
請求參數:
名稱類型必填備註
wherestring模糊關鍵字,拼音首字母/代碼等
psint頁大小
pint頁碼
sortstring排序字段,字段參考
sorttypeint0升序,1降序(默認0)
請求範例
http://map.fxnapi.com:10002/queryrm/search?rout=&p=1&ps=10&market=&where=abc&sort=&sorttype=
http://map.fxnapi.com:10002/queryrm/search?rout=&p=1&ps=10&market=&where=abc&sort=&sorttype=&token=密鑰
輸出:
名稱類型備註
CodeintCode>=0為成功
Msgstring錯誤描述
Objarray為輸出實體數組 實體結構參考
輸出範例
{"Code":0,"Msg":"","Obj":[{行情1},{行情2},{行情3}]}

歷史k線-按分頁(輸出Json)

排序是從當前往歷史方向排,第一頁是當前處,可包含最新動態k線數據。接口輸出的日週期數據最多最近10年,1分鐘週期數據最多最近30天,5分鐘及小時週期最多最近180天
命令
地址:http://map.fxnapi.com:10002/querykm/jsonbypage
方法:GET
認證:設置請求頭 Authorization=密鑰Token或從QueryString傳遞,參考
請求參數:
名稱類型必填備註
symbolstring完整代碼如BTC, 請參考品種合約代碼信息查詢
periodstring週期 支持 1M,3M,5M,10M,15M,30M,1H,2H,4H,D,(部分品種無W,M)
pidxint頁碼
psizeint頁大小,每頁最多500個數據
withlastint是否帶出當前動態k線數據(默認0否,1是),第一頁有效
請求範例
http://map.fxnapi.com:10002/querykm/jsonbypage?symbol=BTC&period=D&pidx=1&psize=100&withlast=0
http://map.fxnapi.com:10002/querykm/jsonbypage?symbol=BTC&period=D&pidx=1&psize=100&withlast=0&token=密鑰
輸出:
名稱類型備註
CodeintCode>=0為成功
Msgstring錯誤描述
Objstring為K線數據Json數組 [{"C":收,"Tick":秒時間戳,"O":開,"H":高,"L":低,"A":額,"V":量}...]
輸出範例
{"Code":0,"Msg":"","Obj":[{"C":27696.84,"Tick":1679241600,"O":27554.25,"H":28472.00,"L":27124.47,"A":14889767035.22,"V":533099.58},{"C":27549.17,"Tick":1679155200,"O":27227.48,"H":27750.00,"L":26578.00,"A":8588080273.79,"V":316148.14}...]}

歷史k線-按時間範圍(輸出Json)

排序是從開始時間往結束時間方向排。接口輸出的日週期數據最多最近10年,1分鐘週期數據最多最近30天,5分鐘及小時週期最多最近180天
命令
地址:http://map.fxnapi.com:10002/querykm/jsonbytimeframe
方法:GET
認證:設置請求頭 Authorization=密鑰Token或從QueryString傳遞,參考
請求參數:
名稱類型必填備註
symbolstring完整代碼如BTC, 請參考品種合約代碼信息查詢
periodstring週期 支持 1M,3M,5M,10M,15M,30M,1H,2H,4H,D,(部分品種無W,M)
dateststring開始時間
dateedstring結束時間
withlastint是否帶出當前動態k線數據(默認0否,1是),dateed大於等於當前時間時有效
請求範例
http://map.fxnapi.com:10002/querykm/jsonbytimeframe?symbol=BTC&period=D&datest=2019-05-01 12:00:00&dateed=2019-05-02 12:00:00&withlast=0
http://map.fxnapi.com:10002/querykm/jsonbytimeframe?symbol=BTC&period=D&datest=2019-05-01 12:00:00&dateed=2019-05-02 12:00:00&withlast=0&token=密鑰
輸出:
名稱類型備註
CodeintCode>=0為成功
Msgstring錯誤描述
Objstring為K線數據Json數組 [{"C":收,"Tick":秒時間戳,"O":開,"H":高,"L":低,"A":額,"V":量}...]
輸出範例
{"Code":0,"Msg":"","Obj":[{"C":27696.84,"Tick":1679241600,"O":27554.25,"H":28472.00,"L":27124.47,"A":14889767035.22,"V":533099.58},{"C":27549.17,"Tick":1679155200,"O":27227.48,"H":27750.00,"L":26578.00,"A":8588080273.79,"V":316148.14}...]}

歷史k線-取最新(輸出Json)

返回最多20個最新k數據
命令
地址:http://map.fxnapi.com:10002/querykm/jsonbylast
方法:GET
認證:設置請求頭 Authorization=密鑰Token或從QueryString傳遞,參考
請求參數:
名稱類型必填備註
symbolstring完整代碼如BTC, 請參考品種合約代碼信息查詢
periodstring週期 支持 1M,3M,5M,10M,15M,30M,1H,2H,4H,D,(部分品種無W,M)
fromtickint開始時間點
請求範例
http://map.fxnapi.com:10002/querykm/jsonbylast?symbol=BTC&period=D&fromtick=0
http://map.fxnapi.com:10002/querykm/jsonbylast?symbol=BTC&period=D&fromtick=0&token=密鑰
輸出:
名稱類型備註
CodeintCode>=0為成功
Msgstring錯誤描述
Objstring為K線數據Json數組 [{"C":收,"Tick":秒時間戳,"O":開,"H":高,"L":低,"A":額,"V":量}...]
輸出範例
{"Code":0,"Msg":"","Obj":[{"C":27696.84,"Tick":1679241600,"O":27554.25,"H":28472.00,"L":27124.47,"A":14889767035.22,"V":533099.58},{"C":27549.17,"Tick":1679155200,"O":27227.48,"H":27750.00,"L":26578.00,"A":8588080273.79,"V":316148.14}...]}

輸出結構和錯誤代碼

結構
{"Code":1,"Msg":"","Obj":任意類型 }
名稱類型備註
CodeintCode>=0為成功
Msgstring錯誤描述
Obj任意類型
説明
Code >= 0,調用成功,Obj是json數組或對象,是否有數據要看輸出;如果Obj是數組,則Code代表結果總條數
Code <0 表示調用失敗,並輸出錯誤信息 Msg 失敗提示

K線實體結構參考

名稱類型備註
Cdecimal收盤價
Ticklong標準時間戳
Dstring交易日yyyy-MM-dd(日週期以上輸出)
Odecimal開盤價
Hdecimal最高
Ldecimal最低
Adecimal交易額
Vdecimal交易量

密鑰token的傳遞方式

1.密鑰token可以通過get參數傳遞, get設置的token優先httpheader設置的token
比如在瀏覽器裏直接測試 http://map.fxnapi.com:10002/queryrm/single?symbol=EURUSD&token=密鑰
2.密鑰token可以通過 http header 傳遞, key:Authorization, value:密鑰