Rest Api プロトコル

契約に限らず、相場や歴史を調べることができる。サポートされる契約照会
鍵情報と回数消費の詳細:ここのクエリ

単一相場照会

単一品種契約相場を調べると、最新の取引明細を持ち出すことができ、現在のk線を持ち出すことができる
コマンド#コマンド#
呼び出し先:http://map.fxnapi.com:10002/queryrm/single
メソッド:GET
資格認定:要求ヘッダの設定 Authorization=AuthCodeまたはQueryStringから転送,参照
Requestパラメータ:
の名前をあげるデータ型必須コメント
symbolstringyes完全なコードは次のとおりですHKEXHSI2212,参照してください品種契約コード情報照会
withticksintno最新の取引明細を持ち出すかどうか(デフォルト0いいえ,1はい)
withksintno現在のk線データを持ち出すかどうか(デフォルト0いいえ,1はい)
Request Sample
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=AuthCode
Response:
の名前をあげるデータ型コメント
Codeintcode>=0で成功
Msgstringエラーメッセージ
Objdata object実体構造の参考
Response Sample
{"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=AuthCodeまたはQueryStringから転送,参照
Requestパラメータ:
の名前をあげるデータ型必須コメント
symbolsstringyes複数の完全コードカンマ接続 H600138,BTC,USDCNH,参照
Request Sample
http://map.fxnapi.com:10002/queryrm/multiple?symbols=BTC,EURUSD,USDJPY
http://map.fxnapi.com:10002/queryrm/multiple?symbols=BTC,EURUSD,USDJPY&token=AuthCode
Response:
の名前をあげるデータ型コメント
Codeintcode>=0で成功
Msgstringエラーメッセージ
Objarray出力エンティティ配列である 実体構造の参考
Response Sample
{"Code":0,"Msg":"","Obj":[{Model1},{Model2},{Model3}]}

相場リストページング照会

銘柄契約の相場をページ別に調べると、1ページあたり最大10個
コマンド#コマンド#
呼び出し先:http://map.fxnapi.com:10002/queryrm/search
メソッド:GET
資格認定:要求ヘッダの設定 Authorization=AuthCodeまたはQueryStringから転送,参照
Requestパラメータ:
の名前をあげるデータ型必須コメント
wherestringyesオプション,ファジィキーワード、ピンインの頭文字/コードなど
psintyesページサイズ
pintyesページ番号
sortstringnoソートフィールドフィールド参照
sorttypeintno0昇順,1降順(デフォルト 0)
Request Sample
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=AuthCode
Response:
の名前をあげるデータ型コメント
Codeintcode>=0で成功
Msgstringエラーメッセージ
Objarray出力エンティティ配列である 実体構造の参考
Response Sample
{"Code":0,"Msg":"","Obj":[{Model1},{Model2},{Model3}]}

履歴k線-改ページ別(しゅつりょくJson)

ソートは現在から履歴方向に、最初のページは現在で、最新の動的k線データを含めることができます。日サイクルデータは最大10年、1分サイクルデータは最大30日、5分、および時間サイクルは最大180日
コマンド#コマンド#
呼び出し先:http://map.fxnapi.com:10002/querykm/jsonbypage
メソッド:GET
資格認定:要求ヘッダの設定 Authorization=AuthCodeまたはQueryStringから転送,参照
Requestパラメータ:
の名前をあげるデータ型必須コメント
symbolstringyes完全なコードは次のとおりですBTC,参照してください品種契約コード情報照会
periodstringyesサポート 1M,3M,5M,10M,15M,30M,1H,2H,4H,D,(部分的にはないかもしれませんW,M)
pidxintyesページ番号
psizeintyesページサイズ,1ページあたり最大500データ
withlastintnoオプション,現在の動的k線データを持ち出すかどうか(デフォルト0いいえ,1はい),1ページ目有効
Request Sample
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=AuthCode
Response:
の名前をあげるデータ型コメント
Codeintcode>=0で成功
Msgstringエラーメッセージ
ObjstringKData 文字列であり [{"C":収,"Tick":秒タイムスタンプ,"O":開,"H":高,"L":低,"A":額,"V":量}...]
Response Sample
{"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=AuthCodeまたはQueryStringから転送,参照
Requestパラメータ:
の名前をあげるデータ型必須コメント
symbolstringyes完全なコードは次のとおりですBTC,参照してください品種契約コード情報照会
periodstringyesサポート 1M,3M,5M,10M,15M,30M,1H,2H,4H,D,(部分的にはないかもしれませんW,M)
dateststringyes開始時間
dateedstringyes終了時間
withlastintno現在の動的k線データを持ち出すかどうか(デフォルト0いいえ,1はい),dateedが現在の時刻以上の場合に有効
Request Sample
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=AuthCode
Response:
の名前をあげるデータ型コメント
Codeintcode>=0で成功
Msgstringエラーメッセージ
ObjstringKData 文字列であり [{"C":収,"Tick":秒タイムスタンプ,"O":開,"H":高,"L":低,"A":額,"V":量}...]
Response Sample
{"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)

最新のkデータを最大20個返す
コマンド#コマンド#
呼び出し先:http://map.fxnapi.com:10002/querykm/jsonbylast
メソッド:GET
資格認定:要求ヘッダの設定 Authorization=AuthCodeまたはQueryStringから転送,参照
Requestパラメータ:
の名前をあげるデータ型必須コメント
symbolstringyes完全なコードは次のとおりですBTC,参照してください品種契約コード情報照会
periodstringyesサポート 1M,3M,5M,10M,15M,30M,1H,2H,4H,D,(部分的にはないかもしれませんW,M)
fromticklongyes開始時点
Request Sample
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=AuthCode
Response:
の名前をあげるデータ型コメント
Codeintcode>=0で成功
Msgstringエラーメッセージ
ObjstringKData 文字列であり [{"C":収,"Tick":秒タイムスタンプ,"O":開,"H":高,"L":低,"A":額,"V":量}...]
Response Sample
{"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エラーメッセージ
Objany
説明
Code >= 0,呼び出しは成功し、Objはjson配列またはオブジェクトであり、データがあるかどうかは出力次第である。Objが配列である場合、Codeは結果の合計本数を表します
Code <0 呼び出しに失敗したことを示し、エラーメッセージMsgを出力する

K線ソリッド構造リファレンス

の名前をあげるデータ型コメント
Cdecimal終値
Ticklong標準時間戳
Dstring取引日yyyy-MM-dd(日周期以上出力)
Odecimal寄り付き相場
Hdecimal最高価格
Ldecimal最低価格
Adecimal成約金額
Vdecimal出来高

鍵トークンの渡し方

1.AuthCodeはgetパラメータを介して渡すこともでき、get設定のtoken優先httpheader設定のtoken
例えばブラウザで直接テストする http://map.fxnapi.com:10002/queryrm/single?symbol=EURUSD&token=*authcode*
2.鍵tokenはhttp headerを介して渡すことができ、key:Authorization,value:鍵