Documentation Powered by ReDoc

CCXT REST (2.5.0)

Download OpenAPI specification:Download

Adroit: hello@adroit.ph URL: https://adroit.ph/ccxt-rest-contact-us/ License: MIT

Authentication

bearerAuth

Security scheme type: HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Authentication API

APIs that manage creation / deletion / retrieving of exchange connections.

Most Public Data APIs by most exchanges can be used without providing the API Key and Secret.

For example, you get retrieve the market of binance by doing GET:/exchange/binance/market directly and would be able to get the markets of binance.

But some exchanges though would require you to use an API Key and Secret even when accessing their Public Data API. For example, for cointiger, if you want to retrieve its market and you do GET:/exchange/cointiger/market, you will a 403 error (i.e. meaning you were unauthorized to access it). Thus, to use that api of continger, you would first have to provide your API Key and Secret to continger via POST:/exchange/continger -d {"id":"myCoinTiger","apiKey":"My-COINTIGER-KEY","secret":"s3cret"}. From there, you will get a response {"token":"xxx.yyy.zzz"}. That "xxx.yyy.zzz" would then what you will use to connect to coiniger - i.e. GET:/exchange/cointiger/market -H "Authorization: Bearer xxx.yyy.zzz" and this time, your request will push through and would be able to get cointiger's market.

Furthemore, all Private Data APIs of all exchanges would require API Key and Secret. Thus, although GET:/exchange/binance/market would work, doing GET:/exchange/binance/balances will not. You'd have to provide first binance your API Key and Secret like POST:/exchange/binance -d {"id":"myBinance","apiKey":"binance-key","secret":"s3cret"}, to get something like {"token":"aaa.bbb.ccc"}, which you can then use to execute GET:/exchange/binance/balances -H "Authorization: Bearer aaa.bbb.ccc" which would finally get your balances.

getConnection

Retreives the current exchange connection details given the {exchangeName} and access token in the header

Authorizations:
bearerAuth
path Parameters
exchangeName
required
string (Exchange)
Enum:"_1btcxe" "acx" "anxpro" "aofex" "bcex" "bequant" "bibox" "bigone" "binance" "binanceje" "binanceus" "bit2c" "bitbank" "bitbay" "bitfinex" "bitfinex2" "bitflyer" "bitforex" "bithumb" "bitkk" "bitmart" "bitmax" "bitmex" "bitso" "bitstamp" "bitstamp1" "bittrex" "bitvavo" "bitz" "bl3p" "bleutrade" "braziliex" "btcalpha" "btcbox" "btcmarkets" "btctradeim" "btctradeua" "btcturk" "buda" "bw" "bybit" "bytetrade" "cex" "chilebit" "coinbase" "coinbaseprime" "coinbasepro" "coincheck" "coinegg" "coinex" "coinfalcon" "coinfloor" "coingi" "coinmarketcap" "coinmate" "coinone" "coinspot" "coolcoin" "coss" "crex24" "currencycom" "deribit" "digifinex" "dsx" "eterbase" "exmo" "exx" "fcoin" "fcoinjp" "flowbtc" "foxbit" "ftx" "fybse" "gateio" "gemini" "hbtc" "hitbtc" "hollaex" "huobipro" "huobiru" "ice3x" "idex" "independentreserve" "indodax" "itbit" "kkex" "kraken" "kucoin" "kuna" "lakebtc" "latoken" "lbank" "liquid" "livecoin" "luno" "lykke" "mercado" "mixcoins" "oceanex" "okcoin" "okex" "paymium" "poloniex" "probit" "qtrade" "rightbtc" "southxchange" "stex" "stronghold" "surbitcoin" "theocean" "therock" "tidebit" "tidex" "timex" "topq" "upbit" "vaultoro" "vbtc" "whitebit" "xbtce" "yobit" "zaif" "zb"

The name of the exchange. Possible values are any of the result of GET:/exchanges.

Responses

200

Success

404

Exchange with that name is NOT supported

500

If an unexpected error occurred

get /exchange/{exchangeName}
http://localhost:3000/exchange/{exchangeName}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "private": true,
  • "enableRateLimit": true,
  • "countries":
    [
    ],
  • "rateLimit": 0,
  • "twofa": false,
  • "has":
    {
    },
  • "urls": { }
}

createPrivateConnection

Creates a private connection to the exchange referenced in {exchangeName}

Authorizations:
bearerAuth
path Parameters
exchangeName
required
string (Exchange)
Enum:"_1btcxe" "acx" "anxpro" "aofex" "bcex" "bequant" "bibox" "bigone" "binance" "binanceje" "binanceus" "bit2c" "bitbank" "bitbay" "bitfinex" "bitfinex2" "bitflyer" "bitforex" "bithumb" "bitkk" "bitmart" "bitmax" "bitmex" "bitso" "bitstamp" "bitstamp1" "bittrex" "bitvavo" "bitz" "bl3p" "bleutrade" "braziliex" "btcalpha" "btcbox" "btcmarkets" "btctradeim" "btctradeua" "btcturk" "buda" "bw" "bybit" "bytetrade" "cex" "chilebit" "coinbase" "coinbaseprime" "coinbasepro" "coincheck" "coinegg" "coinex" "coinfalcon" "coinfloor" "coingi" "coinmarketcap" "coinmate" "coinone" "coinspot" "coolcoin" "coss" "crex24" "currencycom" "deribit" "digifinex" "dsx" "eterbase" "exmo" "exx" "fcoin" "fcoinjp" "flowbtc" "foxbit" "ftx" "fybse" "gateio" "gemini" "hbtc" "hitbtc" "hollaex" "huobipro" "huobiru" "ice3x" "idex" "independentreserve" "indodax" "itbit" "kkex" "kraken" "kucoin" "kuna" "lakebtc" "latoken" "lbank" "liquid" "livecoin" "luno" "lykke" "mercado" "mixcoins" "oceanex" "okcoin" "okex" "paymium" "poloniex" "probit" "qtrade" "rightbtc" "southxchange" "stex" "stronghold" "surbitcoin" "theocean" "therock" "tidebit" "tidex" "timex" "topq" "upbit" "vaultoro" "vbtc" "whitebit" "xbtce" "yobit" "zaif" "zb"

The name of the exchange. Possible values are any of the result of GET:/exchanges.

Request Body schema: application/json

The exchange to create.

id
required
string

The unique identifier for this exchange.

apiKey
string

The API key you got from the exchange itself. This with the secret is what will allow you to access the exchange

secret
string

The Secret key you got from the exchange itself. This with the apiKey is what will allow you to access the exchange

enableRateLimit
boolean
Default: true

Whether to enable the built in rate limiter or not. The built in rate limiter is an approximation of the actual exchange's limit. To have a more accurate rate limiting, set this to false and implement the rate limiter on your client

Responses

200

Success

404

Exchange with that name is NOT supported

500

If an unexpected error occurred

503

Support for exchange is currently broken

post /exchange/{exchangeName}
http://localhost:3000/exchange/{exchangeName}

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "apiKey": "string",
  • "secret": "string",
  • "enableRateLimit": true
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "token": "string"
}

deletePrivateConnection

Delete the exchange connection referenced by access token in the header

Authorizations:
bearerAuth
path Parameters
exchangeName
required
string (Exchange)
Enum:"_1btcxe" "acx" "anxpro" "aofex" "bcex" "bequant" "bibox" "bigone" "binance" "binanceje" "binanceus" "bit2c" "bitbank" "bitbay" "bitfinex" "bitfinex2" "bitflyer" "bitforex" "bithumb" "bitkk" "bitmart" "bitmax" "bitmex" "bitso" "bitstamp" "bitstamp1" "bittrex" "bitvavo" "bitz" "bl3p" "bleutrade" "braziliex" "btcalpha" "btcbox" "btcmarkets" "btctradeim" "btctradeua" "btcturk" "buda" "bw" "bybit" "bytetrade" "cex" "chilebit" "coinbase" "coinbaseprime" "coinbasepro" "coincheck" "coinegg" "coinex" "coinfalcon" "coinfloor" "coingi" "coinmarketcap" "coinmate" "coinone" "coinspot" "coolcoin" "coss" "crex24" "currencycom" "deribit" "digifinex" "dsx" "eterbase" "exmo" "exx" "fcoin" "fcoinjp" "flowbtc" "foxbit" "ftx" "fybse" "gateio" "gemini" "hbtc" "hitbtc" "hollaex" "huobipro" "huobiru" "ice3x" "idex" "independentreserve" "indodax" "itbit" "kkex" "kraken" "kucoin" "kuna" "lakebtc" "latoken" "lbank" "liquid" "livecoin" "luno" "lykke" "mercado" "mixcoins" "oceanex" "okcoin" "okex" "paymium" "poloniex" "probit" "qtrade" "rightbtc" "southxchange" "stex" "stronghold" "surbitcoin" "theocean" "therock" "tidebit" "tidex" "timex" "topq" "upbit" "vaultoro" "vbtc" "whitebit" "xbtce" "yobit" "zaif" "zb"

The name of the exchange. Possible values are any of the result of GET:/exchanges.

Responses

200

Success

404

Exchange with that name is NOT supported

500

If an unexpected error occurred

delete /exchange/{exchangeName}
http://localhost:3000/exchange/{exchangeName}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "private": true,
  • "enableRateLimit": true,
  • "countries":
    [
    ],
  • "rateLimit": 0,
  • "twofa": false,
  • "has":
    {
    },
  • "urls": { }
}

Exchange Management API

APIs for retrieving supported exchanges

list

List all support exchanges by this server

Responses

200

Success

500

If an unexpected error occurred

get /exchanges
http://localhost:3000/exchanges

Response samples

application/json
Copy
 Expand all Collapse all
[
  • "_1btcxe",
  • "acx",
  • "anxpro",
  • "anybits",
  • "bcex",
  • "bequant",
  • "bibox",
  • "bigone",
  • "binance",
  • "binanceje",
  • "bit2c",
  • "bitbank",
  • "bitbay",
  • "bitfinex",
  • "bitfinex2",
  • "bitflyer",
  • "bitforex",
  • "bithumb",
  • "bitibu",
  • "bitkk",
  • "bitlish",
  • "bitmarket",
  • "bitmex",
  • "bitsane",
  • "bitso",
  • "bitstamp",
  • "bitstamp1",
  • "bittrex",
  • "bitz",
  • "bl3p",
  • "bleutrade",
  • "braziliex",
  • "btcalpha",
  • "btcbox",
  • "btcchina",
  • "btcexchange",
  • "btcmarkets",
  • "btctradeim",
  • "btctradeua",
  • "btcturk",
  • "buda",
  • "bxinth",
  • "ccex",
  • "cex",
  • "chbtc",
  • "chilebit",
  • "cobinhood",
  • "coinbase",
  • "coinbaseprime",
  • "coinbasepro",
  • "coincheck",
  • "coinegg",
  • "coinex",
  • "coinexchange",
  • "coinfalcon",
  • "coinfloor",
  • "coingi",
  • "coinmarketcap",
  • "coinmate",
  • "coinnest",
  • "coinone",
  • "coinspot",
  • "cointiger",
  • "coolcoin",
  • "coss",
  • "crex24",
  • "crypton",
  • "cryptopia",
  • "deribit",
  • "dsx",
  • "ethfinex",
  • "exmo",
  • "exx",
  • "fcoin",
  • "fcoinjp",
  • "flowbtc",
  • "foxbit",
  • "fybse",
  • "fybsg",
  • "gateio",
  • "gdax",
  • "gemini",
  • "getbtc",
  • "hadax",
  • "hitbtc",
  • "hitbtc2",
  • "huobipro",
  • "huobiru",
  • "ice3x",
  • "independentreserve",
  • "indodax",
  • "itbit",
  • "jubi",
  • "kkex",
  • "kraken",
  • "kucoin",
  • "kucoin2",
  • "kuna",
  • "lakebtc",
  • "lbank",
  • "liqui",
  • "liquid",
  • "livecoin",
  • "luno",
  • "lykke",
  • "mandala",
  • "mercado",
  • "mixcoins",
  • "negociecoins",
  • "nova",
  • "okcoincny",
  • "okcoinusd",
  • "okex",
  • "paymium",