Nebula Exchange Integration API v1

Transcription

1 Nebula Exchange Integration API v1 The APIs have as base endpoint : Production : Staging : Changelog (Novembre.) New base url for all Nebula API endpoints. Instead of see (T for Trade API). Changelog (October 18, 2018) Staging is using https now. Changelog (August 6, 2018) Added endpoints private GET /wallets private GET /wallets/:code Fixing some typos inside this document. Add 3 rd section with code samples. Changelog (July 31, 2018) GET /trades renamed to GET /tradehistory Added endpoints : public : GET /orderbook (L2) public : GET /orderbookl3 (L3) private : GET /trades private : GET /orders/canceled private : GET /orders/closed

2 1. Public API The following APIs are public (no need of authentication) 1.1 Coin List Return list of all coins with description : GET /coins Response example: Status : 200 OK [ ] "code": "ARN", "desc": "Aeron", "code": "ARX", "desc": "Assistive Reality", Property Type Description code String Coin s code desc String Coin s description

3 1.2 Symbol List Return list of symbols with detail. Can be send with optional query params like token and/or against GET /symbols token (optional) String Coin traded in a pair (eg : ARN) against (optional) String Coin against a token in a pair (eg : ETH) Response example: Status : 200 OK [ ] "symbol": "PIT_ETH", "token": "PIT", "against": "ETH", "symbol": "UFR_ETH", "token": "UFR", "against": "ETH", Status : 400 Bad Request "message":"invalid query token= " Property Type Description symbol String Symbol of a pair token String Coin trade in a pair against String Coin against a token in a pair

4 1.3 Exchange List Return list of exchanges status for each symbol(pair). Can be send with optional query params like token and/or against. GET /exchanges token (optional) String Coin traded in a pair (eg : ARN) against (optional) String Coin against a token in a pair (eg : ETH) Response example: Status : 200 OK [ ], "symbol": "ARN_ETH", "highprice": 0.5, "lowprice": 0.3, "change": , "lastprice": 0.4, "volume": "symbol": "ARN_EURT", "highprice": 0.89, "lowprice": 0.003, "change": 23.56, "lastprice": 0.4, "volume": 470, Status : 400 Bad Request "message":"invalid query token= " Property Type Description symbol String Symbol of a pair highprice Number High price (24H) lowprice Number Low price (24H) change Number Change in percent (24H) lastprice Number Last price volume Number Volume (24H)

5 1.4 Historical trades Return historical trades executed. Trades returned in ascending order. Option available to query historical trades based on tradeid, default is to return latest 100 trades. GET /tradehistory/symbol Symbol (required) String Pair traded: (eg: CAV_ETH) fromid (optional) Integer query by tradeid, display trades after this ID inclusive (optional, default to return latest trades) Limit (optional) Integer number of trades returned (optional, default to 100) Start (optional) Date Date start limit End (optional) Date Date end limit Sample : /tradehistory/cav_eth?limit=200&fromid=400 Response example: [ id: 14322, timestamp: , price: , amount: , side: "buy", id: 14323, timestamp: , price: , amount: , side: "buy", id: 14324, timestamp: , price: , amount: , side: "sell", id: 14325, timestamp: , price: , amount: , side: "buy" ] Response field Type Description id Integer Numerical tradeid timestamp Integer Unix timestamp in seconds price Float Price at which trade executed amount Float Amount of trade side String Buy or sell

6 1.5 Order book (L2) Return information on open orders with bid (buy) and ask (sell) prices, sorted and grouped by prices. Sorting is based on side : ascending for sell (ask) and descending for buy (bid). GET /orderbook/symbol Symbol (required) String Pair traded: (eg: CAV_ETH) limit Integer number of trades returned (optional, default to 10) Sample : /orderbook/cav_eth?limit=10 Response example: "bids": [ "amount": 100, "price": , "total": 4.52, "count": 1, "totalsource": 100, "totaltarget": 4.52, "amount": , "price": 0.045, "total": , "count": 2, "totalsource": , "totaltarget": ], "asks": [ "amount": 60, "price": 0.05, "total": 3, "count": 3, "totalsource": 60, "totaltarget": 3, "amount": 100, "price": 0.051, "total": 5.1, "count": 2, "totalsource": 160, "totaltarget": 8.1 ], "timestamp": Response field Type Description bids Array of structured data Bid list grouped by price asks Array of structured data Ask list grouped by price timestamp Integer Unix timestamp in seconds amount Float Amount price Float Price total Float Amount * Price count Integer Number of grouped orders with the same price totalsource Float Cumulated amount totaltarget Float Cumulated total (amount * price) Remark : to obtain L1 orderbook, please provide limit=1.

7 1.6 Detailed Order book (L3) Return information on open orders with bid (buy) and ask (sell) prices, sorted by price without grouping. Orders are listed one by one. So the list can contain duplicate price inside, no id or personal information about each order: only amount and price. Sorting is based on side : ascending for sell (ask) and descending for buy (bid). GET /orderbookl3/symbol Symbol (required) String Pair traded: (eg: CAV_ETH) limit Integer number of trades returned (optional, default to 10) Sample : /orderbook/cav_eth?limit=10 Response example: "bids": [ "amount": 100, "price": , "amount": , "price": ], "asks": [ "amount": 60, "price": 0.05, "amount": 100, "price": ], "timestamp": Response field Type Description bids Array of structured data Bid list grouped by price asks Array of structured data Ask list grouped by price timestamp Integer Unix timestamp in seconds amount Float Amount price Float Price

8 2 Private API These endpoints need each user enter API Key and API Secret KEY: - List order book (current open orders) - Create new order (MARKET or LIMIT type) - Cancel an Order Please visit nebula Application to check your API keys (Menu API Keys). 2.1 Launch an authenticated API endpoint Pseudo code to launch an authenticated endpoint: Know the endpoint and Prepare a body containing the payload Prepare, crypt and sign payload Prepare options containing URL and headers Launch request and Analyze response Headers name: X-NEB-APIKEY, X-NEB-PAYLOAD and X-NEB-SIGNATURE Please examine this code writing in javasccript. 2.2 Get Open/closed/canceled orders Return user s open, closed or canceled orders. GET /v1/orders/symbol GET /v1/orders/closed/symbol GET /v1/orders/canceled/symbol Symbol (required) String Pair ordered: (eg: CAV_ETH) Side (optional) String buy or sell Type (optional) String limit or market Start (optional) Date Date start limit End (optional) Date Date end limit limit Integer number of trades returned (optional, default to 10) Response field Type Description symbol String Pair timestamp Integer Unix timestamp in seconds (creation date) id Integer Numerical order Id side String Buy or sell type String Limit or Market price Float Price at which trade executed quantity Float Quantity ordered remainingqtt Float Remaining Quantity not fulfilled Status String open

9 Data sample "symbol":"pit_eth","timestamp": ,"id":465,"type":"limit","side":"sell","quantity ":200,"price":0.0005,"remainingQtt":200,"status":"open", "symbol":"pit_eth","timestamp": ,"id":466,"type":"limit","side":"sell","quantity ":200,"price":0.0005,"remainingQtt":200,"status":"open", "symbol":"pit_eth","timestamp": ,"id":470,"type":"limit","side":"sell","quantity ":250,"price":0.001,"remainingQtt":250,"status":"open", "symbol":"pit_eth","timestamp": ,"id":471,"type":"limit","side":"sell","quantity ":2500,"price":0.0004,"remainingQtt":1900,"status":"open", "symbol":"pit_eth","timestamp": ,"id":473,"type":"limit","side":"sell","quantity ":200,"price":0.0005,"remainingQtt":200,"status":"open" 2.3 Get Order by id Return user s open orders. GET /v1/orders/symbol/:id Symbol (required) String Pair ordered: (eg: CAV_ETH) Id (required) Integer ID of order Output : identical to GET /orders/ 2.4 Get my trades Return user s historical trades executed. Trades returned in ascending order. Option available to query historical trades based on tradeid, default is to return latest 100 trades. GET /trades/symbol Symbol (required) String Pair traded: (eg: CAV_ETH) fromid (optional) Integer query by tradeid, display trades after this ID inclusive (optional, default to return latest trades) limit Integer number of trades returned (optional, default to 100) Start (optional) Date Date start limit End (optional) Date Date end limit side String Buy or sell Sample : /trades/cav_eth?limit=200&fromid=400 Response example: [ id: 14322, timestamp: , price: , amount: , side: "buy", id: 14323, timestamp: , price: , amount: , side: "buy", id: 14324, timestamp: , price: , amount: , side: "sell", id: 14325, timestamp: , price: , amount: , side: "buy"

10 ] Response field Type Description id Integer Numerical tradeid orderid Integer Id of triggering/triggered order timestamp Integer Unix timestamp in seconds price Float Price at which trade executed amount Float Amount of trade side String Buy or sell

11 2.5 Get balances Get user balances by coin. GET /v1/wallets GET /v1/wallets/code code (optional) String Coin code like PIT, ETH hidezero (optionnal) Boolean If provided, hide zero balance Return value: list of balance by coin code. Data sample as response: Response for url /v1/wallets ["currency":"pit","amount":10000,"availableamount":9270,"used":730, "currency":"eurt","amount":10000,"availableamount":10000,"used":0, "currency":"bat","amount":10000,"availableamount":10000,"used":0 ] Response for url /v1/wallets?hidezero=true ["currency":"pit","amount":10000,"availableamount":9270,"used":730, "currency":"eurt","amount":10000,"availableamount":10000,"used":0, "currency":"bat","amount":10000,"availableamount":10000,"used":0, "currency":"storj","amount":10000,"availableamount":10000,"used":0 ] Response for url /v1/wallets/pit "currency":"pit","amount":10000,"availableamount":9270,"used":730

12 2.6 Create new order Submit a new order. POST /v1/orders/new Symbol (required) String Pair ordered: (eg: CAV_ETH) price Float Price at which trade executed quantity Float Quantity ordered side String buy or sell type String Limit or Market Return value: one line of order. See Response Field on orders list. Data sample as response: "symbol":"pit_eth","timestamp": ,"id":476,"type":"limit","side":"sell","quantity ":200,"remainingQtt":200,"status":"open" 2.7 Cancel an order Cancel an order by its id. PUT /v1/orders/cancel/:symbol/:id Symbol (required) String Pair ordered: (eg: CAV_ETH) id Integer Numerical order Id Return value: one line of order. See Response Field on orders list. Data sample as respons: Response for url /v1/orders/cancel: "symbol":"pit_eth","timestamp": ,"id":476,"type":"limit","side":"sell","quantity ":200,"remainingQtt":200,"status":"canceled"

13 1 Code Samples const request = require('request'); const crypto = require('crypto'); const _ = require('lodash'); const moment = require('moment'); const apikey = 'your API key'; const apisecretkey = 'your API secret key'; const baseurl = ' // const baseurl = ' const launch = async (url, verb, body) => const completeurl = baseurl + url; const payload = new Buffer(JSON.stringify(body url)).tostring('base64'); const signature = crypto.createhmac('sha384', apisecretkey).update(payload).digest('hex'); const options = url: completeurl, headers: 'content-type': 'application/json', 'X-NEB-APIKEY': apikey, 'X-NEB-PAYLOAD': payload, 'X-NEB-SIGNATURE': signature if (verb === 'post') options.body = JSON.stringify(body); return await request.post( options, (error, response, body) => if (error) console.log(error); console.log(`response for url $url:`); console.log(' '); console.log(body); ); if (verb === 'put') options.body = JSON.stringify(body); return await request.put( options, (error, response, body) => if (error) console.log(error); console.log(`response for url $url:`); console.log(' '); console.log(body); ); if (verb === 'get') return await request.get( options, (error, response, body) => if (error) console.log(error); console.log(`response for url $url:`); console.log(' '); console.log(body); ); const testneworder = async ( quantity, price, side, type ) => const url = '/v1/orders/new'; const body = symbol: 'PIT_ETH', quantity, price, side, type

14 await launch(url, 'post', body); const testgetopenorders = async (symbol, params) => const url = `/v1/orders/$symbol$params ''`; const testgetclosedorders = async (symbol, params) => const url = `/v1/orders/closed/$symbol$params ''`; const testgetcanceledorders = async (symbol, params) => const url = `/v1/orders/canceled/$symbol$params ''`; const testgettrades = async (symbol, params) => const url = `/v1/trades/$symbol$params ''`; const testgetorderbook = async (symbol, params) => const url = `/v1/orderbook/$symbol$params ''`; const testgetorderbookl3 = async (symbol, params) => const url = `/v1/orderbookl3/$symbol$params ''`; const testcancelorder = async (symbol, id) => const url = `/v1/orders/cancel/$symbol/$id`; await launch(url, 'put'); const testgetwallets = async (hidezero) => let url = '/v1/wallets'; if (hidezero) url += `?hidezero=$hidezero`; const testgetwallet = async (code) => const url = `/v1/wallets/$code`; const testgettradehistory = async (symbol, params) => const url = `/v1/tradehistory/$symbol$params ''`; const completeurl = baseurl + url; const options = url: completeurl return await request.get( options, (error, response, body) => if (error) console.log(error); console.log(`response for url $url:`); console.log(' '); console.log(body); ); (async (test) => const start = moment().subtract(30, 'days').todate(); const end = moment().todate(); const limit = 10; let params = `?start=$encodeuricomponent(start)`; params += `&end=$encodeuricomponent(end)` + `&limit=$encodeuricomponent(limit)`; const paramsbook = `?limit=$encodeuricomponent(limit)`; const paramtrades = params + '&fromid=3'; switch (test) case 1: testgetopenorders('pit_eth', params);

15 case 2: testgetclosedorders('pit_eth', params); case 3: testgetcanceledorders('pit_eth', params); case 4: testgettrades('pit_eth', params); case 5: testgettradehistory('pit_eth', paramtrades); case 6: testgetorderbook('pit_eth', paramsbook); case 7: testgetorderbookl3('pit_eth', paramsbook); case 8: await _.delay(() => testneworder( quantity: 20, price: , side: 'sell', type: 'limit', 1000)); await _.delay(() => testneworder( quantity: 50, price: 0.052, side: 'sell', type: 'limit', 1000)); await _.delay(() => testneworder( quantity: 100, price: , side: 'buy', type: 'limit', 1000)); await _.delay(() => testneworder( quantity: 100, price: , side: 'buy', type: 'limit', 1000)); case 9: await testneworder( quantity: 100, price: 0.045, side: 'buy', type: 'market' ); await testneworder( quantity: 100, price: 0.044, side: 'buy', type: 'market' ); case 10: testcancelorder('pit_eth', 166); case 11: testgetwallets(); case 12: testgetwallets(true); case 13: testgetwallet('pit'); default: console.log('please provide arg between 1 and 10', test); )(13);