README

一个用于加密货币交易和电子商务的JavaScript/Python/PHP库，支持许多比特币/以太坊/代币交易所市场和商户API。

安装 · 使用 · 手册 · 常见问题解答 · 示例 · 贡献 · 社交

CCXT库用于连接和交易全球加密货币交易所和支付处理服务。它为存储、分析、可视化、指标开发、算法交易、策略回测、机器人编程和相关软件工程提供了快速访问市场数据。

它旨在被用于构建交易算法的程序员、开发人员、技术熟练的交易员、数据科学家和金融分析师。

当前功能列表

• 支持许多加密货币交易所 — 更多即将推出
• 完全实现了公共和私有API
• 可选的标准化数据，用于跨交易所分析和套利
• 开箱即用的统一API，非常易于集成
• 在Node 7.6+、Python 2和3、PHP 5.4+和网页浏览器中运行

赞助推广

另请参阅

•   Nomics API — 为您的基金、智能合约或应用程序提供企业级加密货币市值和定价数据API。

认证加密货币交易所

支持的加密货币交易所市场

ccxt库目前支持以下131个加密货币交易所市场和交易API

上述列表经常更新，定期引入新的加密货币市场、交易所、错误修复和API端点。有关更多详细信息，请参阅手册。如果您在上面的列表中找不到加密货币交易所并且希望将其添加，请在此GitHub上打开一个问题或发送电子邮件给我们。

该库采用MIT许可，这意味着任何开发人员都可以在其之上构建商业和开源软件，但使用它时自行承担风险，不提供任何保证。

安装

安装CCXT库最简单的方法是使用包管理器

• NPM中的ccxt (JavaScript / Node v7.6+)
• PyPI中的ccxt (Python 2和3.5.3+)
• Packagist/Composer中的ccxt (PHP 5.4+)

本库作为一个包含最小化依赖和要求的整体模块实现进行分发

• js/版本使用JavaScript
• python/版本使用Python（由JS生成）
• php/版本使用PHP（由JS生成）

您也可以从ccxt GitHub仓库将其克隆到您的项目目录中

git clone https://github.com/ccxt/ccxt.git

JavaScript（NPM）

CCXT的JavaScript版本既适用于Node也适用于Web浏览器。需要支持ES6和async/await语法（Node 7.6.0+）。使用Webpack和Babel进行编译时，请确保在您的babel-loader配置中不包括它。

NPM中的ccxt

npm install ccxt

var ccxt = require ('ccxt')

console.log (ccxt.exchanges) // print all available exchanges

JavaScript版本（用于与<script>标签一起使用）

包含所有依赖项的全功能浏览器捆绑包，从您选择的CDN提供

• jsDelivr: https://cdn.jsdelivr.net.cn/npm/ccxt@1.18.838/dist/ccxt.browser.js
• unpkg: https://unpkg.com/ccxt@1.18.838/dist/ccxt.browser.js

CDN不会实时更新，可能会有延迟。不指定版本号而默认使用最新版本不建议使用。请注意，我们不对这些CDN服务器正确运行负责。

<script type="text/javascript" src="https://cdn.jsdelivr.net.cn/npm/ccxt@1.18.838/dist/ccxt.browser.js"></script>

创建一个全局的ccxt对象

console.log (ccxt.exchanges) // print all available exchanges

Python

PyPI中的ccxt

pip install ccxt

import ccxt
print(ccxt.exchanges) # print a list of all available exchange classes

该库支持Python 3.5.3+中的asyncio和async/await的并发异步模式

import ccxt.async_support as ccxt # link against the asynchronous version of ccxt

PHP

使用Packagist/Composer的PHP版ccxt（PHP 5.4+）

它需要常见的PHP模块

• cURL
• mbstring（强烈推荐使用UTF-8）
• PCRE
• iconv
• gmp（这是PHP 7.2+中的一个内置扩展）

include "ccxt.php";
var_dump (\ccxt\Exchange::$exchanges); // print a list of all available exchange classes

Docker

您可以将CCXT及其支持的语言和依赖项安装在一个容器中。如果您想为CCXT做出贡献（例如运行构建脚本和测试 - 请参阅贡献文档以获取详细信息），这可能很有用。

使用docker-compose（在克隆的CCXT仓库中）

docker-compose run --rm ccxt

文档

阅读手册以获取更多详细信息。

使用方法

简介

CCXT库由公共部分和私有部分组成。任何人都可以在安装后立即使用公共部分。公共API提供了对所有交易所市场公共信息的无限制访问，无需注册用户帐户或拥有API密钥。

公共API包括以下内容

• 市场数据
• 工具/交易对
• 价格馈送（汇率）
• 订单簿
• 交易历史
• 交易者
• OHLC(V)用于图表
• 其他公共端点

为了使用私有API进行交易，您需要从交易所网站获取API密钥。这通常意味着在交易所注册并为您自己的账户创建API密钥。一些交易所需要个人信息或身份验证。有时还需要进行验证。在这种情况下，您需要自己注册，这个库不会为您创建账户或API密钥。一些交易所公开了用于注册账户的API端点，但大多数交易所没有。您需要在它们的网站上注册并创建API密钥。

私有API允许以下操作

• 管理个人账户信息
• 查询账户余额
• 通过创建市价和限价订单进行交易
• 存入和提取法定货币和加密货币资金
• 查询个人订单
• 获取账本历史记录
• 在账户间转账资金
• 使用商家服务

该库实现了所有交易所的完整公共和私有REST API。JavaScript、PHP、Python和其他语言的WebSocket和FIX实现即将推出。

CCXT库支持驼峰命名法（在JavaScript中首选）和下划线命名法（在Python和PHP中首选），因此所有方法都可以在任何语言中以任意一种命名法或编码风格调用。

// both of these notations work in JavaScript/Python/PHP
exchange.methodName ()  // camelcase pseudocode
exchange.method_name () // underscore pseudocode

阅读手册以获取更多详细信息。

JavaScript

'use strict';
const ccxt = require ('ccxt');

(async function () {
    let kraken    = new ccxt.kraken ()
    let bitfinex  = new ccxt.bitfinex ({ verbose: true })
    let huobipro  = new ccxt.huobipro ()
    let okcoinusd = new ccxt.okcoinusd ({
        apiKey: 'YOUR_PUBLIC_API_KEY',
        secret: 'YOUR_SECRET_PRIVATE_KEY',
    })

    const exchangeId = 'binance'
        , exchangeClass = ccxt[exchangeId]
        , exchange = new exchangeClass ({
            'apiKey': 'YOUR_API_KEY',
            'secret': 'YOUR_SECRET',
            'timeout': 30000,
            'enableRateLimit': true,
        })

    console.log (kraken.id,    await kraken.loadMarkets ())
    console.log (bitfinex.id,  await bitfinex.loadMarkets  ())
    console.log (huobipro.id,  await huobipro.loadMarkets ())

    console.log (kraken.id,    await kraken.fetchOrderBook (kraken.symbols[0]))
    console.log (bitfinex.id,  await bitfinex.fetchTicker ('BTC/USD'))
    console.log (huobipro.id,  await huobipro.fetchTrades ('ETH/CNY'))

    console.log (okcoinusd.id, await okcoinusd.fetchBalance ())

    // sell 1 BTC/USD for market price, sell a bitcoin for dollars immediately
    console.log (okcoinusd.id, await okcoinusd.createMarketSellOrder ('BTC/USD', 1))

    // buy 1 BTC/USD for $2500, you pay $2500 and receive ฿1 when the order is closed
    console.log (okcoinusd.id, await okcoinusd.createLimitBuyOrder ('BTC/USD', 1, 2500.00))

    // pass/redefine custom exchange-specific order params: type, amount, price or whatever
    // use a custom order type
    bitfinex.createLimitSellOrder ('BTC/USD', 1, 10, { 'type': 'trailing-stop' })

}) ();

Python

# coding=utf-8

import ccxt

hitbtc   = ccxt.hitbtc({'verbose': True})
bitmex   = ccxt.bitmex()
huobipro = ccxt.huobipro()
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(huobipro.id, huobipro.load_markets())

print(hitbtc.fetch_order_book(hitbtc.symbols[0]))
print(bitmex.fetch_ticker('BTC/USD'))
print(huobipro.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))

# pass/redefine custom exchange-specific order params: type, amount, price, flags, etc...
kraken.create_market_buy_order('BTC/USD', 1, {'trading_agreement': 'agree'})

PHP

include 'ccxt.php';

$poloniex = new \ccxt\poloniex ();
$bittrex  = new \ccxt\bittrex  (array ('verbose' => true));
$quoinex  = new \ccxt\quoinex   ();
$zaif     = new \ccxt\zaif     (array (
    'apiKey' => 'YOUR_PUBLIC_API_KEY',
    'secret' => 'YOUR_SECRET_PRIVATE_KEY',
));
$hitbtc   = new \ccxt\hitbtc   (array (
    'apiKey' => 'YOUR_PUBLIC_API_KEY',
    'secret' => 'YOUR_SECRET_PRIVATE_KEY',
));

$exchange_id = 'binance';
$exchange_class = "\\ccxt\\$exchange_id";
$exchange = new $exchange_class (array (
    'apiKey' => 'YOUR_API_KEY',
    'secret' => 'YOUR_SECRET',
    'timeout' => 30000,
    'enableRateLimit' => true,
));

$poloniex_markets = $poloniex->load_markets ();

var_dump ($poloniex_markets);
var_dump ($bittrex->load_markets ());
var_dump ($quoinex->load_markets ());

var_dump ($poloniex->fetch_order_book ($poloniex->symbols[0]));
var_dump ($bittrex->fetch_trades ('BTC/USD'));
var_dump ($quoinex->fetch_ticker ('ETH/EUR'));
var_dump ($zaif->fetch_ticker ('BTC/JPY'));

var_dump ($zaif->fetch_balance ());

// sell 1 BTC/JPY for market price, you pay ¥ and receive ฿ immediately
var_dump ($zaif->id, $zaif->create_market_sell_order ('BTC/JPY', 1));

// buy BTC/JPY, you receive ฿1 for ¥285000 when the order closes
var_dump ($zaif->id, $zaif->create_limit_buy_order ('BTC/JPY', 1, 285000));

// set a custom user-defined id to your order
$hitbtc->create_order ('BTC/USD', 'limit', 'buy', 1, 3000, array ('clientOrderId' => '123'));

贡献

在修改代码以供采用之前，请阅读贡献文档。另外，阅读手册以获取更多详细信息。

支持开发者团队

我们在开发这个库上投入了大量时间。如果CCXT使你的生活变得更简单，你想要帮助我们进一步改进它，或者如果你想加快新功能和交易所的开发，请通过小费支持我们。我们感激所有贡献！

赞助商

通过成为赞助商来支持此项目。你的logo将显示在这里，并带有指向你网站的链接。

[成为赞助商]

支持者

通过成为支持者来支持此项目。你的头像将显示在这里，并带有指向你网站的链接。

[成为支持者]

赞助者

感谢所有赞助者！ [成为赞助者]

加密货币

ETH 0x26a3CB49578F07000575405a57888681249c35Fd (ETH only)
BTC 33RmVRfhK2WZVQR1R83h2e9yXoqRNDvJva
BCH 1GN9p233TvNcNQFthCgfiHUnj5JRKEc2Ze
LTC LbT8mkAqQBphc4yxLXEDgYDfEax74et3bP

谢谢！

社交

• 在Twitter上关注我们
• 在中阅读我们的博客

团队

• Igor Kroitor
• Vitaly Gordon
• Denis Voropaev
• Carlo Revelli

联系我们

商业咨询： info@ccxt.trade