NitroEx Public Rest APIs

Welcome to the NitroEx Cryptocurrency Exchange API

It is the Application Programming Interface (API) offered by NitroEx to provide a suite of methods to get data from our platform. You can use it to build tickers, price comparison apps, or anything that helps the crypto community.

General Information


  • Base API Endpoint https://www.nitroex.io/gateway/api-auth
  • Timestamp returned by this API are in UTC Timezone.
  • All timestamp parameters are in milliseconds.
  • You can send pair symbol parameter like BTCUSDT, ETHUSDT.
  • All endpoints successful requests return JSON object model.
"data": [], 
"message": string,
"status": int,
"timestamp": string,
"isSuccess": true
  • The 'data' parameter including the response data information, could be null if the request is DELETE, just check the 'isSuccess' parameter.
  • Any endpoint could return an error as a JSON object.
"data": [], 
"message": string,
"status": int,
"timestamp": string,
"isSuccess": true
  1. HTTP 200: return code success
  2. HTTP 400: return code for bad requests
  3. HTTP 429: return code for exceeded request rate limit.
  4. HTTP 422: return code for requests could not be processed.
  5. HTTP 5xx: return codes for internal server errors.

Public API Endpoints


1. Ticker

GET /api/v1/public/tickerLive link

Ticker will give your an overview of markets and assets. This is helpful when you want to track the information of our markets, status or market pair is active or frozen and track the datas. This response is not recommended for price polling because accurate realtime price is not guaranteed as there could be some delays. We recommend using price Live Trade API for all price tracking activity.

  1. Name: Ticker
  2. URL: https://www.nitroex.io/gateway/api-auth/api-ordermatch/api/v1/public/ticker
  3. Type: GET
  4. Header: Content-Type:application/json

Response:

                                
                                    
{ "data": { "BTCLIRA": { "percentChange": -0.720007, "high24hr": 59218.23549739, "higestBid": 58593.541718, "last": 58593.541718, "id": null, "quoteVolume": 4882760.912499571, "isFrozen": 0, "lowestAsk": 58605.23972002, "low24hr": 58593.541718 }, "BTCUSDT": { "percentChange": -0.773348, "high24hr": 10197.42509285, "higestBid": 10075.20347449, "last": 10075.20347449, "id": null, "quoteVolume": 10314136.096845753, "isFrozen": 0, "lowestAsk": 10078.24535287, "low24hr": 8217.45320342 }, "ETHBTC": { "percentChange": 0.466832, "high24hr": 0.01745, "higestBid": 0.017432, "last": 0.017055, "id": null, "quoteVolume": 0.02067066, "isFrozen": 0, "lowestAsk": 0.017835, "low24hr": 0.017296 }, "ETHLIRA": { "percentChange": -0.257591, "high24hr": 1037.26508937, "higestBid": 1030.93534187, "last": 1030.93534187, "id": null, "quoteVolume": 1193244.2944417107, "isFrozen": 0, "lowestAsk": 1031.48167528, "low24hr": 1030.14940245 }, "ETHUSDT": { "percentChange": -0.23426, "high24hr": 178.77078614, "higestBid": 177.62236384, "last": 177.61423371, "id": null, "quoteVolume": 380985.8222511546, "isFrozen": 0, "lowestAsk": 177.78459788, "low24hr": 175.71931302 } }, "message": "Operation successful", "timestamp": "2019-09-12T05:06:15.650+0000", "status": 200, "isSuccess": true }
  1. percentChange: Price change percent in the last 24 hours
  2. high24hr: Highest trade price in the last 24 hours
  3. higestbid: Highest current bid
  4. last: Last BTC price
  5. id: Market id
  6. quoteVolume: Total volume in the last 24 hours
  7. isFrozen: Is market Active (isFrozen=0) or not
  8. low24hr: Lowest trade price in the last 24 hours
  9. lowestAsk: Lowest current ask
  10. message: Operation Successful or not
  11. timestamp: Current Unix time in milliseconds
  12. status: Information Code
  13. isSuccess: True or False

2. Order Book


GET /api/v1/public/depth?symbol=BTCUSDTLive link

Get Market orderbook of any Market.

  1. Name: Order Book
  2. URL: https://www.nitroex.io/gateway/api-auth/api-ordermatch/api/v1/public/depth?symbol=BTCUSDT
  3. Type: GET
  4. Header: Content-Type:application/json
  5. Request Param: symbol=ETHUSDT

Response:

                                
                                    
{ "data": { "asks": [ [ 10077.03127977, 0.02959 ], [ 10081.31009756, 0.02897 ], [ 10081.64196565, 0.06244 ], [ 10081.66835406, 0.00887 ], [ 10081.85254995, 0.14399 ], [ 10083.24043428, 0.13247 ], [ 10083.65569028, 0.08999 ], [ 10087.87736535, 0.04103 ], [ 10087.90818266, 0.03498 ] ], "bids": [ [ 10076.61278054, 0.07384 ], [ 10076.47404078, 0.05385 ], [ 10075.778594, 0.04856 ], [ 10075.27177244, 0.09731 ], [ 10075.20347449, 0.07498 ], [ 10074.713582, 0.05788 ], [ 10074.39889721, 0.0095 ], [ 10074.27250016, 0.04892 ], [ 10073.89847457, 0.11551 ], [ 10073.56577341, 0.09762 ] ] }, "message": "Operation successful", "timestamp": "2019-09-12T04:52:56.926+0000", "status": 200, "isSuccess": true }
  1. asks: Array of current open asks on the orderbook.
  2. bids: Array of current open bids on the orderbook.
  3. message: Operation Successful or not
  4. timestamp: Current Unix time in milliseconds
  5. status: Information Code
  6. isSuccess: True or False

3. Live Trade


GET /api/v1/public/trade?symbol=BTCUSDT&limit=1Live link

Provide the live trade data for all pairs.

  1. Name: Live Trade
  2. URL: https://www.nitroex.io/gateway/api-auth/api-tradeservice/api/v1/public/trade?symbol=BTCUSDT&limit=1
  3. Type: GET
  4. Header: Content-Type:application/json
  5. Query Param: symbol = BTCUSDT, limit = 10 (Optional, Min -1, Max -1000, Default-500)

Response:

                                
                                    
{ "data": [ { "tradeId": 452534, "quantity": 0.00429, "price": 10101.37424536, "createdOn": "2019-09-12T05:31:27.000+0000" }, { "tradeId": 452535, "quantity": 0.02922, "price": 10100.67842248, "createdOn": "2019-09-12T05:31:27.000+0000" }, { "tradeId": 452527, "quantity": 0.01902, "price": 10101.37424536, "createdOn": "2019-09-12T05:31:18.000+0000" }, { "tradeId": 452524, "quantity": 0.01614, "price": 10101.37424536, "createdOn": "2019-09-12T05:31:14.000+0000" }, { "tradeId": 452502, "quantity": 0.00051, "price": 10098.99208235, "createdOn": "2019-09-12T05:30:54.000+0000" }, { "tradeId": 452503, "quantity": 0.01581, "price": 10099.00292752, "createdOn": "2019-09-12T05:30:54.000+0000" }, { "tradeId": 452501, "quantity": 0.04013, "price": 10098.9909781, "createdOn": "2019-09-12T05:30:53.000+0000" } ], "message": "Operation successful!", "timestamp": "2019-09-12T05:31:32.772+0000", "status": 200, "isSuccess": true }
  1. tradeId: Id of the executed Order .
  2. quantity: Filled Amount of Transaction
  3. price: Filled price of Transaction
  4. createdOn: Transaction time
  5. message: Operation Successful or not
  6. timestamp: Current Unix time in milliseconds
  7. status: Information Code
  8. isSuccess: True or False

4. Questions And Problems


Please use the Support Page and Support E-mail on NitroEx to ask questions and report bugs.