EricJJ' Blog

写代码

加密货币交易所如何接入 ccxt

2019-05-15

  1. 1. 原理介绍
  2. 2. 使用
  3. 3. 一些私有 API 访问
  4. 4. 总结

原理介绍

之前在北京 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提供 fetchOrderBookfetchBalancecreateOrder等交易的函数,来处理不同交易所的参数提交, 并且会解析函数调用后的返回值,转换成统一的数据结构返回。 不用担心 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 啦

This article was last updated on days ago, and the information described in the article may have changed.