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

200

application/json

Copy

Expand all Collapse all

{

"id": "string",
"name": "string",
"private": true,
"enableRateLimit": true,
"countries":
[
- "string"
],
"rateLimit": 0,
"twofa": false,
"has":
{
- "CORS": "true",
- "publicAPI": "true",
- "privateAPI": "true",
- "cancelOrder": "true",
- "cancelOrders": "true",
- "createDepositAddress": "true",
- "createOrder": "true",
- "createMarketOrder": "true",
- "createLimitOrder": "true",
- "editOrder": "true",
- "fetchBalance": "true",
- "fetchBidsAsks": "true",
- "fetchClosedOrders": "true",
- "fetchCurrencies": "true",
- "fetchDepositAddress": "true",
- "fetchFundingFees": "true",
- "fetchL2OrderBook": "true",
- "fetchMarkets": "true",
- "fetchMyTrades": "true",
- "fetchOHLCV": "true",
- "fetchOpenOrders": "true",
- "fetchOrder": "true",
- "fetchOrderBook": "true",
- "fetchOrderBooks": "true",
- "fetchOrders": "true",
- "fetchTicker": "true",
- "fetchTickers": "true",
- "fetchTrades": "true",
- "fetchTradingFees": "true",
- "fetchTradingLimits": "true",
- "withdraw": "true"
},
"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

Payload

application/json

Copy

Expand all Collapse all

{

"id": "string",
"apiKey": "string",
"secret": "string",
"enableRateLimit": true

}

Response samples

200

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

200

application/json

Copy

Expand all Collapse all

{

"id": "string",
"name": "string",
"private": true,
"enableRateLimit": true,
"countries":
[
- "string"
],
"rateLimit": 0,
"twofa": false,
"has":
{
- "CORS": "true",
- "publicAPI": "true",
- "privateAPI": "true",
- "cancelOrder": "true",
- "cancelOrders": "true",
- "createDepositAddress": "true",
- "createOrder": "true",
- "createMarketOrder": "true",
- "createLimitOrder": "true",
- "editOrder": "true",
- "fetchBalance": "true",
- "fetchBidsAsks": "true",
- "fetchClosedOrders": "true",
- "fetchCurrencies": "true",
- "fetchDepositAddress": "true",
- "fetchFundingFees": "true",
- "fetchL2OrderBook": "true",
- "fetchMarkets": "true",
- "fetchMyTrades": "true",
- "fetchOHLCV": "true",
- "fetchOpenOrders": "true",
- "fetchOrder": "true",
- "fetchOrderBook": "true",
- "fetchOrderBooks": "true",
- "fetchOrders": "true",
- "fetchTicker": "true",
- "fetchTickers": "true",
- "fetchTrades": "true",
- "fetchTradingFees": "true",
- "fetchTradingLimits": "true",
- "withdraw": "true"
},
"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

200

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",
"poloniex",
"rightbtc",
"southxchange",
"stronghold",
"surbitcoin",
"theocean",
"therock",
"tidebit",
"tidex",
"uex",
"upbit",
"urdubit",
"vaultoro",
"vbtc",
"virwox",
"xbtce",
"yobit",
"zaif",
"zb"

]

Public Data API

APIs that retrieve public data (like ticker, order books, trades, etc)

markets

Get the markets of the exchange referenced by the {exchangeName}.

Parameters listed here are common to all exchanges. But any other parameter passed would be forwarded as well into the exchange.

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

400

If the exchange itself complained about the parameters passed

401

If the exchange integration requires api key and secret for this function

403

If the exchange integration had an authentication issue (most probably nonce error)

404

Exchange with that name is NOT supported

500

If an unexpected error occurred

501

If the exchange integration does NOT support this function

504

If the exchange itself could not be reached because of some network error

get /exchange/{exchangeName}/markets

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

Response samples

200

application/json

Copy

Expand all Collapse all

[

{
- "id": "string",
- "symbol": "string",
- "base": "string",
- "quote": "string",
- "info": { },
- "lot": 0,
- "limits":
  {
  - "amount":
    {
    "min": 0,
    "max": 0
    },
  - "price":
    {
    "min": 0,
    "max": 0
    },
  - "cost":
    {
    "min": 0,
    "max": 0
    }
  },
- "precision":
  {
  - "amount": 0,
  - "price": 0
  }
}

]

orderBook

Get the order book of the exchange referenced by the {exchangeName} and ?symbol=.

Parameters listed here are common to all exchanges. But any other parameter passed would be forwarded as well into the exchange.

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.

query Parameters

symbol required	string The symbol of the exchange's data to be retrieved. Possible values are any of symbols in GET:/exchange/{exchangeName}/markets
limit	number The limit of the exchange's order book to be retrieved.
exchangeSpecificParams	object Any exchange specific parameters you want to pass in

Responses

200

Success

400

If the exchange itself complained about the parameters passed

401

If the exchange integration requires api key and secret for this function

403

If the exchange integration had an authentication issue (most probably nonce error)

404

Exchange with that name is NOT supported

500

If an unexpected error occurred

501

If the exchange integration does NOT support this function

504

If the exchange itself could not be reached because of some network error

get /exchange/{exchangeName}/orderBook

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

Response samples

200

application/json

Copy

Expand all Collapse all

[

{
- "bids":
  [
  - {
    "price": 0,
    "amount": 0
    }
  ],
- "asks":
  [
  - {
    "price": 0,
    "amount": 0
    }
  ],
- "timestamp": 0,
- "datetime": "2020-06-21T17:45:43Z"
}

]

l2OrderBook

Get the Level 2 Order Book of the exchange referenced by the {exchangeName} and ?symbol=.

Parameters listed here are common to all exchanges. But any other parameter passed would be forwarded as well into the exchange.

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.

query Parameters

symbol required	string The symbol of the exchange's data to be retrieved. Possible values are any of symbols in GET:/exchange/{exchangeName}/markets
limit	number The limit of the exchange's order book to be retrieved.
exchangeSpecificParams	object Any exchange specific parameters you want to pass in

Responses

200

Success

400

If the exchange itself complained about the parameters passed

401

If the exchange integration requires api key and secret for this function

403

If the exchange integration had an authentication issue (most probably nonce error)

404

Exchange with that name is NOT supported

500

If an unexpected error occurred

501

If the exchange integration does NOT support this function

504

If the exchange itself could not be reached because of some network error

get /exchange/{exchangeName}/l2OrderBook

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

Response samples

200

application/json

Copy

Expand all Collapse all

[

{
- "bids":
  [
  - {
    "price": 0,
    "amount": 0
    }
  ],
- "asks":
  [
  - {
    "price": 0,
    "amount": 0
    }
  ],
- "timestamp": 0,
- "datetime": "2020-06-21T17:45:43Z"
}

]

trades

Get the trades of the exchange referenced by the {exchangeName} and ?symbol=.

Parameters listed here are common to all exchanges. But any other parameter passed would be forwarded as well into the exchange.

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.

query Parameters

symbol required	string The symbol of the exchange's data to be retrieved. Possible values are any of symbols in GET:/exchange/{exchangeName}/markets
since	string Retrieve the trades starting from 'since'
limit	number The limit of the exchange's trades to be retrieved.
exchangeSpecificParams	object Any exchange specific parameters you want to pass in

Responses

200

Success

400

If the exchange itself complained about the parameters passed

401

If the exchange integration requires api key and secret for this function

403

If the exchange integration had an authentication issue (most probably nonce error)

404

Exchange with that name is NOT supported

500

If an unexpected error occurred

501

If the exchange integration does NOT support this function

504

If the exchange itself could not be reached because of some network error

get /exchange/{exchangeName}/trades

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

Response samples

200

application/json

Copy

Expand all Collapse all

[

{
- "id": "string",
- "info": { },
- "timestamp": 0,
- "symbol": "string",
- "side": "buy",
- "price": 0,
- "amount": 0
}

]

ticker

Get the ticker of the exchange referenced by the {exchangeName} and ?symbol=.

Parameters listed here are common to all exchanges. But any other parameter passed would be forwarded as well into the exchange.

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.

query Parameters

symbol required	string The symbol of the exchange's data to be retrieved. Possible values are any of symbols in GET:/exchange/{exchangeName}/markets
symbol required	string The symbol of the exchange's data to be retrieved. Possible values are any of symbols in GET:/exchange/{exchangeName}/markets
exchangeSpecificParams	object Any exchange specific parameters you want to pass in

Responses

200

Success

400

If the exchange itself complained about the parameters passed

401

If the exchange integration requires api key and secret for this function

403

If the exchange integration had an authentication issue (most probably nonce error)

404

Exchange with that name is NOT supported

500

If an unexpected error occurred

501

If the exchange integration does NOT support this function

504

If the exchange itself could not be reached because of some network error

get /exchange/{exchangeName}/ticker

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

Response samples

200

application/json

Copy

Expand all Collapse all

{

"symbol": "string",
"timestamp": 0,
"datetime": "2020-06-21T17:45:43Z",
"high": 0,
"low": 0,
"bid": 0,
"ask": 0,
"vwap": 0,
"close": 0,
"last": 0,
"baseVolume": 0,
"quoteVolume": 0,
"info": { }

}

tickers

Get the tickers of the exchange referenced by the {exchangeName} and ?symbol=.

Parameters listed here are common to all exchanges. But any other parameter passed would be forwarded as well into the exchange.

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.

query Parameters

symbol	string The symbol of the exchange's data to be retrieved. Possible values are any of symbols in GET:/exchange/{exchangeName}/markets
exchangeSpecificParams	object Any exchange specific parameters you want to pass in

Responses

200

Success

400

If the exchange itself complained about the parameters passed

401

If the exchange integration requires api key and secret for this function

403

If the exchange integration had an authentication issue (most probably nonce error)

404

Exchange with that name is NOT supported

500

If an unexpected error occurred

501

If the exchange integration does NOT support this function

504

If the exchange itself could not be reached because of some network error

get /exchange/{exchangeName}/tickers

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

Response samples

200

application/json

Copy

Expand all Collapse all

[

{
- "symbol": "string",
- "timestamp": 0,
- "datetime": "2020-06-21T17:45:43Z",
- "high": 0,
- "low": 0,
- "bid": 0,
- "ask": 0,
- "vwap": 0,
- "close": 0,
- "last": 0,
- "baseVolume": 0,
- "quoteVolume": 0,
- "info": { }
}

]

Private Data API

APIs that retrieve private data (like your balances, your open orders, your closed orders, your trades, etc)

balances

Get the balances of the exchange referenced by the {exchangeName}.

Parameters listed here are common to all exchanges. But any other parameter passed would be forwarded as well into the exchange.

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.

query Parameters

exchangeSpecificParams

object

Any exchange specific parameters you want to pass in

Responses

200

Success

400

If the exchange itself complained about the parameters passed

401

If the exchange integration requires api key and secret for this function

403

If the exchange integration had an authentication issue (most probably nonce error)

404

Exchange with that name is NOT supported

500

If an unexpected error occurred

501

If the exchange integration does NOT support this function

504

If the exchange itself could not be reached because of some network error

get /exchange/{exchangeName}/balances

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

Response samples

200

application/json

Copy

Expand all Collapse all

{

"info": { },
"balances":
[
- {
  - "currency": "string",
  - "free": 0,
  - "used": 0,
  - "total": 0
  }
]

}

fetchOrders

Get the orders of the exchange referenced by the {exchangeName}.

Parameters listed here are common to all exchanges. But any other parameter passed would be forwarded as well into the exchange.

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.

query Parameters

symbol	string The symbol of the exchange's data to be retrieved. Possible values are any of symbols in GET:/exchange/{exchangeName}/markets
since	string Retrieve the orders starting from 'since'
limit	number The limit of the exchange's orders to be retrieved.
exchangeSpecificParams	object Any exchange specific parameters you want to pass in

Responses

200

Success

400

If the exchange itself complained about the parameters passed

401

If the exchange integration requires api key and secret for this function

403

If the exchange integration had an authentication issue (most probably nonce error)

404

Exchange with that name is NOT supported

500

If an unexpected error occurred

501

If the exchange integration does NOT support this function

504

If the exchange itself could not be reached because of some network error

get /exchange/{exchangeName}/orders

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

Response samples

200

application/json

Copy

Expand all Collapse all

[

{
- "id": "string",
- "timestamp": 0,
- "datetime": "2020-06-21T17:45:43Z",
- "symbol": "string",
- "type": "market",
- "side": "buy",
- "price": 0,
- "amount": 0,
- "cost": 0,
- "filled": 0,
- "remaining": 0,
- "status": "open",
- "info": { }
}

]

fetchOpenOrders

Get the open orders of the exchange referenced by the {exchangeName}.

Parameters listed here are common to all exchanges. But any other parameter passed would be forwarded as well into the exchange.

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.

query Parameters

symbol	string The symbol of the exchange's data to be retrieved. Possible values are any of symbols in GET:/exchange/{exchangeName}/markets
since	string Retrieve the orders starting from 'since'
limit	number The limit of the exchange's orders to be retrieved.
exchangeSpecificParams	object Any exchange specific parameters you want to pass in

Responses

200

Success

400

If the exchange itself complained about the parameters passed

401

If the exchange integration requires api key and secret for this function

403

If the exchange integration had an authentication issue (most probably nonce error)

404

Exchange with that name is NOT supported

500

If an unexpected error occurred

501

If the exchange integration does NOT support this function

504

If the exchange itself could not be reached because of some network error

get /exchange/{exchangeName}/orders/open

http://localhost:3000/exchange/{exchangeName}/orders/open

Response samples

200

application/json

Copy

Expand all Collapse all

[

{
- "id": "string",
- "timestamp": 0,
- "datetime": "2020-06-21T17:45:43Z",
- "symbol": "string",
- "type": "market",
- "side": "buy",
- "price": 0,
- "amount": 0,
- "cost": 0,
- "filled": 0,
- "remaining": 0,
- "status": "open",
- "info": { }
}

]

fetchClosedOrders

Get the closed orders of the exchange referenced by the {exchangeName}.

Parameters listed here are common to all exchanges. But any other parameter passed would be forwarded as well into the exchange.

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.

query Parameters

symbol	string The symbol of the exchange's data to be retrieved. Possible values are any of symbols in GET:/exchange/{exchangeName}/markets
since	string Retrieve the orders starting from 'since'
limit	number The limit of the exchange's orders to be retrieved.
exchangeSpecificParams	object Any exchange specific parameters you want to pass in

Responses

200

Success

400

If the exchange itself complained about the parameters passed

401

If the exchange integration requires api key and secret for this function

403

If the exchange integration had an authentication issue (most probably nonce error)

404

Exchange with that name is NOT supported

500

If an unexpected error occurred

501

If the exchange integration does NOT support this function

504

If the exchange itself could not be reached because of some network error

get /exchange/{exchangeName}/orders/closed

http://localhost:3000/exchange/{exchangeName}/orders/closed

Response samples

200

application/json

Copy

Expand all Collapse all

[

{
- "id": "string",
- "timestamp": 0,
- "datetime": "2020-06-21T17:45:43Z",
- "symbol": "string",
- "type": "market",
- "side": "buy",
- "price": 0,
- "amount": 0,
- "cost": 0,
- "filled": 0,
- "remaining": 0,
- "status": "open",
- "info": { }
}

]

fetchMyTrades

Get my trades of the exchange referenced by the {exchangeName}.

Parameters listed here are common to all exchanges. But any other parameter passed would be forwarded as well into the exchange.

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.

query Parameters

symbol	string The symbol of the exchange's data to be retrieved. Possible values are any of symbols in GET:/exchange/{exchangeName}/markets
since	string Retrieve the trades starting from 'since'
limit	number The limit of the exchange's trades to be retrieved.
exchangeSpecificParams	object Any exchange specific parameters you want to pass in

Responses

200

Success

400

If the exchange itself complained about the parameters passed

401

If the exchange integration requires api key and secret for this function

403

If the exchange integration had an authentication issue (most probably nonce error)

404

Exchange with that name is NOT supported

500

If an unexpected error occurred

501

If the exchange integration does NOT support this function

504

If the exchange itself could not be reached because of some network error

get /exchange/{exchangeName}/trades/mine

http://localhost:3000/exchange/{exchangeName}/trades/mine

Response samples

200

application/json

Copy

Expand all Collapse all

[

{
- "id": "string",
- "info": { },
- "timestamp": 0,
- "symbol": "string",
- "side": "buy",
- "price": 0,
- "amount": 0
}

]

createOrder

Create an order on the exchange referenced by the {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 order to place.

symbol required	string The currency pair (base/quote) of the order to be created
type required	string (OrderType) Enum:"market" "limit" Whether this is a 'market' order or a 'limit' order
side required	string (Side) Enum:"buy" "sell" Wether this is a bid or ask (i.e. buy or sell) order
amount required	number The amount of currency pair's base that we want to buy or sell
price	number The buying price or the selling price in terms of the quote. Price is needed for market orders and ignored in limit orders
exchangeSpecificParams	object Exchange specific parameters

Responses

200

Success

400

If the exchange itself complained about the parameters passed

401

If the exchange integration requires api key and secret for this function

403

If the exchange integration had an authentication issue (most probably nonce error)

404

Exchange with that name is NOT supported

500

If an unexpected error occurred

501

If the exchange integration does NOT support this function

504

If the exchange itself could not be reached because of some network error

post /exchange/{exchangeName}/order

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

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"symbol": "string",
"type": "market",
"side": "buy",
"amount": 0,
"price": 0,
"exchangeSpecificParams": { }

}

Response samples

200

application/json

Copy

Expand all Collapse all

{

"id": "string",
"timestamp": 0,
"datetime": "2020-06-21T17:45:43Z",
"symbol": "string",
"type": "market",
"side": "buy",
"price": 0,
"amount": 0,
"cost": 0,
"filled": 0,
"remaining": 0,
"status": "open",
"info": { }

}

fetchOrder

Retrieves the information of an order on the exchange referenced by the {exchangeName} and {orderId}.

Parameters listed here are common to all exchanges. But any other parameter passed would be forwarded as well into the exchange.

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.

orderId

required

string

The id of the order. Possible values are any of the result of GET:/exchange/{exchangeName}/orders.

query Parameters

symbol	string The symbol of the exchange's data to be retrieved. Possible values are any of symbols in GET:/exchange/{exchangeName}/markets
exchangeSpecificParams	object Any exchange specific parameters you want to pass in

Responses

200

Success

400

If the exchange itself complained about the parameters passed

401

If the exchange integration requires api key and secret for this function

403

If the exchange integration had an authentication issue (most probably nonce error)

404

Exchange with that name is NOT supported

500

If an unexpected error occurred

501

If the exchange integration does NOT support this function

504

If the exchange itself could not be reached because of some network error

get /exchange/{exchangeName}/order/{orderId}

http://localhost:3000/exchange/{exchangeName}/order/{orderId}

Response samples

200

application/json

Copy

Expand all Collapse all

{

"id": "string",
"timestamp": 0,
"datetime": "2020-06-21T17:45:43Z",
"symbol": "string",
"type": "market",
"side": "buy",
"price": 0,
"amount": 0,
"cost": 0,
"filled": 0,
"remaining": 0,
"status": "open",
"info": { }

}

cancelOrder

Cancel an open order on the exchange referenced by the {exchangeName} and {orderId}.

Parameters listed here are common to all exchanges. But any other parameter passed would be forwarded as well into the exchange.

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.

orderId

required

string

The id of the order. Possible values are any of the result of GET:/exchange/{exchangeName}/orders.

query Parameters

symbol	string The symbol of the exchange's data to be retrieved. Possible values are any of symbols in GET:/exchange/{exchangeName}/markets
exchangeSpecificParams	object Any exchange specific parameters you want to pass in

Responses

200

Success

400

If the exchange itself complained about the parameters passed

401

If the exchange integration requires api key and secret for this function

403

If the exchange integration had an authentication issue (most probably nonce error)

404

Exchange with that name is NOT supported

500

If an unexpected error occurred

501

If the exchange integration does NOT support this function

504

If the exchange itself could not be reached because of some network error

delete /exchange/{exchangeName}/order/{orderId}

http://localhost:3000/exchange/{exchangeName}/order/{orderId}

Response samples

200

application/json

Copy

Expand all Collapse all

{

"id": "string",
"timestamp": 0,
"datetime": "2020-06-21T17:45:43Z",
"symbol": "string",
"type": "market",
"side": "buy",
"price": 0,
"amount": 0,
"cost": 0,
"filled": 0,
"remaining": 0,
"status": "open",
"info": { }

}

Experimental API

APIs that may be useful but are in experimental stage. Some of these APIs may potentially be removed in the future or be moved into one of the previous categories

directCall

Invokes a ccxt javascript object's method call directly

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.

methodName

required

string

The method name of the exchange that would be invoked directly

Request Body schema: application/json

The array of values that would be passed as parameters to the direct method call

Array

Schema not provided

Responses

200

Success

400

If the exchange itself complained about the parameters passed

401

If the exchange integration requires api key and secret for this function

403

If the exchange integration had an authentication issue (most probably nonce error)

404

Exchange with that name is NOT supported

500

If an unexpected error occurred

501

If the exchange integration does NOT support this function

504

If the exchange itself could not be reached because of some network error

post /exchange/{exchangeName}/_/{methodName}

http://localhost:3000/exchange/{exchangeName}/_/{methodName}

Request samples

Payload

application/json

Copy

Expand all Collapse all

[ ]

Response samples

200

application/json

Copy

Expand all Collapse all

{ }