ccxt 交易所適配指南

原理介紹

以前在北京 BPUG 上分享過ccxt， 經歷了一年多使用，以及給 ccxt 提供兩個 pull request 後， 又有一些新的心得分享出來。

ccxt 是 github上最火熱的加密貨幣交易庫， 包含了近百個交易所api。支持 Python、JavaScript、PHP 三種語言調用。對於這個行業來講，各個交易所 API 簽名方式、數據結構都不相同，若是一個個接入適配能夠說費時費力，ccxt的出現解決了這個問題。

在介紹 ccxt 以前， 我想談談 ccxt 的實現方式。 ccxt 使用正則替換的方式， 將 JavaScript 文件轉換成 Python、PHP 文件來實現跨語言調用。因此你在JavaScript代碼中是看不到 a ? b : c 這種 語言特有語法糖的， 由於正則替換的過程並不會處理這些， 只會對一些通用函數作跨語言封裝，交給每種語言的 base 類來實現。

每個交易所 JavaScript class中都會 簽名函數，將該交易所的簽名邏輯封裝起來， 這樣用不用開發者去單獨處理簽名。 每一個class提供 fetchOrderBook、fetchBalance、createOrder等交易的函數，來處理不一樣交易所的參數提交， 而且會解析函數調用後的返回值，轉換成統一的數據結構返回。 不用擔憂 a 交易所返回某字段是 float 類型， b 交易所返回字段是 str 類型這種繁瑣問題。

使用

來看一個簡單的使用

# coding=utf-8

import ccxt

hitbtc = ccxt.hitbtc({'verbose': True})
bitmex = ccxt.bitmex()
huobi  = ccxt.huobi()
exmo   = ccxt.exmo({
   'apiKey': 'YOUR_PUBLIC_API_KEY',
   'secret': 'YOUR_SECRET_PRIVATE_KEY',
})
kraken = ccxt.kraken({
   'apiKey': 'YOUR_PUBLIC_API_KEY',
   'secret': 'YOUR_SECRET_PRIVATE_KEY',
})

exchange_id = 'binance'
exchange_class = getattr(ccxt, exchange_id)
exchange = exchange_class({
   'apiKey': 'YOUR_API_KEY',
   'secret': 'YOUR_SECRET',
   'timeout': 30000,
   'enableRateLimit': True,
})

hitbtc_markets = hitbtc.load_markets()

print(hitbtc.id, hitbtc_markets)
print(bitmex.id, bitmex.load_markets())
print(huobi.id, huobi.load_markets())

print(hitbtc.fetch_order_book(hitbtc.symbols[0]))
print(bitmex.fetch_ticker('BTC/USD'))
print(huobi.fetch_trades('LTC/CNY'))

print(exmo.fetch_balance())

# sell one ฿ for market price and receive $ right now
print(exmo.id, exmo.create_market_sell_order('BTC/USD', 1))

# limit buy BTC/EUR, you pay €2500 and receive ฿1 when the order is closed
print(exmo.id, exmo.create_limit_buy_order('BTC/EUR', 1, 2500.00))

複製代碼

須要注意的是， 在國內調用這些函數都須要使用代理, 我通常是走ss 代理

# mac
brew install polipo
polipo socksParentProxy=localhost:1080
# Established listening socket on port 8123
複製代碼

js 版本解決辦法， 使用 https-proxy-agent

const ccxt = require('ccxt')
const HttpsProxyAgent = require('https-proxy-agent')
const fetch = require('node-fetch')
const proxy = 'http://localhost:8123' // HTTP/HTTPS proxy to connect to
const agent = new HttpsProxyAgent(proxy)

const requestMethod = function(url, options) {
    return fetch(url, Object.assign({}, options, { agent: agent }))
}

let binance = new ccxt.binance({
    apiKey: '',
    secret: '',
    password: '',
    fetchImplementation: requestMethod
})
複製代碼

python 版本解決辦法

import ccxt
binance = ccxt.binance({
    'proxies': {
        'http': 'http://localhost:8123',
        'https': 'http://localhost:8123',
    },
})
複製代碼

這樣就能夠訪問到交易所 API， 能夠經過 API 進行交易了。

一些私有 API 訪問

一般， ccxt 只提供了一些通用函數， 可是交易所其餘獨有的 API 就沒有提供通用函數，

目前提供的函數：

loadMarkets            .           fetchBalance       |
    |       fetchMarkets           .            createOrder       |
    |       fetchCurrencies        .            cancelOrder       |
    |       fetchTicker            .             fetchOrder       |
    |       fetchTickers           .            fetchOrders       |
    |       fetchOrderBook         .        fetchOpenOrders       |
    |       fetchOHLCV             .      fetchClosedOrders       |
    |       fetchTrades            .          fetchMyTrades       |
    |                              .                deposit       |
    |                              .               withdraw 
複製代碼

好比咱們有一個 bitmex 批量下單的需求， 在 ccxt 通用函數中並無提供，看 bitmex.py 文件結構， 能夠看出

class bitmex (Exchange):

    def describe(self):
        return self.deep_extend(super(bitmex, self).describe(), {
            'id': 'bitmex',
            '...': '...',
            'api': {
                'public': {
                    'get': [
                    ],
                },
                'private': {
                    'get': [
                    ],
                    'post': [
                        'order/bulk',
                    ],
                    'put': [
                    ],
                    'delete': [
                    ],
                },
            },
複製代碼

調用自定義 API 的方式應該是

# public/private + get/post + path, 駝峯編碼
bitmex.privatePostOrderBulk(params={'orders': [params]})
複製代碼

總結

以上即是 ccxt 的一點簡單的總結， 主要是 ccxt 的跨語言的實現方式，國內代理，自定義 API 訪問等部分。 在給一個交易所適配ccxt的過程當中，最好找一個類似簽名的交易所， 將 js 文件複製到 ccxt/js/ 目錄， 修改信息，挨個替換函數實現及返回值數據結構處理， 測試無誤後提交 pull request， 等待維護者測試經過後， 就能夠 merge 啦