API文檔

API使用說明

  1. API服務器路徑  https://api.ex.cash/
  2. 請求過程說明
    • api分為兩類傳參方式,GET方式與POST方式。
      • POST方式傳參的接口說明
      • 必須參數(每個POST接口,都不可少的參數)
        • api_key (可在app裡,我的->api管理 中生成)
        • sign (參數簽名,簽名規則後面會提及)
      • 其他參數:根據不同接口,可能還有其他必填或選填參數
    • sign的生成規則
      • 將每個post接口實際傳的參數(除sign外),按照參數名進行排序,排序規則為abcd字母順序,若遇到相同首字母,則看第二個字母,以此類推。
      • 將排序後的參數以鍵值對形式拼接,拼接規則如下:key1=value1&key2=value3&...&secret_key=秘鑰
      • 將上述B步驟生成的字符串進行32位MD5加密
      • 將上述C步驟生成的字符串轉大寫,形成最終的sign
    • POST接口示例(以獲取用戶成交的訂單接口為例):
    • array( api_key => "SAFSFASDF234RXXXXX", tradeType => 1, symbol =>"ex_eth", );
      • 排序與拼接
        • 參數拼接:api_key=SAFSFASDF234RXXXXX&symbol=ex_eth&tradeType=1
        • 拼接secret_key:api_key=SAFSFASDF234RXXXXX&symbol=ex_eth&tradeType=1&secret_key=秘鑰
      • 將上述步驟生成的字符串進行32位MD5加密
      • 將上述步驟生成的字符串轉大寫,生成最終的sign
    • GET方式傳參的接口說明
      • GET方式不用生成sign加密傳,根據接口實際所需參數傳參即可
  3. 安全認證
    • 所有的private API都需要經過認證,Api的申請可以到APP我的 -> API管理,申請得到私鑰和公鑰,如遺失請用認證手機來重置API!
    • 注意:請勿向任何人洩露這兩個參數,這像您的密碼一樣重要

API 參考

  1. 獲取指定幣種最新行情
  2. Path: https://api.ex.cash/api/ticker

    Request 類型: GET

    請求參數:

    參數名 參數類型 必填 描述
    symbol String 否(默認: wtc_eth ) 交易市場

    返回結果說明:

    {
    	"market": "wtc_eth",  	// 交易市場
    	"date": 1508739998,  	// 返回數據時服務器時間
    	"ticker": {
    		"buy": "0.04760000",   // 買一價
    		"high": "0.05070000",  // 最高價
    		"last": "0.04880000",  // 最新成交價
    		"low": "0.04840000",   // 最低價
    		"sell": "0.04880000",  // 賣一價
    		"vol": "4.34400000"    // 成交量
    	},
    	"code": 200  // 狀態碼
    }						
  3. 市場深度
  4. 描述:返回所有的市場深度,此回應的數據量會較大,所以請勿頻繁調用。

    Path: https://api.ex.cash/api/depth

    Request 類型: GET

    請求參數:

    參數名 參數類型 必填 描述
    symbol String 交易市場
    size Integer 否(默認200條)

    返回結果說明:

    {
    	"asks": "[[0.25000000,0.25000000],[0.22000000,13.33790000],[0.08999800,0.03410400],[0.07900000,0.40000000],[0.07780000,0.40000000],[0.07770000,1.00000000],[0.07700000,0.30000000],[0.07620000,0.58000000],    [0.07600000,0.50000000],[0.07580000,1.02000000],[0.07500000,0.03800000],[0.07470000,1.03350000],[0.07460000,0.11140000],[0.05880000,9.57290000],[0.05140000,0.51600000]]",  // 賣方深度
    	"bids": "[[0.04500000,1.00000000],[0.04000000,1.00000000],[0.03800000,2.00000000],[0.03500000,1.28000000],[0.03200000,2.60000000],[0.03000000,0.05970000],[0.02800000,0.60000000],[0.02500000,0.80000000],[0.01800000,3.00000000],[0.01000000,0.49989900]]"  // 買方深度
    }						
  5. 用戶資產
  6. 描述:獲取用戶資產

    Path: https://api.ex.cash/api/userinfo

    Request 類型: POST

    請求參數:

    參數名 參數類型 必填 描述
    api_key String 用戶申請的api_key
    sign String 請求參數的簽名
    coin String 用戶查看餘額的幣種,默認btc,eth

    返回結果說明:

    {
    	"result": "true",    // 返回狀態
    	"asset": {         // 賬戶可用餘額
    		"btc": "0.14600000",
    		"eth": "0.05780000",
    		"ltc": "0.15780000",
    	},
    	"freezed": {         // 賬戶凍結餘額
    		"btc": "0.04790000",
    		"eth": "0.48770000",
    		"ltc": "0.35480000",
    	},
    	"code": 200  // 狀態碼
    }						
  7. 獲取用戶的訂單
  8. Path: https://api.ex.cash/api/orders_info_by_status

    Request 類型: POST

    請求參數:

    參數名 參數類型 必填 描述
    api_key String 用戶申請的api_key
    sign String 請求參數的簽名
    symbol String 交易市場
    status Integer 用戶訂單狀態,默認0

    返回結果說明:

    {
    	"result": "true",     // 返回狀態
    	"orders": {
    		"amount": "100",  // 交易數量
    		"create_date": "1508739998",  // 訂單生成時間
    		"deal_amount": "57",  // 已交易量
    		"order_id": "1024",  // 訂單id
    		"price": "0.05780000",  // 交易價格
    		"fee": "0.00058000",  // 交易手續費
    		"type": "1",     // 1買/2賣
    		"status": "0",  // 訂單狀態(0:正在進行,1:已成交,2:已撤回)
    	},
    	"code": 200  // 狀態碼
    }						
  9. 獲取用戶成交的訂單
  10. Path: https://api.ex.cash/api/user_trade

    Request 類型: POST

    請求參數:

    參數名 參數類型 必填 描述
    api_key String 用戶申請的api_key
    sign String 請求參數的簽名
    symbol String 交易市場
    tradeType Integer 否,默認2 用戶成交的訂單類型,1:買/2:賣
    times String 返回時間戳以後的訂單,默認0

    返回結果說明:

    {
    	"result": "true",  // 返回狀態
    	"orders": {
    		"id": "1475",  // 訂單id
    		"userid": "14204",  // 買方id
    		"peerid": "12470",  // 賣方id
    		"num": "10",  // 交易數量
    		"market": "1024",  // 交易市場
    		"price": "0.05780000",  // 交易價格
    		"type": "1",   // 1買/2賣
    		"addtime": "1508739998",  // 成交時間
    	},
    	"code": 200  // 狀態碼
    }
  11. 下單交易
  12. Path: https://api.ex.cash/api/trade

    Request 類型: POST

    請求參數:

    參數名 參數類型 必填 描述
    api_key String 用戶申請的api_key
    sign String 請求參數的簽名
    symbol String 交易市場
    price Double 交易價格
    amount Double 交易數量
    tradeType Integer 用戶成交的訂單類型,1:買/2:賣
    fee Double 手續費比列(默认为该市场下配置的手续费比例,若传输的手续费比例低于该市场配置的手续费比例,则使用该市场配置的手续费比例)

    返回結果說明:

    {
    	"result": "true",   // 返回狀態
    	"id": "1475",  // 訂單id
    	"code": 200  // 狀態碼
    }
  13. 批量下單
  14. Path: https://api.ex.cash/api/batch_trade

    Request 類型: POST

    請求參數:

    參數名 參數類型 必填 描述
    api_key String 用戶申請的api_key
    sign String 請求參數的簽名
    orders_data Integer 格式:[{'price':3,'amount':5,'type':1,'symbol':'trx_eth'}, {'price':3,'amount':3,'type':1,'symbol':'trx_eth'}]
    fee Double 手續費比列(默认为该市场下配置的手续费比例,若传输的手续费比例低于该市场配置的手续费比例,则使用该市场配置的手续费比例)

    返回結果說明:

    {
    	"result": "true",   // 返回狀態
    	"order_info":"{order_id:1564},{order_id:1565},{order_id:-1,code:1019}",// 訂單id信息
    	"code":200  // 狀態碼
    }

    備註:

    只要其中任何一單下單成功就返回true

    返回的訂單信息和orders_data上傳的訂單順序一致,如果下單失敗:order_id為-1,code為錯誤代碼

  15. 撤銷訂單
  16. Path: https://api.ex.cash/api/cancel_order

    Request 類型: POST

    請求參數:

    參數名 參數類型 必填 描述
    api_key String 用戶申請的api_key
    sign String 請求參數的簽名
    order_id String 訂單id(多個訂單ID中間以","分隔)

    返回結果說明:

    {
    	"success": "1564,1454",  // 成功訂單id
    	"error": "1248,1472",    // 失敗訂單id
    }
  17. 根據id獲取用戶的訂單
  18. Path: https://api.ex.cash/api/order_info

    Request 類型: POST

    請求參數:

    參數名 參數類型 必填 描述
    api_key String 用戶申請的api_key
    sign String 請求參數的簽名
    order_id String 訂單id

    返回結果說明:

    {
    	"result": "true",  // 返回狀態
    	"orders": {
    		"amount": "100",  // 交易數量
    		"create_date": "1508739998",  // 訂單生成時間
    		"deal_amount": "57",  // 已交易量
    		"order_id": "1024",  // 訂單id
    		"price": "0.05780000",  // 交易價格
    		"fee": "0.00058000",   // 交易手續費
    		"type": "1",  // 1買/2賣
    		"status": "0",  // 訂單狀態(0:正在進行,1:已成交,2:已撤回)
    	},
    	"code": 200   // 狀態碼
    }
  19. 批量獲取用戶的訂單
  20. Path: https://api.ex.cash/api/orders_info

    Request 類型: POST

    請求參數:

    參數名 參數類型 必填 描述
    api_key String 用戶申請的api_key
    sign String 請求參數的簽名
    order_id String 用戶訂單id,用","隔開

    Results:

    {
    	"result": "true",  // 返回狀態
    	"orders": [{
    		"amount": "100",  // 交易數量
    		"create_date": "1508739998",// 訂單生成時間
    		"deal_amount": "57", // 已交易量
    		"order_id": "1024",  // 訂單id
    		"price": "0.05780000",  // 交易價格
    		"fee": "0.00058000",  // 交易手續費
    		"type": "1",  // 1買/2賣
    		"status": "0",  // 訂單狀態(0:正在進行,1:已成交,2:已撤回)
    	},
    	{
    		"amount": "105",
    		"create_date": "150874889",
    		"deal_amount": "0",
    		"order_id": "1044",
    		"price": "0.05980000",
    		"fee": "0.00059000",
    		"type": "1",
    		"status": "0",
    	}],
    	"code": 200   // 狀態碼
    }
    
    
  21. 獲取市場交易對
  22. Path: https://api.ex.cash/api/get_market

    Request 類型: GET

    請求參數:

    參數名 參數類型 必填 描述
    symbol String 交易市場(為空時返回所有交易對)

    Results:

    {
        "result": "true",	// 返回狀態
        "markets": [
            {
                "symbol": "wp_eth",			// 交易市場
                "max_price": "0.00000000",	// 最高價
                "min_price": "0.00000000",	// 最低價
                "volume": "0.00000000",		// 成交量
                "num_round": "2",			// 數量精度
                "round": "6",				// 價格精度
                "trade_min": "1",			// 單筆最小交易額
                "trade_max": "10000",		// 單筆最大交易額
                "buy_min": "0.000001",		// 買入最小交易價
                "buy_max": "10000",			// 買入最大交易價
                "sell_min": "0.000001",		// 賣出最小交易價
                "sell_max": "10000",		// 賣出最大交易價
                "last_type": 1,				// 最後一筆交易類型 1:買,2:賣
                "last_price": 1,			// 最後一筆交易價
                "last_num": 100,			// 最後一筆成交量
                "last_time": "1527580640",	// 最後一筆時間戳記
                "buy_price": 0,				// 買一價
                "buy_num": 0,				// 買一量
                "sell_price": 0,			// 賣一價
                "sell_num": 0				// 賣一量
                "change": 0					// 涨跌幅
            }
        ],
        "code": 200 // 狀態碼
    }
    
  23. 獲取用戶所有的市場深度
  24. Path: https://api.ex.cash/api/get_user_all_depth

    Request 類型: POST

    請求參數:

    參數名 參數類型 必填 描述
    api_key String 用戶申請的api_key
    sign String 請求參數的簽名

    Results:

    {
        "wp_eth": {
            "result": "true",
            "asks": "[]",
            "bids": "[]"
        },
        "ex_eth": {
            "result": "true",
            "asks": "[]",
            "bids": "[]"
        },
        "btc_eth": {
            "result": "true",
            "asks": "[]",
            "bids": "[]"
        },
        "wp_btc": {
            "result": "true",
            "asks": "[]",
            "bids": "[]"
        },
        "frec_eth": {
            "result": "true",
            "asks": "[]",
            "bids": "[]"
        },
        "wtc_eth": {
            "result": "true",
            "asks": "[]",
            "bids": "[]"
        },
        "trx_eth": {
            "result": "true",
            "asks": "[[0.1000000000000,724,0.0300000000000]]", //價格,ID,剩餘數量
            "bids": "[]"
        },
        "kpcc_eth": {
            "result": "true",
            "asks": "[]",
            "bids": "[]"
        },
        "ss_eth": {
            "result": "true",
            "asks": "[]",
            "bids": "[]"
        },
        "mana_eth": {
            "result": "true",
            "asks": "[]",
            "bids": "[]"
        },
        "powr_eth": {
            "result": "true",
            "asks": "[]",
            "bids": "[]"
        },
        "qas_eth": {
            "result": "true",
            "asks": "[[0.0200000000000,707,10000.0000000000000]]",
            "bids": "[]"
        }
    }
    
  25. 獲取所有市場深度20檔
  26. Path: https://api.ex.cash/api/get_all_depth

    Request 類型: GET

    請求參數:

    參數名 參數類型 必填 描述

    Results:

    {
        "wp_eth": {
            "result": "true",
            "asks": "[]",
            "bids": "[[0.0100000000000,0.0200000000000]]"
        },
        "ex_eth": {
            "result": "true",
            "asks": "[[0.1000000000000,99.8000000000000]]",
            "bids": "[]"
        },
        "btc_eth": {
            "result": "true",
            "asks": "[]",
            "bids": "[]"
        },
        "wp_btc": {
            "result": "true",
            "asks": "[]",
            "bids": "[]"
        },
        "frec_eth": {
            "result": "true",
            "asks": "[]",
            "bids": "[]"
        },
        "wtc_eth": {
            "result": "true",
            "asks": "[]",
            "bids": "[]"
        },
        "trx_eth": {
            "result": "true",
            "asks": "[[0.1000000000000,0.0300000000000]]",
            "bids": "[]"
        },
        "kpcc_eth": {
            "result": "true",
            "asks": "[]",
            "bids": "[]"
        },
        "ss_eth": {
            "result": "true",
            "asks": "[]",
            "bids": "[]"
        },
        "mana_eth": {
            "result": "true",
            "asks": "[]",
            "bids": "[]"
        },
        "powr_eth": {
            "result": "true",
            "asks": "[]",
            "bids": "[]"
        },
        "qas_eth": {
            "result": "true",
            "asks": "[[0.0100000000000,10000.0000000000000],[0.0200000000000,10000.0000000000000]]",
            "bids": "[[0.0100000000000,995024.8700000000000]]"
        }
    }
    
  27. 獲取用戶所有的餘額
  28. Path: https://api.ex.cash/api/get_myself_balance

    Request 類型: POST

    請求參數:

    參數名 參數類型 必填 描述
    api_key String 用戶申請的api_key
    sign String 請求參數的簽名

    Results:

    {
        "eth": "10000.000000000000000",
        "ethd": "0.000000000000000",
        "qas": "10000.000000000000000",
        "qasd": "0.000000000000000",
        "wtc": "10000.000000000000000",
        "wtcd": "0.000000000000000",
        "trx": "10000.000000000000000",
        "trxd": "0.000000000000000",
        "frec": "10000.000000000000000",
        "frecd": "0.000000000000000",
        "gnt": "10000.000000000000000",
        "gntd": "0.000000000000000",
        "ss": "10000.000000000000000",
        "ssd": "0.000000000000000",
        "btc": "10000.000000000000000",
        "btcd": "0.000000000000000",
        "ex": "10000.000000000000000",
        "exd": "0.000000000000000"
    }
    
  29. 獲取所有交易市場對名稱
  30. Path: https://api.ex.cash/api/get_market_name

    Request 類型: GET

    請求參數:

    參數名 參數類型 必填 描述

    Results:

    {
        "result": "true",
        "markets": [
            "wp_eth",
            "ex_eth",
            "btc_eth",
            "wp_btc",
            "frec_eth",
            "wtc_eth",
            "trx_eth",
            "kpcc_eth",
            "ss_eth",
            "mana_eth",
            "powr_eth",
            "qas_eth"
        ],
        "code": 200
    }
    
  31. 獲取k線數據
  32. Path: https://api.ex.cash/api/kline

    Request 類型: GET

    請求參數:

    參數名 參數類型 必填 描述
    symbol String 交易市場
    type Integer k線類型 默認:15 (分鐘)[可填:1,3,5,10,15,30,60,120,240,360,720,1440,10080]
    since String 10位時間戳,返回從這個時間戳以後的數據
    size Integer 返回數據的條數限制(默認為1000,如果返回數據多於1000條,那麽只返回1000條)

    Results:

    {
        "kline": [
            [
                1529997300,
                "0.0010900000000",
                "0.0010900000000",
                "0.0010900000000",
                "0.0010900000000",
                "0.22000000"
            ],
            ...
        ],
        "market": "ex_eth",
        "result": "true",
        "code": 200
    }
    

代碼狀態對照表

代碼 詳細描述
200 成功
10000 不是POST提交
10001 API格式錯誤
10002 APIKey不存在
10003 Sign簽名錯誤
1001 交易市場為空
1002 交易市場不存在
1003 交易價格錯誤
1004 交易數量錯誤
1005 交易類型錯誤
1006 買入手續費超出範圍
1007 賣出手續費超出範圍
1008 當前市場禁止交易
1009 系統錯誤
1010 交易價格超過最大限制
1011 交易價格超過最小限制
1012 交易價格超過今日漲幅限制
1013 交易價格超過今日跌幅限制
1014 餘額不足
1015 挂單總數量超過系統限制
1016 可交易量錯誤
1017 交易總额錯誤
1018 數據錯誤
1019 交易失敗
1020 找不到訂單id
1021 訂單不存在
1022 參數錯誤
1023 訂單不能撤銷
1024 撤銷失敗
1025 批量挂單失敗
1026 數量格式錯誤
1027 錢包地址格式錯誤
1028 交易密碼格式錯誤
1029 幣種格式錯誤
1030 需要實名照片認證
1031 網絡服務費範圍錯誤