www.npmjs.com Open in urlscan Pro
2606:4700::6811:dfaf  Public Scan

Form analysis
1 forms found in the DOM

GET /search

<form id="search" method="GET" action="/search" class="_13c93d41 relative flex bg-transparent ph3 ph2 pv2 ph0-ns pv0-ns bt b--black-10 bn-ns">
  <div class="e82b10fd relative dde91b96">
    <div class="_2f299eeb nowrap flex"><span class="_705cdf4f db fl pl3 pr1"><svg width="15px" height="15px" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 18 18" aria-hidden="true">
          <g stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
            <g stroke="#777777" stroke-width="1.3">
              <g>
                <path d="M13.4044,7.0274 C13.4044,10.5494 10.5494,13.4044 7.0274,13.4044 C3.5054,13.4044 0.6504,10.5494 0.6504,7.0274 C0.6504,3.5054 3.5054,0.6504 7.0274,0.6504 C10.5494,0.6504 13.4044,3.5054 13.4044,7.0274 Z"></path>
                <path d="M11.4913,11.4913 L17.8683,17.8683"></path>
              </g>
            </g>
          </g>
        </svg></span><input type="search" role="combobox" name="q" hotkeys="[object Object]" placeholder="Search packages" aria-label="Search packages" aria-controls="typeahead-list-20358" aria-expanded="false" aria-activedescendant=""
        inputref="[object Object]" autocomplete="off" class="_390acbc5 f5 fw3 black relative" value="" element="input"></div>
  </div><button type="submit" class="_0da775bb bn pv2 ph4 f6 white pointer bn pv2 ph4 f6 white pointer" aria-label="Search">Search</button><input type="hidden" name="csrftoken" value="kfYw0w9Fj84SYjMgNKVcmN-SrxEMxGME5fwMyO2tdkl">
</form>

Text Content

skip to:contentpackage searchsign in
❤
 * Pro
 * Teams
 * Pricing
 * Documentation

npm


Search
Sign UpSign In


CCXT-REST

2.5.0 • Public • Published 4 years ago
 * Readme
 * Code Beta
 * 20 Dependencies
 * 0 Dependents
 * 17 Versions

ccxt-rest.io

Connect to 100+ Crypto Currency eXchange Trading platforms using the same REST
API!








TABLE OF CONTENTS

 * Table of Contents
 * Introduction
 * Installation
   * Docker
   * NPM Package
 * Getting Started
   * Providing API Keys and Secret
   * List All Supported Currency Pairs
   * Get Ticker for a Currency Pair
   * Get Order Book for a Currency Pair
   * Placing an Order
   * Cancelling an Order
 * API
 * Exchange Summary
 * Feature / Support Request


INTRODUCTION

CCXT-REST provides a Unified REST APIs to allow clients access to retrieve data
(ticker, order book, trades, your order, your trades, balances, etc) and to
create and cancel orders from over 100 cryptocurrency exhange sites. And it is
built on top of the popular open source project CCXT


INSTALLATION

You can install either through docker or as a global node package


DOCKER

$ docker run -p 3000:3000 ccxtrest/ccxt-rest


NPM PACKAGE

$ npm install -g ccxt-rest
$ ccxt-rest


GETTING STARTED

CCXT-REST supports over 100 crytpocurrency exchange sites. If you want to access
public data, for most exchanges, you can access them directly without any API
Keys or Secret.

 * GET:/exchanges/{exchangeName}/markets
 * GET:/exchanges/{exchangeName}/ticker
 * GET:/exchanges/{exchangeName}/tickers
 * GET:/exchanges/{exchangeName}/orderBook
 * GET:/exchanges/{exchangeName}/trades

In binance, it would look something like this

 * GET:/exchanges/binance/markets
 * GET:/exchanges/binance/ticker?symbol=BTC/USDT
 * GET:/exchanges/binance/tickers
 * GET:/exchanges/binance/orderBook?symbol=BTC/USDT
 * GET:/exchanges/binance/trades?symbol=BTC/USDT

However, some exchanges though require you to have an API Key and Secret even
when accessing public data. For example, for cointiger, you would need to get an
API Key and Secret first from cointiger see cointiger's official documentation
for more info, and then you would need to provide those to ccxt-rest

 * POST:/exchanges/cointiger -d
   {"id":"myCoinTiger","apiKey":"myApiKey","secret":"$hcreT"}
 * GET:/exchanges/cointiger/markets -H 'Authorization: Bearer xxx.yyy.zzz'(where
   xxx.yyy.zzz was part of the response of POST:/exchanges/cointiger)
 * GET:/exchanges/cointiger/ticker?symbol=BTC/LTC -H 'Authorization: Bearer
   xxx.yyy.zzz'
 * GET:/exchanges/cointiger/tickers -H 'Authorization: Bearer xxx.yyy.zzz'
 * GET:/exchanges/cointiger/orderBook?symbol=BTC/LTC -H 'Authorization: Bearer
   xxx.yyy.zzz'
 * GET:/exchanges/cointiger/trades?symbol=BTC/LTC -H 'Authorization: Bearer
   xxx.yyy.zzz'

Lastly, for private data like your user orders, trades, balances and for actions
like placing and cancelling orders, you would definitely need to provide the API
Key and Secret for your exchange to ccxt-rest.



--------------------------------------------------------------------------------

Note: The API listing below is now comprehensive. For a full list of APIs
supported, see https://ccxt-rest.io

--------------------------------------------------------------------------------


PROVIDING API KEYS AND SECRET

$ curl -X POST http://localhost:3000/exchange/binance \
  -H 'Accept: application/json'
  -d {
    "id" : "myBinance",
    "apiKey" : "myApiKey",
    "secret" : "s3cr3t"
  }

This would then return something like this

{
  "token":"xxx.yyy.zzz"
}



LIST ALL SUPPORTED CURRENCY PAIRS

$ curl -X GET http://localhost:3000/exchange/binance/markets \
  -H 'Accept: application/json'


GET TICKER FOR A CURRENCY PAIR

$ curl -X GET http://localhost:3000/exchange/binance/ticker?symbol=BTC/USDT \
  -H 'Accept: application/json'


GET ORDER BOOK FOR A CURRENCY PAIR

$ curl -X GET http://localhost:3000/exchange/binance/orderBook?symbol=BTC/USDT \
  -H 'Accept: application/json'


PLACING AN ORDER

$ curl -X POST http://localhost:3000/exchange/binance/order \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer xxx.yyy.zzz'
  -d {
  "symbol": "string",
  "type": "market",
  "side": "buy",
  "amount": 0,
  "price": 0
}


CANCELLING AN ORDER

Note: 12345 is the id of the order you want to cancel

$ curl -X DELETE http://localhost:3000/exchange/binance/order/12345 \
  -H 'Accept: application/json'
  -H 'Authorization: Bearer xxx.yyy.zzz'


API

For a complete list of API, see https://ccxt-rest.io




EXCHANGE SUMMARY

For a full list of supported exchanges and as to which of their APIs are public,
private or even broken, checkout https://ccxt-rest.io/docs/exchange_api_status.
The format there looks something like this

Note: The table below is just an example. This does NOT represent the current
state of these API statuses

Exchange Connect Market Ticker Tickers Order Book Trades ... ... ... ... ... ...
... (sample only) (sample only) (sample only) (sample only) (sample only)
(sample only) (sample only) binance coinspot gemini kraken poloniex (sample
only) (sample only) (sample only) (sample only) (sample only) (sample only)
(sample only) ... ... ... ... ... ... ...

Note: The table above is just an example. This does NOT represent the current
state of these API statuses

For full list of the current statuses, see
https://ccxt-rest.io/docs/exchange_api_status


FEATURE / SUPPORT REQUEST

Need a feature or need support? Reach out and let us know what you need.




README


KEYWORDS

 * algorithmic
 * algotrading
 * altcoin
 * altcoins
 * api
 * arbitrage
 * real-time
 * realtime
 * backtest
 * backtesting
 * bitcoin
 * bot
 * btc
 * cny
 * coin
 * coins
 * crypto
 * cryptocurrency
 * crypto currency
 * crypto market
 * currency
 * currencies
 * darkcoin
 * dash
 * digital currency
 * doge
 * dogecoin
 * e-commerce
 * etc
 * eth
 * ether
 * ethereum
 * exchange
 * exchanges
 * eur
 * framework
 * invest
 * investing
 * investor
 * library
 * light
 * litecoin
 * ltc
 * market
 * market data
 * markets
 * merchandise
 * merchant
 * minimal
 * ohlcv
 * order
 * orderbook
 * order book
 * price
 * price data
 * pricefeed
 * private
 * public
 * ripple
 * strategy
 * ticker
 * tickers
 * toolkit
 * trade
 * trader
 * trading
 * usd
 * volume
 * websocket
 * websockets
 * web socket
 * web sockets
 * ws
 * xbt
 * xrp
 * zec
 * zerocoin
 * 1Broker
 * 1BTCXE
 * ACX
 * acx.io
 * allcoin
 * allcoin.com
 * ANX
 * ANXPro
 * bibox
 * bibox.com
 * Binance
 * binance.com
 * bit2c.co.il
 * Bit2C
 * BitBay
 * BitBays
 * bitcoincoid
 * Bitcoin.co.id
 * Bitfinex
 * bitFLyer
 * bitflyer.jp
 * bithumb
 * bithumb.com
 * bitlish
 * BitMarket
 * BitMEX
 * Bitso
 * Bitstamp
 * Bittrex
 * BL3P
 * Bleutrade
 * bleutrade.com
 * BlinkTrade
 * braziliex
 * braziliex.com
 * BtcBox
 * btcbox.co.jp
 * BTCC
 * BTCChina
 * BTC-e
 * BTCe
 * BTCExchange
 * btcexchange.ph
 * BTC Markets
 * btcmarkets
 * btcmarkets.net
 * BTCTrader
 * btctrader.com
 * btc-trade.com.ua
 * BTC Trade UA
 * BTCTurk
 * btcturk.com
 * BTCX
 * btc-x
 * bter
 * Bter.com
 * BX.in.th
 * ccex
 * C-CEX
 * cex
 * CEX.IO
 * CHBTC
 * ChileBit
 * chilebit.net
 * coincheck
 * CoinExchange
 * coinexchange.io
 * coingi
 * coingi.com
 * CoinMarketCap
 * CoinMate
 * Coinsecure
 * CoinSpot
 * coinspot.com.au
 * Crypto Capital
 * cryptocapital.co
 * DSX
 * dsx.uk
 * EXMO
 * flowBTC
 * flowbtc.com
 * FoxBit
 * foxbit.exchange
 * FYB-SE
 * FYB-SG
 * Gatecoin
 * GDAX
 * Gemini
 * HitBTC
 * Huobi
 * HuobiPRO
 * huobi.pro
 * Independent Reserve
 * independentreserve.com
 * itBit
 * jubi.com
 * Kraken
 * Kucoin
 * Kuna
 * LakeBTC
 * lakebtc.com
 * LiveCoin
 * Liqui
 * liqui.io
 * luno
 * mercado
 * MercadoBitcoin
 * mercadobitcoin.br
 * mixcoins
 * mixcoins.com
 * nova
 * novaexchange
 * novaexchange.com
 * OKCoin
 * OKCoin.com
 * OKCoin.cn
 * OKEX
 * okex.com
 * Paymium
 * Poloniex
 * QuadrigaCX
 * Qryptos
 * QUOINEX
 * Southxchange
 * SurBitcoin
 * surbitcoin.com
 * Tidex
 * tidex.com
 * TheRockTrading
 * UrduBit
 * urdubit.com
 * Vaultoro
 * VBTC
 * vbtc.exchange
 * vbtc.vn
 * VirWoX
 * WEX
 * wex.nz
 * xBTCe
 * xbtce.com
 * YoBit
 * yobit.net
 * YUNBI
 * Zaif
 * ZB
 * 1btcxe.com
 * Allcoin
 * anxpro.com
 * anybits.com
 * Anybits
 * bcex.top
 * BCEX
 * Bibox
 * big.one
 * BigONE
 * bitbank.cc
 * bitbank
 * bitbay.net
 * bitfinex.com
 * bitFlyer
 * bitforex.com
 * Bitforex
 * Bithumb
 * bitibu.com
 * Bitibu
 * bitkk.com
 * bitkk
 * bitlish.com
 * Bitlish
 * bitmarket.pl
 * bitmarket.net
 * bitmex.com
 * bitsane.com
 * Bitsane
 * bitso.com
 * bitstamp.net
 * bittrex.com
 * bit-z.com
 * Bit-Z
 * bl3p.eu
 * bitonic.nl
 * Braziliex
 * btc-alpha.com
 * BTC-Alpha
 * btcchina.com
 * btctrade.im
 * BtcTrade.im
 * buda.com
 * Buda
 * bx.in.th
 * c-cex.com
 * cex.io
 * trade.chbtc.com
 * cobinhood.com
 * COBINHOOD
 * coinbase.com
 * Coinbase
 * prime.coinbase.com
 * Coinbase Prime
 * pro.coinbase.com
 * Coinbase Pro
 * coincheck.com
 * coinegg.com
 * CoinEgg
 * coinex.com
 * CoinEx
 * coinfalcon.com
 * CoinFalcon
 * coinfloor.co.uk
 * coinfloor
 * Coingi
 * coinmarketcap.com
 * coinmate.io
 * coinnest.co.kr
 * coinnest
 * coinone.co.kr
 * CoinOne
 * cointiger.pro
 * CoinTiger
 * coolcoin.com
 * CoolCoin
 * coss.io
 * COSS
 * crex24.com
 * CREX24
 * cryptonbtc.com
 * Crypton
 * deribit.com
 * Deribit
 * ethfinex.com
 * Ethfinex
 * exmo.me
 * exx.com
 * EXX
 * fcoin.com
 * FCoin
 * trader.flowbtc.com
 * fybse.se
 * fybsg.com
 * gatecoin.com
 * gate.io
 * Gate.io
 * gdax.com
 * gemini.com
 * getbtc.org
 * GetBTC
 * hadax.com
 * HADAX
 * hitbtc.com
 * Huobi Pro
 * huobi.com.ru
 * Huobi Russia
 * ice3x.com
 * ice3x.co.za
 * ICE3X
 * indodax.com
 * INDODAX
 * itbit.com
 * kkex.com
 * KKEX
 * kraken.com
 * kucoin.com
 * KuCoin
 * kuna.io
 * lbank.info
 * LBank
 * liquid.com
 * Liquid
 * livecoin.net
 * luno.com
 * lykke.com
 * Lykke
 * mercadobitcoin.com.br
 * Mercado Bitcoin
 * MixCoins
 * negociecoins.com.br
 * NegocieCoins
 * Novaexchange
 * okcoin.cn
 * OKCoin CNY
 * okcoin.com
 * OKCoin USD
 * paymium.com
 * poloniex.com
 * quadrigacx.com
 * rightbtc.com
 * RightBTC
 * southxchange.com
 * SouthXchange
 * stronghold.co
 * Stronghold
 * theocean.trade
 * The Ocean
 * therocktrading.com
 * tidebit.com
 * TideBit
 * uex.com
 * UEX
 * upbit.com
 * Upbit
 * vaultoro.com
 * virwox.com
 * yunbi.com
 * zaif.jp
 * zb.com
 * fcoinjp.com
 * FCoinJP
 * binance.je
 * Binance Jersey
 * bequant.io
 * Bequant
 * dx.exchange
 * DX.Exchange
 * oceanex.pro.com
 * OceanEx
 * flowbtc.com.br
 * foxbit.com.br
 * latoken.com
 * Latoken
 * bitmart.com
 * BitMart
 * digifinex.vip
 * DigiFinex
 * idex.market
 * IDEX
 * adara.io
 * Adara
 * binance.us
 * Binance US
 * whitebit.com
 * WhiteBit
 * bitmax.io
 * BitMax
 * bytetrade.com
 * ByteTrade
 * ftx.com
 * FTX
 * {hostname}
 * bw.com
 * stex.com
 * STEX
 * BW
 * timex.io
 * TimeX
 * bitz.com
 * topliq.com
 * TOP.Q
 * hollaex.com
 * HollaEx
 * bybit.com
 * Bybit
 * aofex.com
 * AOFEX
 * byte-trade.com
 * hbtc.com
 * HBTC
 * probit.com
 * ProBit
 * eterbase.com
 * ETERBASE
 * Eterbase
 * qtrade.io
 * qTrade
 * dsxglobal.com
 * bitvavo.com
 * Bitvavo
 * currency.com
 * Currency.com








PACKAGE SIDEBAR


INSTALL

npm i ccxt-rest


REPOSITORY

Gitgithub.com/ccxt-rest/ccxt-rest


HOMEPAGE

ccxt-rest.io


DOWNLOADSWEEKLY DOWNLOADS

15


VERSION

2.5.0


LICENSE

MIT


UNPACKED SIZE

138 MB


TOTAL FILES

563


ISSUES

15


PULL REQUESTS

27


LAST PUBLISH

4 years ago


COLLABORATORS

 * 

Try on RunKit
Report malware


FOOTER


SUPPORT

 * Help
 * Advisories
 * Status
 * Contact npm


COMPANY

 * About
 * Blog
 * Press


TERMS & POLICIES

 * Policies
 * Terms of Use
 * Code of Conduct
 * Privacy