OTC™ – Digital Trading Contract Library
A JavaScript / Python / PHP library for digital contract trading and e-commerce payments.
Install · Usage · Manual · FAQ · Examples · Contributing · Social
The OTC™ library is used to connect and trade with digital contract and payment processing services worldwide.
Supported Cryptocurrency Exchange Markets
The OTC™ library currently is fork of CCXT and supports the following 133 cryptocurrency exchange markets and trading APIs:
id | name | certified | ver | doc | countries | |
---|---|---|---|---|---|---|
_1btcxe | 1BTCXE | * | API | Panama | ||
acx | ACX | 2 | API | Australia | ||
allcoin | Allcoin | 1 | API | Canada | ||
anxpro | ANXPro | 2 | API | Japan, Singapore, Hong Kong, New Zealand | ||
anybits | Anybits | * | API | Ireland | ||
bcex | BCEX | 1 | API | China, Canada | ||
bibox | Bibox | 1 | API | China, US, South Korea | ||
bigone | BigONE | 2 | API | UK | ||
binance | Binance | * | API | Japan | ||
bit2c | Bit2C | * | API | Israel | ||
bitbank | bitbank | 1 | API | Japan | ||
bitbay | BitBay | * | API | Malta, EU | ||
bitfinex | Bitfinex | 1 | API | British Virgin Islands | ||
bitfinex2 | Bitfinex v2 | 2 | API | British Virgin Islands | ||
bitflyer | bitFlyer | 1 | API | Japan | ||
bitforex | Bitforex | 1 | API | China | ||
bithumb | Bithumb | * | API | South Korea | ||
bitibu | Bitibu | 2 | API | Cyprus | ||
bitkk | bitkk | 1 | API | China | ||
bitlish | Bitlish | 1 | API | UK, EU, Russia | ||
bitmarket | BitMarket | * | API | Poland, EU | ||
bitmex | BitMEX | 1 | API | Seychelles | ||
bitsane | Bitsane | * | API | Ireland | ||
bitso | Bitso | 3 | API | Mexico | ||
bitstamp | Bitstamp | 2 | API | UK | ||
bitstamp1 | Bitstamp v1 | 1 | API | UK | ||
bittrex | Bittrex | 1.1 | API | US | ||
bitz | Bit-Z | 2 | API | Hong Kong | ||
bl3p | BL3P | 1 | API | Netherlands, EU | ||
bleutrade | Bleutrade | 2 | API | Brazil | ||
braziliex | Braziliex | * | API | Brazil | ||
btcalpha | BTC-Alpha | 1 | API | US | ||
btcbox | BtcBox | 1 | API | Japan | ||
btcchina | BTCChina | 1 | API | China | ||
btcexchange | BTCExchange | * | API | Philippines | ||
btcmarkets | BTC Markets | * | API | Australia | ||
btctradeim | BtcTrade.im | * | API | Hong Kong | ||
btctradeua | BTC Trade UA | * | API | Ukraine | ||
btcturk | BTCTurk | * | API | Turkey | ||
buda | Buda | 2 | API | Argentina, Chile, Colombia, Peru | ||
bxinth | BX.in.th | * | API | Thailand | ||
ccex | C-CEX | * | API | Germany, EU | ||
cex | CEX.IO | * | API | UK, EU, Cyprus, Russia | ||
chbtc | CHBTC | 1 | API | China | ||
chilebit | ChileBit | 1 | API | Chile | ||
cobinhood | COBINHOOD | 1 | API | Taiwan | ||
coinbase | Coinbase | 2 | API | US | ||
coinbaseprime | Coinbase Prime | * | API | US | ||
coinbasepro | Coinbase Pro | * | API | US | ||
coincheck | coincheck | * | API | Japan, Indonesia | ||
coinegg | CoinEgg | * | API | China, UK | ||
coinex | CoinEx | 1 | API | China | ||
coinexchange | CoinExchange | * | API | India, Japan, South Korea, Vietnam, US | ||
coinfalcon | CoinFalcon | 1 | API | UK | ||
coinfloor | coinfloor | * | API | UK | ||
coingi | Coingi | * | API | Panama, Bulgaria, China, US | ||
coinmarketcap | CoinMarketCap | 1 | API | US | ||
coinmate | CoinMate | * | API | UK, Czech Republic, EU | ||
coinnest | coinnest | * | API | South Korea | ||
coinone | CoinOne | 2 | API | South Korea | ||
coinspot | CoinSpot | * | API | Australia | ||
cointiger | CoinTiger | 1 | API | China | ||
coolcoin | CoolCoin | * | API | Hong Kong | ||
crex24 | CREX24 | 2 | API | Estonia | ||
crypton | Crypton | 1 | API | EU | ||
cryptopia | Cryptopia | * | API | New Zealand | ||
deribit | Deribit | 1 | API | Netherlands | ||
dsx | DSX | 2 | API | UK | ||
ethfinex | Ethfinex | 1 | API | British Virgin Islands | ||
exmo | EXMO | 1 | API | Spain, Russia | ||
exx | EXX | * | API | China | ||
fcoin | FCoin | 2 | API | China | ||
flowbtc | flowBTC | 1 | API | Brazil | ||
foxbit | FoxBit | 1 | API | Brazil | ||
fybse | FYB-SE | * | API | Sweden | ||
fybsg | FYB-SG | * | API | Singapore | ||
gatecoin | Gatecoin | * | API | Hong Kong | ||
gateio | Gate.io | 2 | API | China | ||
gdax | GDAX | * | API | US | ||
gemini | Gemini | 1 | API | US | ||
getbtc | GetBTC | * | API | St. Vincent & Grenadines, Russia | ||
hadax | HADAX | 1 | API | China | ||
hitbtc | HitBTC | 1 | API | Hong Kong | ||
hitbtc2 | HitBTC v2 | 2 | API | Hong Kong | ||
huobi | Huobi | 3 | API | China | ||
huobicny | Huobi CNY | 1 | API | China | ||
huobipro | Huobi Pro | 1 | API | China | ||
ice3x | ICE3X | 1 | API | South Africa | ||
independentreserve | Independent Reserve | * | API | Australia, New Zealand | ||
indodax | INDODAX | 1.8 | API | Indonesia | ||
itbit | itBit | 1 | API | US | ||
jubi | jubi.com | 1 | API | China | ||
kkex | KKEX | 2 | API | China, US, Japan | ||
kraken | Kraken | 0 | API | US | ||
kucoin | Kucoin | 1 | API | Hong Kong | ||
kuna | Kuna | 2 | API | Ukraine | ||
lakebtc | LakeBTC | 2 | API | US | ||
lbank | LBank | 1 | API | China | ||
liqui | Liqui | 3 | API | Ukraine | ||
liquid | Liquid | 2 | API | Japan, China, Taiwan | ||
livecoin | LiveCoin | * | API | US, UK, Russia | ||
luno | luno | 1 | API | UK, Singapore, South Africa | ||
lykke | Lykke | 1 | API | Switzerland | ||
mercado | Mercado Bitcoin | 3 | API | Brazil | ||
mixcoins | MixCoins | 1 | API | UK, Hong Kong | ||
negociecoins | NegocieCoins | 3 | API | Brazil | ||
nova | Novaexchange | 2 | API | Tanzania | ||
okcoincny | OKCoin CNY | 1 | API | China | ||
okcoinusd | OKCoin USD | 1 | API | China, US | ||
okex | OKEX | 1 | API | China, US | ||
paymium | Paymium | 1 | API | France, EU | ||
poloniex | Poloniex | * | API | US | ||
qryptos | QRYPTOS | 2 | API | Japan, China, Taiwan | ||
quadrigacx | QuadrigaCX | 2 | API | Canada | ||
quoinex | QUOINEX | 2 | API | Japan, China, Taiwan | ||
rightbtc | RightBTC | * | API | United Arab Emirates | ||
southxchange | SouthXchange | * | API | Argentina | ||
surbitcoin | SurBitcoin | 1 | API | Venezuela | ||
theocean | The Ocean | 0 | API | US | ||
therock | TheRockTrading | 1 | API | Malta | ||
tidebit | TideBit | 2 | API | Hong Kong | ||
tidex | Tidex | 3 | API | UK | ||
uex | UEX | 1.0.3 | API | Singapore, US | ||
urdubit | UrduBit | 1 | API | Pakistan | ||
vaultoro | Vaultoro | 1 | API | Switzerland | ||
vbtc | VBTC | 1 | API | Vietnam | ||
virwox | VirWoX | * | API | Austria, EU | ||
wex | WEX | 3 | API | New Zealand | ||
xbtce | xBTCe | 1 | API | Russia | ||
yobit | YoBit | 3 | API | Russia | ||
yunbi | YUNBI | 2 | API | China | ||
zaif | Zaif | 1 | API | Japan | ||
zb | ZB | 1 | API | China |
The list above is updated frequently, new crypto markets, altcoin exchanges, bug fixes, API endpoints are introduced and added on a regular basis. See the Manual for details. If you don't find a cryptocurrency exchange market in the list above and/or want another exchange to be added, post or send us a link to it by opening an issue here on GitHub or via email.
The library is under MIT license, that means it's absolutely free for any developer to build commercial and opensource software on top of it, but use it at your own risk with no warranties, as is.
Install
The easiest way to install the otc library is to use builtin package managers:
- otc in NPM (JavaScript / Node v7.6+)
- otc in PyPI (Python 2 and 3.5.3+)
- otc in Packagist/Composer (PHP 5.4+)
This library is shipped as an all-in-one module implementation with minimalistic dependencies and requirements:
You can also clone it into your project directory from otc GitHub repository:
git clone https://github.com/otctechnology/otc.git
An alternative way of installing this library into your code is to copy a single file manually into your working directory with language extension appropriate for your environment.
JavaScript (NPM)
JavaScript version of OTCX works both in Node and web browsers. Requires ES6 and async/await
syntax support (Node 7.6.0+). When compiling with Webpack and Babel, make sure it is not excluded in your babel-loader
config.
npm install otc
var otc = require ('otc')
console.log (otc.exchanges) // print all available exchanges
<script>
tag):
JavaScript (for use with the All-in-one browser bundle (dependencies included), served from unpkg CDN, which is a fast, global content delivery network for everything on NPM.
<script type="text/javascript" src="https://unpkg.com/otc"></script>
Creates a global otc
object:
console.log (otc.exchanges) // print all available exchanges
Python
pip install otc
import otc
print(otc.exchanges) # print a list of all available exchange classes
The library supports concurrent asynchronous mode with asyncio and async/await in Python 3.5.3+
import otc.async_support as otc # link against the asynchronous version of otc
PHP
otc in PHP with Packagist/Composer (PHP 5.4+)
It requires common PHP modules:
- cURL
- mbstring (using UTF-8 is highly recommended)
- PCRE
- iconv
- gmp (this is a built-in extension as of PHP 7.2+)
include "otc.php";
var_dump (\otc\Exchange::$exchanges); // print a list of all available exchange classes
Documentation
Read the Manual for more details.
Usage
Intro
The otc library consists of a public part and a private part. Anyone can use the public part out-of-the-box immediately after installation. Public APIs open access to public information from all exchange markets without registering user accounts and without having API keys.
For trading with private APIs you need to obtain API keys from/to exchange markets. It often means registering with exchanges and creating API keys with your account. Most exchanges require personal info or identification. Some kind of verification may be necessary as well. If you want to trade you need to register yourself, this library will not create accounts or API keys for you. Some exchange APIs expose interface methods for registering an account from within the code itself, but most of exchanges don't. You have to sign up and create API keys with their websites.
Private APIs allow the following:
- manage personal account info
- query account balances
- trade by making market and limit orders
- deposit and withdraw fiat and crypto funds
- query personal orders
- get ledger history
- transfer funds between accounts
- use merchant services
This library implements full public and private REST APIs for all exchanges. WebSocket and FIX implementations in JavaScript, PHP, Python and other languages coming soon.
The otc library supports both camelcase notation (preferred in JavaScript) and underscore notation (preferred in Python and PHP), therefore all methods can be called in either notation or coding style in any language.
// both of these notations work in JavaScript/Python/PHP
exchange.methodName () // camelcase pseudocode
exchange.method_name () // underscore pseudocode
Read the Manual for more details.
Feed - CryptoCompare
We are getting free cryptocurrency live pricing data, OHLC historical data, volume data, tick data or block explorer data from multiple exchanges and blockchains. We have integrated with over 90 exchanges, 1800 coins and have over 22,000 trading pairs listed. Whether you are looking for live streaming data or historical tick data we are the one-stop shop for the whole cryptocurrency space.
JavaScript
'use strict';
const otc = require ('otc');
(async function () {
let kraken = new otc.kraken ()
let bitfinex = new otc.bitfinex ({ verbose: true })
let huobi = new otc.huobi ()
let okcoinusd = new otc.okcoinusd ({
apiKey: 'YOUR_PUBLIC_API_KEY',
secret: 'YOUR_SECRET_PRIVATE_KEY',
})
const exchangeId = 'binance'
, exchangeClass = otc[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 (huobi.id, await huobi.loadMarkets ())
console.log (kraken.id, await kraken.fetchOrderBook (kraken.symbols[0]))
console.log (bitfinex.id, await bitfinex.fetchTicker ('BTC/USD'))
console.log (huobi.id, await huobi.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 otc
hitbtc = otc.hitbtc({'verbose': True})
bitmex = otc.bitmex()
huobi = otc.huobi()
exmo = otc.exmo({
'apiKey': 'YOUR_PUBLIC_API_KEY',
'secret': 'YOUR_SECRET_PRIVATE_KEY',
})
kraken = otc.kraken({
'apiKey': 'YOUR_PUBLIC_API_KEY',
'secret': 'YOUR_SECRET_PRIVATE_KEY',
})
exchange_id = 'binance'
exchange_class = getattr(otc, 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))
# 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 'otc.php';
$poloniex = new \otc\poloniex ();
$bittrex = new \otc\bittrex (array ('verbose' => true));
$quoinex = new \otc\quoinex ();
$zaif = new \otc\zaif (array (
'apiKey' => 'YOUR_PUBLIC_API_KEY',
'secret' => 'YOUR_SECRET_PRIVATE_KEY',
));
$hitbtc = new \otc\hitbtc (array (
'apiKey' => 'YOUR_PUBLIC_API_KEY',
'secret' => 'YOUR_SECRET_PRIVATE_KEY',
));
$exchange_id = 'binance';
$exchange_class = "\\otc\\$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'));
Contributing
Please read the CONTRIBUTING document before making changes that you would like adopted in the code. Also, read the Manual for more details.