fcoin_ruby_client 0.1.0

data/examples/cli/rest_api.md

@@ -0,0 +1,149 @@
+# REST API CLI
+
+In development, please use the `./bin/fcoin`.<br>
+In Actual, please use the `bundle exec fcoin`.
+
+## All
+```bash
+$ ./bin/fcoin
+Commands:
+  fcoin account         # Get Account Information
+  fcoin help [COMMAND]  # Describe available commands or one specific command
+  fcoin locale          # Locale Setting
+  fcoin market          # Get Market Information
+  fcoin order           # Operate Order
+  fcoin public          # Get Public Information
+  fcoin subscribe       # Subscribe topic
+  fcoin validation      # Validation Setting
+  fcoin version         # Print Version
+
+```
+
+__If you want to validate__
+
+```bash
+$ # For more settings
+$ # @see https://github.com/yukihirop/fcoin_ruby_client#validation
+$ ./bin/fcoin validation init --path ./config
+      create
+      create  my_settings.yml
+$ export VALIDATION_SETTING_PATH='/path/to/your/my_settings.yml'
+```
+
+## Public
+```bash
+$ ./bin/fcoin public
+Commands:
+  fcoin public currencies      # Display available currency
+  fcoin public help [COMMAND]  # Describe subcommands or one specific subcommand
+  fcoin public server_time     # Get server time
+  fcoin public symbols         # Query available transaction pairs
+
+```
+
+```bash
+$ # Get server time
+$ ./bin/fcoin public server_time
+{"status":0,"data":1533311785257}
+$
+$ # Display available currency
+$ ./bin/fcoin public currencies
+{"status":0,"data":["btc","eth","bch","ltc","eos","usdt","ft_frozen","ft","zip","etc","omg","btm","zrx","xrp","bnb","gtc","fi","zil","icx","ae","777","gus","cccx","banca","pra","dcc","sss","mdt","tst","pmd","rte","xps","tct","dws","ngot","at","soc","blz","ocn","datx","let","dag","yee","aaa","nc","ait","arp","gram","tbcoin","ifood","hpc","sgcc","lxt","3db","drink1","drink","drct","ionc","xmx","rct","cit","ees","fair","brm","sda","cbr","tkt","vct","biz","show","pai","sec","lovc","mst","iov","ejoy","iht","iic","fbc","fota","dagt","wte","tos","oas","fres","gene","maya","mesh","icc","scl","cofi","but","zsc","jac","vns","aidoc","ccc","fuel","edu","beauty","mof","dta","cps","msc","latx","dscoin","dscb","boc","18t","newos","mxm","idxe","pnt","vpp","lmm","rnt","hotc","fff","dht","fbee","vlc","wicc","mot","bcv","baic","ruff","ink","ges","sac","see","dpn","smt","musk","ptt","mith","lth","wmch","cwv","jll","bhpc","unc","int","insur","pun","facc","osch","uto","btmc","cnmc","fcandy","dacc","fti","bbc","orme","tcash","mitx","pok","icst","gu","iota","ft1808","ft1810_i","zpr","nrc","kan","dac","eai","ifish","tat","you","win","fish","box","cosm","loom","kcash","rrc","olt","agi","kora","skm","bto","uuu","gse","bft","abt","mds","ors","vaac","lba","knc","gto","bfdt","est","gnx","iost","hpb","xin","cai","tac","risk","vnt","vboom","ugc","ole","bkbt","cpc","qos"]}
+$
+$ # Query available transaction pairs
+$ ./bin/fcoin public symbols
+{"status":0,"data":[{"name":"btcusdt","base_currency":"btc","quote_currency":"usdt","price_decimal":2,"amount_decimal":4},{"name":"ethusdt","base_currency":"eth","quote_currency":"usdt","price_decimal":2,"amount_decimal":4},{"name":"bchusdt","base_currency":"bch","quote_currency":"usdt","price_decimal":2,"amount_decimal":4},{"name":"ltcusdt","base_currency":"ltc","quote_currency":"usdt","price_decimal":2,"amount_decimal":4},{"name":"ftusdt","base_currency":"ft","quote_currency":"usdt","price_decimal":6,"amount_decimal":2},{"name":"fteth","base_currency":"ft","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"zipeth","base_currency":"zip","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"etcusdt","base_currency":"etc","quote_currency":"usdt","price_decimal":2,"amount_decimal":4},{"name":"ftbtc","base_currency":"ft","quote_currency":"btc","price_decimal":8,"amount_decimal":2},{"name":"omgeth","base_currency":"omg","quote_currency":"eth","price_decimal":6,"amount_decimal":4},{"name":"btmusdt","base_currency":"btm","quote_currency":"usdt","price_decimal":4,"amount_decimal":2},{"name":"zrxeth","base_currency":"zrx","quote_currency":"eth","price_decimal":6,"amount_decimal":2},{"name":"bnbusdt","base_currency":"bnb","quote_currency":"usdt","price_decimal":4,"amount_decimal":2},{"name":"zipusdt","base_currency":"zip","quote_currency":"usdt","price_decimal":6,"amount_decimal":2},{"name":"xrpusdt","base_currency":"xrp","quote_currency":"usdt","price_decimal":4,"amount_decimal":2},{"name":"fieth","base_currency":"fi","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"fiusdt","base_currency":"fi","quote_currency":"usdt","price_decimal":6,"amount_decimal":2},{"name":"icxeth","base_currency":"icx","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"zileth","base_currency":"zil","quote_currency":"eth","price_decimal":6,"amount_decimal":4},{"name":"aeeth","base_currency":"ae","quote_currency":"eth","price_decimal":6,"amount_decimal":2},{"name":"777eth","base_currency":"777","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"guseth","base_currency":"gus","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"cccxeth","base_currency":"cccx","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"bancaeth","base_currency":"banca","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"praeth","base_currency":"pra","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"dcceth","base_currency":"dcc","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"ssseth","base_currency":"sss","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"mdteth","base_currency":"mdt","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"tsteth","base_currency":"tst","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"pmdeth","base_currency":"pmd","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"rteeth","base_currency":"rte","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"xpseth","base_currency":"xps","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"tcteth","base_currency":"tct","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"dwseth","base_currency":"dws","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"ngoteth","base_currency":"ngot","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"ateth","base_currency":"at","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"soceth","base_currency":"soc","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"blzeth","base_currency":"blz","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"ocneth","base_currency":"ocn","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"datxeth","base_currency":"datx","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"gtceth","base_currency":"gtc","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"leteth","base_currency":"let","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"dageth","base_currency":"dag","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"yeeeth","base_currency":"yee","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"aaaeth","base_currency":"aaa","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"nceth","base_currency":"nc","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"aiteth","base_currency":"ait","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"arpeth","base_currency":"arp","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"grameth","base_currency":"gram","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"ifoodeth","base_currency":"ifood","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"hpceth","base_currency":"hpc","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"sgcceth","base_currency":"sgcc","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"3dbeth","base_currency":"3db","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"xmxeth","base_currency":"xmx","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"rcteth","base_currency":"rct","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"citeth","base_currency":"cit","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"eeseth","base_currency":"ees","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"faireth","base_currency":"fair","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"brmeth","base_currency":"brm","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"sdaeth","base_currency":"sda","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"cbreth","base_currency":"cbr","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"tkteth","base_currency":"tkt","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"vcteth","base_currency":"vct","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"bizeth","base_currency":"biz","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"showeth","base_currency":"show","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"paieth","base_currency":"pai","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"ioveth","base_currency":"iov","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"ihteth","base_currency":"iht","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"fotaeth","base_currency":"fota","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"ejoyeth","base_currency":"ejoy","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"iiceth","base_currency":"iic","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"wteeth","base_currency":"wte","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"freseth","base_currency":"fres","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"mesheth","base_currency":"mesh","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"icceth","base_currency":"icc","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"ionceth","base_currency":"ionc","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"drcteth","base_currency":"drct","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"oaseth","base_currency":"oas","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"buteth","base_currency":"but","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"aidoceth","base_currency":"aidoc","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"cofieth","base_currency":"cofi","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"lxteth","base_currency":"lxt","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"edueth","base_currency":"edu","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"dtaeth","base_currency":"dta","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"msceth","base_currency":"msc","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"geneeth","base_currency":"gene","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"ccceth","base_currency":"ccc","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"dscoineth","base_currency":"dscoin","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"boceth","base_currency":"boc","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"toseth","base_currency":"tos","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"fueleth","base_currency":"fuel","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"pnteth","base_currency":"pnt","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"seceth","base_currency":"sec","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"mofeth","base_currency":"mof","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"rnteth","base_currency":"rnt","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"wicceth","base_currency":"wicc","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"fffeth","base_currency":"fff","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"cpseth","base_currency":"cps","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"zsceth","base_currency":"zsc","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"latxeth","base_currency":"latx","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"dhteth","base_currency":"dht","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"seeeth","base_currency":"see","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"inketh","base_currency":"ink","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"saceth","base_currency":"sac","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"scleth","base_currency":"scl","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"mitheth","base_currency":"mith","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"smteth","base_currency":"smt","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"fcandyusdt","base_currency":"fcandy","quote_currency":"usdt","price_decimal":8,"amount_decimal":2},{"name":"newoseth","base_currency":"newos","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"hotceth","base_currency":"hotc","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"ptteth","base_currency":"ptt","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"dpneth","base_currency":"dpn","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"ltheth","base_currency":"lth","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"jlleth","base_currency":"jll","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"utoeth","base_currency":"uto","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"777usdt","base_currency":"777","quote_currency":"usdt","price_decimal":8,"amount_decimal":2},{"name":"xpsusdt","base_currency":"xps","quote_currency":"usdt","price_decimal":8,"amount_decimal":2},{"name":"prausdt","base_currency":"pra","quote_currency":"usdt","price_decimal":8,"amount_decimal":2},{"name":"hpcusdt","base_currency":"hpc","quote_currency":"usdt","price_decimal":8,"amount_decimal":2},{"name":"vppeth","base_currency":"vpp","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"oscheth","base_currency":"osch","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"guusdt","base_currency":"gu","quote_currency":"usdt","price_decimal":8,"amount_decimal":2},{"name":"ft1808usdt","base_currency":"ft1808","quote_currency":"usdt","price_decimal":6,"amount_decimal":2},{"name":"ruffeth","base_currency":"ruff","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"baiceth","base_currency":"baic","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"ormeeth","base_currency":"orme","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"puneth","base_currency":"pun","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"facceth","base_currency":"facc","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"cwveth","base_currency":"cwv","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"lmmeth","base_currency":"lmm","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"vlceth","base_currency":"vlc","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"icsteth","base_currency":"icst","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"ftft1808","base_currency":"ft","quote_currency":"ft1808","price_decimal":6,"amount_decimal":2},{"name":"iotausdt","base_currency":"iota","quote_currency":"usdt","price_decimal":4,"amount_decimal":2},{"name":"drink1eth","base_currency":"drink1","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"drinketh","base_currency":"drink","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"musketh","base_currency":"musk","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"mxmeth","base_currency":"mxm","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"mitxeth","base_currency":"mitx","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"ft1810_iusdt","base_currency":"ft1810_i","quote_currency":"usdt","price_decimal":6,"amount_decimal":2},{"name":"ftft1810_i","base_currency":"ft","quote_currency":"ft1810_i","price_decimal":6,"amount_decimal":2},{"name":"inteth","base_currency":"int","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"btmceth","base_currency":"btmc","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"cnmceth","base_currency":"cnmc","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"ftieth","base_currency":"fti","quote_currency":"eth","price_decimal":8,"amount_decimal":2},{"name":"eosusdt","base_currency":"eos","quote_currency":"usdt","price_decimal":4,"amount_decimal":4}]}
+```
+
+## Market
+```bash
+$ ./bin/fcoin market
+Commands:
+  fcoin market candles --resolution=RESOLUTION --symbol=SYMBOL  # Returns candles info of symbol specified by resolution
+  fcoin market depth --level=LEVEL --symbol=SYMBOL              # Returns depth info of symbol specified by level
+  fcoin market help [COMMAND]                                   # Describe subcommands or one specific subcommand
+  fcoin market ticker --symbol=SYMBOL                           # Returns ticker info of symbol
+  fcoin market trades --symbol=SYMBOL                           # Returns trades info of symbol
+
+```
+
+```bash
+$ # Returns ticker info of symbol
+$ ./bin/fcoin market ticker --symbol ethusdt
+{"status":0,"data":{"ticker":{"latest_price":414.02,"most_recent_trade_vol":0.0902,"max_buy_price":414.02,"max_buy_amount":1.8507,"min_sell_price":414.03,"min_sell_amount":0.5,"trade_price_yesterday":412.04,"highest_price_today":415.31,"lowest_price_today":397.61,"symbol_base_vol_today":20506.814864234,"symbol_base_price_today":8368527.290918281},"type":"ticker.ethusdt","seq":105330258}}
+
+$ # Returns depth info of symbol specified by level
+$ ./bin/fcoin market depth --symbol ethusdt --level L20
+{"status":0,"data":{"bids":[{"price":414.06,"amount":0.015},{"price":414.05,"amount":0.045},{"price":414.02,"amount":0.4694},{"price":414.0,"amount":0.1042},{"price":413.94,"amount":0.0084},{"price":413.93,"amount":0.4181},{"price":413.91,"amount":0.0025},{"price":413.9,"amount":0.0242},{"price":413.81,"amount":0.0036},{"price":413.8,"amount":0.04},{"price":413.71,"amount":0.1499},{"price":413.7,"amount":0.095},{"price":413.68,"amount":0.0558},{"price":413.67,"amount":0.0803},{"price":413.66,"amount":0.0684},{"price":413.62,"amount":0.0617},{"price":413.6,"amount":0.9768},{"price":413.59,"amount":0.0469},{"price":413.5,"amount":1.6528},{"price":413.41,"amount":0.0541}],"asks":[{"price":414.08,"amount":0.1742},{"price":414.09,"amount":0.1153},{"price":414.1,"amount":0.0201},{"price":414.11,"amount":0.1566},{"price":414.13,"amount":0.1332},{"price":414.15,"amount":0.2891},{"price":414.16,"amount":0.0951},{"price":414.23,"amount":0.4024},{"price":414.27,"amount":0.0283},{"price":414.3,"amount":0.005},{"price":414.31,"amount":0.0072},{"price":414.32,"amount":0.0035},{"price":414.35,"amount":0.0072},{"price":414.36,"amount":0.0025},{"price":414.46,"amount":0.0638},{"price":414.49,"amount":1.2057},{"price":414.5,"amount":0.005},{"price":414.51,"amount":0.0105},{"price":414.53,"amount":0.0015},{"price":414.6,"amount":0.06}],"ts":1533312373012,"seq":105330896,"type":"depth.L20.ethusdt"}}
+
+$ # Returns trades info of symbol
+$ ./bin/fcoin market trades --symbol ethusdt
+{"status":0,"data":[{"amount":0.0371,"ts":1533312528424,"id":105331864002,"side":"buy","price":413.8}]}
+
+$ # Returns candles info of symbol specified by resolution
+$ ./bin/fcoin market candles --symbol ethusdt --resolution MN
+{"status":0,"data":[{"open":430.1,"close":413.84,"high":435.93,"quote_vol":48966834.28889369,"id":1533052800,"count":357474,"low":397.61,"seq":10533250500000,"base_vol":116515.627401974},{"id":1530374400,"seq":10277314000000,"high":516.09,"low":418.29,"open":449.1,"close":430.1,"count":6460281,"base_vol":3214156.779928503,"quote_vol":1481280928.4282734},{"id":1527782400,"seq":7385778300000,"high":555.13,"low":406.11,"open":523.97,"close":449.04,"count":20382481,"base_vol":28258854.226292703,"quote_vol":13579650310.735054},{"id":1525104000,"seq":2847062700000,"high":582.99,"low":559.66,"open":563.23,"close":575.77,"count":4617,"base_vol":4159.317883344,"quote_vol":2380070.431548223}]}
+```
+
+## Order
+
+__Please authenticate before command execution__
+```bash
+export FCOIN_API_KEY='your_fcoin_api_key'
+export FCOIN_SECRET_KEY='your_fcoin_secret_key'
+```
+
+```bash
+$ ./bin/fcoin order
+Commands:
+  fcoin order cancel --order-id=ORDER_ID                                     # Cancel order
+  fcoin order create_limit --amount=N --price=N --side=SIDE --symbol=SYMBOL  # Create limit order
+  fcoin order help [COMMAND] --side=SIDE --symbol=SYMBOL                     # Describe subcommands or one specific subcommand
+  fcoin order list --states=STATES --symbol=SYMBOL                           # Get order list
+  fcoin order reference --order-id=ORDER_ID                                  # Ouery order
+  fcoin order transaction --order-id=ORDER_ID                                # Query the transaction record for the specified by order_id
+
+```
+
+```bash
+$ # Create limit order
+$ ./bin/fcoin order create_limit --symbol ftusdt --side sell --price 1 --amount 3
+{"status":0,"data":"6SlFV7PSsxYu0FduMlYwghCgLgjeD_AiT5loT-ZFl2s="}
+
+$ # Ouery order
+$ ./bin/fcoin order reference --order-id 6SlFV7PSsxYu0FduMlYwghCgLgjeD_AiT5loT-ZFl2s=
+{"status":0,"data":{"id":"6SlFV7PSsxYu0FduMlYwghCgLgjeD_AiT5loT-ZFl2s=","symbol":"ftusdt","amount":"3.000000000000000000","price":"1.000000000000000000","created_at":1533313517068,"type":"limit","side":"sell","filled_amount":"0.000000000000000000","executed_value":"0.000000000000000000","fill_fees":"0.000000000000000000","source":"api","state":"submitted"}}
+
+$ # Query the transaction record
+$ ./bin/fcoin order transaction --order-id 6SlFV7PSsxYu0FduMlYwghCgLgjeD_AiT5loT-ZFl2s=
+{"status":0,"data":[]}
+
+$ # Cancel order
+$ ./bin/fcoin order cancel --order-id 6SlFV7PSsxYu0FduMlYwghCgLgjeD_AiT5loT-ZFl2s=
+{"status":0} # cancel is success
+
+$ # Get order list
+$ ./bin/fcoin order list --symbol ethusdt --states canceled
+{"status":0,"data":[{"id":"nMEC_VrW0LYlP4iCcWzmdL50jFrvNWZoaQxvZSjeUSA=","symbol":"ethusdt","amount":"0.001000000000000000","price":"1000.000000000000000000","created_at":1531732778736,"type":"limit","side":"sell","filled_amount":"0.000000000000000000","executed_value":"0.000000000000000000","fill_fees":"0.000000000000000000","source":"api","state":"canceled"},{"id":"V6WE1JJCUwvqJFgCjfT5lA37ioU_xOYi6_NSrtOVOsw=","symbol":"ethusdt","amount":"0.001000000000000000","price":"1000.000000000000000000","created_at":1531732713230,"type":"limit","side":"sell","filled_amount":"0.000000000000000000","executed_value":"0.000000000000000000","fill_fees":"0.000000000000000000","source":"api","state":"canceled"},{"id":"R0moy92q4Qaf_GDEQ6Y1IKCgl5wwJM2bz_Zyacp-Ek8=","symbol":"ethusdt","amount":"0.001000000000000000","price":"1000.000000000000000000","created_at":1531714333569,"type":"limit","side":"sell","filled_amount":"0.000000000000000000","executed_value":"0.000000000000000000","fill_fees":"0.000000000000000000","source":"api","state":"canceled"},{"id":"L7rbALEIoI0ymo3uOXBF4gT4BlyTxgHhGoZjvptIv2U=","symbol":"ethusdt","amount":"0.001000000000000000","price":"1000.000000000000000000","created_at":1531714218130,"type":"limit","side":"sell","filled_amount":"0.000000000000000000","executed_value":"0.000000000000000000","fill_fees":"0.000000000000000000","source":"api","state":"canceled"},{"id":"32ZZCBEpPz2J9oFIJ4RMTIbypltjrVD9PAdYxQTHhUE=","symbol":"ethusdt","amount":"0.001000000000000000","price":"1000.000000000000000000","created_at":1531714092732,"type":"limit","side":"sell","filled_amount":"0.000000000000000000","executed_value":"0.000000000000000000","fill_fees":"0.000000000000000000","source":"api","state":"canceled"},{"id":"VotO2IKI2opgyKRd1lhR5bYj9zNZ398IW85gcBNPisU=","symbol":"ethusdt","amount":"0.001000000000000000","price":"1000.000000000000000000","created_at":1531712709955,"type":"limit","side":"sell","filled_amount":"0.000000000000000000","executed_value":"0.000000000000000000","fill_fees":"0.000000000000000000","source":"api","state":"canceled"},{"id":"tYH6LczJxaVe_WhsLOzOk4YM53hK2q169nYn9ReiwGM=","symbol":"ethusdt","amount":"0.001000000000000000","price":"1000.000000000000000000","created_at":1531675732267,"type":"limit","side":"sell","filled_amount":"0.000000000000000000","executed_value":"0.000000000000000000","fill_fees":"0.000000000000000000","source":"web","state":"canceled"},{"id":"U50WtZkmIh_bbuVKoipAMayCIy0A7qk4hBLxpDvKdPk=","symbol":"ethusdt","amount":"0.025800000000000000","price":"491.100000000000000000","created_at":1529665880201,"type":"limit","side":"buy","filled_amount":"0.000000000000000000","executed_value":"0.000000000000000000","fill_fees":"0.000000000000000000","source":"web","state":"canceled"}]}
+```
+
+## Account
+
+__Please authenticate before command execution__
+```bash
+export FCOIN_API_KEY='your_fcoin_api_key'
+export FCOIN_SECRET_KEY='your_fcoin_secret_key'
+```
+
+```bash
+$ ./bin/fcoin account
+Commands:
+  fcoin account balance         # Get account info
+  fcoin account help [COMMAND]  # Describe subcommands or one specific subcommand
+
+```
+
+```bash
+$ ./bin/fcoin account balance
+# Do not display because it is personal information
+```

data/examples/cli/setting.md

@@ -0,0 +1,39 @@
+# Setting CLI
+
+In development, please use the `./bin/fcoin`.<br>
+In Actual, please use the `bundle exec fcoin`.
+
+## All
+```bash
+$ ./bin/fcoin
+Commands:
+  fcoin account         # Get Account Information
+  fcoin help [COMMAND]  # Describe available commands or one specific command
+  fcoin locale          # Locale Setting
+  fcoin market          # Get Market Information
+  fcoin order           # Operate Order
+  fcoin public          # Get Public Information
+  fcoin subscribe       # Subscribe topic
+  fcoin validation      # Validation Setting
+  fcoin version         # Print Version
+
+```
+
+## Validation
+```bash
+$ # Create validation setting file
+$ ./bin/fcoin validation init --path ./config
+      create
+      create  my_settings.yml
+```
+
+## Locale
+```bash
+$ # Create locale file
+$ ./bin/fcoin locale init --path ./config
+       exist
+      create  .DS_Store
+      create  locales/en.yml
+      create  locales/ja.yml
+      create  locales/zh_CN.yml
+```

data/examples/realtime_api.rb

@@ -0,0 +1,43 @@
+require 'bundler/setup'
+require './lib/fcoin.rb'
+require 'pry'
+
+Fcoin.configure do |config|
+  config.api_key    = ENV['FCOIN_API_KEY']
+  config.secret_key = ENV['FCOIN_SECRET_KEY']
+  config.skip_validation = false
+  ## Please execute 「bundle exec fcoin validation init --path ./config」
+  config.validation_setting_path = File.expand_path('../../config/my_settings.yml', __FILE__)
+end
+
+client = Fcoin::RealTime::Client.new
+# client = Fcoin::RealTime::Client.new(api_key: 'hoge', secret_key: 'fuga')
+# or
+# client = Fcoin::Client.new.realtime
+
+
+client.on_ticker(symbol: :ethusdt) do |data|
+  puts data
+end
+
+client.on_depth(symbol: :ethusdt, level: :L20) do |data|
+  puts data
+end
+
+client.on_trade(symbol: :ethusdt, limit: 5) do |data|
+  puts data
+end
+
+client.on_candle(symbol: :ethusdt, resolution: :M1, limit: 5) do |data|
+  puts data
+end
+
+client.on_topics do |data|
+  puts data
+end
+
+client.on_hello do |data|
+  puts data
+end
+
+client.subscribe

data/examples/rest_api.rb

@@ -0,0 +1,47 @@
+require 'bundler/setup'
+require './lib/fcoin.rb'
+require 'pry'
+
+Fcoin.configure do |config|
+  config.api_key    = ENV['FCOIN_API_KEY']
+  config.secret_key = ENV['FCOIN_SECRET_KEY']
+  config.skip_validation = false
+  ## Please execute 「bundle exec fcoin validation init --path ./config」
+  config.validation_setting_path = File.expand_path('../../config/my_settings.yml', __FILE__)
+end
+
+client = Fcoin::Client.new
+# client = Fcoin::Client.new(api_key: 'hoge', secret_key: 'fuga')
+
+## public
+puts client.public_server_time
+puts client.public_currencies
+puts client.public_symbols
+
+
+## market
+puts client.market_ticker(symbol: :ethusdt)
+puts client.market_depth(level: :L20 ,symbol: :ethusdt)
+puts client.market_trades(symbol: :ethusdt)
+puts client.market_candles(symbol: :ethusdt, resolution: :M1)
+
+
+## accounts
+puts client.accounts_balance
+
+
+## orders
+# client.create_order_limit(symbol: :ethusdt, side: :sell, type: :limit, price: 1000, amount: 0.001)
+puts client.order_list(symbol: :ethusdt, states: :canceled, page_before: nil, page_after: nil, per_page: 20)
+# puts client.order_list(symbol: :ethusdt, states: 'canceled', page_before: nil, page_after: nil, per_page: 20)
+
+
+puts client.order(order_id: "L7rbALEIoI0ymo3uOXBF4gT4Bl********jvptIv2U=")
+# alias method
+# client.reference_order(order_id: "L7rbALEIoI0ymo3uOXBF4gT4Bl********jvptIv2U=")
+
+puts client.cancel_order(order_id: "nMEC_VrW0LYlP4iCcWzmdL50jFrvNWZoaQxvZSjeUSA=")
+
+puts client.order_match_results(order_id: "kW3cRiXIGHG-cHNdter*********qfoMzbeHEQcqp4=")
+# alias method
+# client.order_transaction(order_id: "kW3cRiXIGHG-cHNdter*********qfoMzbeHEQcqp4=")

data/fcoin_ruby_client.gemspec

@@ -0,0 +1,39 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fcoin/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fcoin_ruby_client"
+  spec.version       = Fcoin::VERSION
+  spec.authors       = ["yukihirop"]
+  spec.email         = ["yfsidejob@gmail.com"]
+
+  spec.summary       = %q{A Ruby wrapper for Fcoin API}
+  spec.description   = %q{A Ruby wrapper for Fcoin API}
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16.a"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "onkcop"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+
+  spec.add_runtime_dependency "faraday"
+  spec.add_runtime_dependency "faraday_middleware"
+  spec.add_runtime_dependency "activesupport"
+  spec.add_runtime_dependency "faye-websocket"
+  spec.add_runtime_dependency "config"
+  spec.add_runtime_dependency "thor"
+end

data/lib/fcoin/api.rb

@@ -0,0 +1,47 @@
+require_relative 'connection'
+require_relative 'request'
+require_relative 'endpoint'
+require_relative 'error'
+require_relative 'realtime/api'
+require 'active_support'
+require 'active_support/core_ext'
+
+module Fcoin
+  class API
+    include Connection
+    include Request
+    include Endpoint
+
+    # @param [Hash] options the options to setting Fcoin Setting. For example, Authorization, Validation and so on.
+    # @option options [String] :adapter(Faraday.default_adapter)
+    # @option options [String] :endpoint(https://api.fcoin.com/v2/) REST API endpoint
+    # @option options [String] :wss_endpoint(wss://api.fcoin.com/v2/ws) Websocket endpoint
+    # @option options [String] :user_agent
+    # @option options [String] :proxy(nil)
+    # @option options [String] :ca_path
+    # @option options [String] :ca_file
+    # @option options [Array<Faraday::Middleware>] :middlewares request faraday middlewares
+    # @option options [String] :api_key
+    # @option options [String] :secret_key
+    # @option options [Boolean] :skip_validation(true)
+    # @option options [String] :validation_setting_path  configuration file path for validation
+    def initialize(options={})
+      self.merged_options = Fcoin.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", merged_options[key])
+      end
+    end
+
+    # Build realtime client
+    #
+    # @see RealTime::Client
+    # @return [Fcoin::RealTime::Client]
+    def realtime
+      RealTime::Client.new(merged_options)
+    end
+
+    private
+
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS, :merged_options
+  end
+end

data/lib/fcoin/authorization.rb

@@ -0,0 +1,83 @@
+require 'openssl'
+require 'base64'
+require 'active_support'
+require 'active_support/core_ext'
+
+module Fcoin
+  class Authorization
+    # @param http_method [String]
+    # @param path [String]
+    # @param payload [Hash]
+    # @param endpoint [String]
+    # @api_key [String]
+    # @secret_key [String]
+    def initialize(http_method:, path:, payload:, endpoint:, api_key:, secret_key:)
+      self.http_method = http_method
+      self.path        = path
+      self.payload     = payload
+      self.endpoint    = endpoint
+      self.api_key     = api_key
+      self.secret_key  = secret_key
+    end
+
+    # Header required for authentication
+    #
+    # @see https://developer.fcoin.com/zh.html#32c808cbe5
+    def original_headers
+      {
+         'FC-ACCESS-KEY'       => api_key,
+         'FC-ACCESS-SIGNATURE' => encoded_signature,
+         'FC-ACCESS-TIMESTAMP' => timestamp
+      }
+    end
+
+    private
+
+    attr_accessor :http_method, :path, :payload, :endpoint, :api_key, :secret_key
+
+    def encoded_signature
+      base64_signature = Base64.strict_encode64(signature)
+      Base64.strict_encode64(OpenSSL::HMAC.digest('sha1', secret_key.to_s, base64_signature))
+    end
+
+    # @example HTTP_METHOD + HTTP_REQUEST_URI + TIMESTAMP + POST_BODY
+    #  POSThttps://api.fcoin.com/v2/orders1523069544359amount=100.0&price=100.0&side=buy&symbol=btcusdt&type=limit
+    #
+    # @see https://developer.fcoin.com/zh.html#api
+    def signature
+      if http_method == :get && query_string.present?
+        http_method.upcase.to_s + full_url.to_s + '?' +query_string.to_s + timestamp.to_s
+      else
+        http_method.upcase.to_s + full_url.to_s + timestamp.to_s + payload_string.to_s
+      end
+    end
+
+    def full_url
+      endpoint.to_s + path.to_s
+    end
+
+    # digits number: 13
+    #
+    # @note When accessing the API with the UNIX EPOCH timestamp, the time difference between the server and the server must be less than 30 seconds.
+    #
+    # @example
+    #  1531632081423
+    #
+    #
+    # @see https://developer.fcoin.com/zh.html#api
+    def timestamp
+      # digits number: 13
+      # e.x.) 1531632081423
+      @timestamp ||= Time.now.strftime('%s%L').to_i.to_s
+    end
+
+    # sort by alphabet ASC
+    #
+    # @see https://developer.fcoin.com/jp.html?javascript#
+    def query_string
+      query_string = Hash[ payload.sort ].to_query
+      query_string.blank? ? '' : query_string
+    end
+    alias :payload_string :query_string
+  end
+end

data/lib/fcoin/cli/endpoint/accounts_task.rb

@@ -0,0 +1,33 @@
+require_relative '../../../fcoin'
+require 'thor'
+
+module Fcoin
+  module EndPoint
+    class AccountsTask < Thor
+      # Get account info.
+      #
+      # curl: GET https://api.fcoin.com/v2/accounts/balance
+      #
+      # @note This method can not be invoked without authentication.
+      #
+      # @example get account info
+      #  export FCOIN_API_KEY='your_fcoin_api_key'
+      #  export FCOIN_SECRET_KEY='your_fcoin_secret_key'
+      #  ./bin/fcoin accounts balance
+      #
+      #
+      # @see https://developer.fcoin.com/zh.html#486f6037ed
+      # @return [JSON]
+      desc 'balance', 'Get account info'
+      def balance
+        STDOUT.puts client.accounts_balance
+      end
+
+      private
+
+      def client
+        Fcoin::Client.new
+      end
+    end
+  end
+end

data/lib/fcoin/cli/endpoint/market_task.rb

@@ -0,0 +1,98 @@
+require_relative '../../../fcoin'
+require 'thor'
+
+module Fcoin
+  module EndPoint
+    class MarketTask < Thor
+      # Returns ticker info of symbol.
+      #
+      # curl: GET https://api.fcoin.com/v2/market/ticker/$symbol
+      #
+      # @example get ethusdt ticker info
+      #  ./bin/fcoin market ticker --symbol ethusdt
+      #
+      #
+      # @see https://developer.fcoin.com/zh.html#ticker
+      # @raise [ArgumentError] If the symbol does not have.
+      # @param symbol [String] Transaction pairs.
+      # @return [JSON] Returns ticker info.
+      desc 'ticker', 'Returns ticker info of symbol'
+      option :symbol, type: :string, required: true, desc: 'Transaction pairs'
+      def ticker
+        symbol = options[:symbol]
+        STDOUT.puts client.market_ticker(symbol: symbol)
+      end
+
+      # Returns depth info of symbol specified by level.
+      #
+      # curl: GET https://api.fcoin.com/v2/market/depth/$level/$symbol
+      #
+      # @example get ethusdt depth info specified by L20 level.
+      #  ./bin/fcoin market depth --symbol ethusdt --level L20
+      #
+      #
+      # @see https://developer.fcoin.com/zh.html#50f4407ea4
+      # @raise [ArgumentError] If the symbol or level does not have.
+      # @raise [InvalidValueError] If symbol or level is invalid.
+      # @param symbol [String] Transaction pairs.
+      # @param level [String] Level of depth chart. level must be included in [L20, L40, full].
+      # @return [JSON] Returns depth info.
+      desc 'depth', 'Returns depth info of symbol specified by level'
+      option :symbol, type: :string, required: true, desc: 'Transaction pairs'
+      option :level,  type: :string, required: true, desc: 'Level of depth chart. level must be included in [L20, L40, full]'
+      def depth
+        symbol = options[:symbol]
+        level  = options[:level]
+        STDOUT.puts client.market_depth(symbol: symbol, level: level)
+      end
+
+      # Returns trades info of symbol.
+      #
+      # curl: GET https://api.fcoin.com/v2/market/trades/$symbol
+      #
+      # @example get ethusdt trades info.
+      #  ./bin/fcoin market trades --symbol ethusdt
+      #
+      #
+      # @see https://developer.fcoin.com/zh.html#6477a1394e
+      # @raise [ArgumentError] If the symbol does not have.
+      # @param symbol [String] Transaction pairs.
+      # @return [JSON] Returns trades info.
+      desc 'trades', 'Returns trades info of symbol'
+      option :symbol, type: :string, required: true, desc: 'Transaction pairs'
+      def trades
+        symbol = options[:symbol]
+        STDOUT.puts client.market_trades(symbol: symbol)
+      end
+
+      # Returns candles info of symbol specified by resolution.
+      #
+      # curl: GET https://api.fcoin.com/v2/market/candles/$resolution/$symbol
+      #
+      # @example get monthly(MN) ethusdt candles info.
+      #  ./bin/fcoin market candles --symbol ethusdt --resolution D1
+      #
+      #
+      # @see https://developer.fcoin.com/zh.html#candle
+      # @raise [ArgumentError] If the symbol or resolution does not have.
+      # @raise [InvalidValueError] If symbol or resolution is invalid.
+      # @param symbol [String or Symbol] Transaction pairs.
+      # @param resolution [String or Symbol] period of candles chart. resolution must be included in [M1, M3, M5, M15, M30, H1, H4, H6, D1, W1, MN].
+      # @return [JSON] Returns candles info.
+      desc 'candles', 'Returns candles info of symbol specified by resolution'
+      option :symbol,     type: :string, required: true, desc: 'Transaction pairs'
+      option :resolution, type: :string, required: true, desc: 'period of candles chart. resolution must be included in [M1, M3, M5, M15, M30, H1, H4, H6, D1, W1, MN]'
+      def candles
+        symbol = options[:symbol]
+        resolution = options[:resolution]
+        STDOUT.puts client.market_candles(symbol: symbol, resolution: resolution)
+      end
+
+      private
+
+      def client
+        @client = Fcoin::Client.new
+      end
+    end
+  end
+end