Zebpay Build is a platform on the top of which users can create their own applications, similar to Zebpay or any other cryptocurrency trading applications. Developers can even create trading bots using Zebpay Build. Users can also build other types of applications(console/web/API) using our platform and can: Buy and sell digital currencies. Import transactions details on open and closed orders, past trade history. Integrate live price charts of bitcoin, ether and other altcoins. Fetch detailed information like volume, last trade, spread for each coin. Create crypto portfolio of digital assets. Build a customized watchlist. Set alerts basis change in percentage in custom interval. Sync wallet balance and create a wallet overview.
All Market and Trading related data/methods is available at this time through REST-ful API.
General Trading Overview and Zebpay Build details.
Overview and general information about the Zebpay Build API's.
All our API requests and responses are application/json content type and follow typical HTTP response status codes for success and failure. All API requests are called by the standard HTTPS. All POST calls need to specify the parameters of the format to x-www-form-urlencoded.
A successful response is indicated by HTTP status code 200 and may contain an optional body. If the response has a body it will be documented under each API.
Unless otherwise stated, errors to bad requests will respond with HTTP 4xx or status codes. The body will also contain a message parameter indicating the cause. Your language's http library should be configured to provide message bodies for non-2xx requests so that you can read the message field from the body.
Following table gives more details about error code and description.
Bad Request – Invalid request format
Unauthorized – Invalid API Key
Forbidden – You do not have access to the requested resource
Not Found
Internal Server Error – We had a problem with our server
When a rate limit is exceeded, a status of 429 Too Many Requests will be returned.
All our Datetime properties has value as "Unique Timestamp in milliseconds" (Unix time, also known as POSIX time[citation needed ] or UNIX Epoch time[ 1 ]) is a system for describing a point in time, defined as an approximation of the number of seconds that have elapsed since 00: 00: 00 Coordinated Universal Time (UTC), Thursday, 1 January 1970.
Consumer can convert the same to any timezone. Please note that, in case your library supports only seconds, divide the value by 1000 before converting to date object.
We support pagination in the API's which return a list. User has to pass the value parameterized like "?limit=10&page=1". By default system will limit the record to 20, and fetch the latest data.
For example
Tradepair History (/market/{tradepair }/trades).
Get Order (/orders).
A public sandbox is available for testing API connectivity and web trading. The sandbox environment provides all of the functionality of the production exchange and allows you to play around with API.
Login sessions and API keys are separate from production. Use the sandbox web interface to create keys in the sandbox environment.
https: //www.zebpay.co/api/v1
https: //www.zebpay.co/pro/v1
https: //ws-feed.zebapi.com/marketdata
Zebpay Build production environment is available for API connectivity and web trading.
Login sessions and API keys are separate from production.
https: //www.zebapi.com/api/v1
https: //www.zebapi.com/pro/v1
https: //ws-feed.zebapi.com/marketdata
Client libraries can help you integrate with our API quickly.
Github Repository
We supports almost all major/leading Cryptocurrencies, and are adding a new virtual currency every week. Current supported coins are:
Bitcoin
Bitcoin Cash
Etherium
Litecoin
Ripple
EOS
TRON
You'll need to register your app before getting started.Upon registration you will get following piece of information which need to be remember.
which will be used in the OAuth flow
Client Id is unique GUID which need to be provided for authentication.
Unique GUID which need to be provided for authentication.
Api secret key is used to generate the hash signature,by which user will get authenticated.
This key is used to identify that user is subscribed with the the Zebpay in which plan.
User must restrict the scope of Application.This permission user can select at time of application registration.
Permission to read the trade.
Permission to execute the trade.
All Request must contain the following headers.
The Zebpay subscription key, received after creating Application.
The client Id, received after creating Application.
A timestamp for your request, in ticks.
The base64-encoded SHA256 signature (see details in below section).
The bearer token, mandatory for all trade API's.
A Unique GUID Request Token (Generate new request id on every request).
The API signature header is generated by creating a sha256 HMAC using the base64-decoded secret key on the prehash string
POST + Seprator(\n) + timestamp +seprator+targeturl+seprator+bodydata+seprator+client_Id:client_Id
( where + represents string concatenation) and base64-encode the output.
The timestamp value is the same as the timestamp in header.
For all authenticated API's we also return a signature back ti the caller in response header with key "x-hmac". The value is hashed using the same API secret key, and response body as payload message. Calling application can use this hashed value to verify if the response is returned from the trusted Zebpay server.
var separator = "\n";
var targetUrl = request.url.trim();
var bodyData = "{}";
if(request.method == "POST") {
bodyData = request.data;
}
var payLoadMessage = 'POST' + separator + timestamp + separator + targetUrl + separator + bodyData + separator + 'client_Id:' + "xxxx-xxx";
var hashValue = CryptoJS.HmacSHA256(CryptoJS.enc.Utf8.parse(payLoadMessage), CryptoJS.enc.Utf8.parse(pm.variables.get("APISecretKey")));
var actualHash(APISignature) = CryptoJS.enc.Base64.stringify(hash);
Zebpay Build provide a page where developer can register the application as "web". At time of application registration developer need to keep following things in mind:
When creating .net MVC Core application, app.UseAuthentication() should be used for Authentication.
http: //xxxx-baseurl-xxx/signin-oidc
http: //xxxx-baseurl-xxx/signout-callback-oidc
Code Sample for .net MVC Core application (developer should use Authorize attribute on Controller)
.AddOpenIdConnect("oidc", options => {
options.SignInScheme = "Cookies";
options.Authority = "Auth server Url";
options.RequireHttpsMetadata = true;
options.ClientId = "ClientID";
options.ClientSecret = "ClientSecret";
options.ResponseType = "id_token";
options.Events.OnRemoteFailure = OnRemoteFailure;
//Mandatory Scopes
options.Scope.Add("openid");
options.Scope.Add("profile");
//IMplemented scopes (custom)
options.Scope.Add("wallet:transactions:read");
options.Scope.Add("trade:read");
options.Scope.Add("trade:create");
options.SaveTokens = true;
options.GetClaimsFromUserInfoEndpoint = true;
});
Zebpay provide a page where developer can register the application as "Console".
Zebpay provides a series of API's for login purpose.
The API's need to be called in a sequence : /login, /verifyotp, /verifypin, /logout . See User API for detail request/response.
After successfull authentication user will get access_token and user can use this access_token to access API.
We always need a access token to call any authenticated API. Considering a scenario, where the client is a program/bot, they will ideally need a manual intervention to key-in OTP, in our authentication process. To get rid of this dependency we have an interactive UI where developer can generate access token, and setup inside their program.
To generate access token, user need to go to goto his/her application detail page, and then navigate to GenerateToken tab. You can generate token for all your scope or for a smaller set as well. System will prompt for a one time password to be key-in before generating the actual token value.
These API's returns market details including ticker(s), book (pending orders), trades (executed orders) etc.
Get the list of tickers. Get 24 hr stats for the product. volume is in base currency units. open, high, low are in quote currency units, for all trade pairs.
GET /market
Description
Current Buy Rate
Current Sell Rate
Total Volume with Zebpay at this time
Price change
Highest Price in last 24 hour.
Lowest Price in last 24 hour.
Current tradepair
[
{
"pair": "",
"virtualCurrency": "",
"volume": null
},
{
"buy": "0",
"sell": "0",
"volume": 0,
"pricechange": "0.00",
"24hoursHigh": "0",
"24hoursLow": "0",
"pair": "AE-BTC",
"virtualCurrency": "AE",
"currency": "BTC"
},
...
]
Get the ticker information for the current Trade Pair, with daily volume and current Price.
GET /market/{tradepair }/ticker
Description
Example XRP-BTC, ETH-BTC etc..
Current Buy Rate
Current Sell Rate
Total Volume with Zebpay at this time
Price change
Highest Price in last 24 hour.
Lowest Price in last 24 hour.
Current tradepair
{
"buy": "0",
"sell": "0.00050000",
"market": "0.0005",
"volume": 4.95532,
"24hoursHigh": "0.0005",
"24hoursLow": "0.0005",
"pricechange": "0.00",
"pair": "xrp-btc",
"virtualCurrency": "xrp",
"currency": "btc"
}
Get a list of open orders for a trade pair.
GET /market/{tradepair }/book
Description
Example XRP-BTC, ETH-BTC etc..
List of recent ask's Rates, with Price & Amount.
List of recent bid's Rates, with Price & Amount.
Current tradepair.
{
"asks": [],
"bids": [
{
"price": "0.00050000",
"amount": 20044680
}
],
"pair": "xrp-btc"
}
Get the trade History information for the current Trade Pair.
GET /market/{tradepair }/trades
Description
Example XRP-BTC, ETH-BTC etc..
Transaction Id maintained uniquely at Zebpay.
Total volume at the point of transaction.
Price at which the transaction executed.
Ask(1)/Bid(2).
Current tradepair.
Timestamp.
[
{
"trans_id": 13,
"fill_qty": 1000000,
"fill_price": 0.0005,
"fill_flags": 1,
"currencyPair": "XRP-BTC",
"lastModifiedDate": 1538576785865
}
...
]
This endpoint can be used to read order data as well as create a new order. You can also cancel your previously placed order.
User can place limit order and it can be done only when there is sufficient amount of Quote currencies available in the account. On placing order, the amount of quote currency for the given pair will be on hold for the duration of the order.
POST /orders
Description
The trade pair must be valid matching product available in the list of pairs for trading. Ex:BTC-INR
Side indicates the side at which the order is placed. Bid side indicates a downtick and conversely Ask side indicates the uptick.
Size indicates the amount of base currency required to Bid or Ask against the quote currency.
The price must be specified in the minimum order tick price. For the BTC/TUSD product the minimum order tick price is 0.01. Prices lesser than the minimum tick will not be accepted.
Description
Order id
The price must be specified in the minimum order tick price. For the BTC/TUSD product the minimum order tick price is 0.01. Prices lesser than the minimum tick will not be accepted.
Size indicates the amount of base currency required to Bid or Ask against the quote currency.
Limit order is the Default order type which requires specifying the price and size. If the limit order is not seen filled , it will become the part of the order book unless filled or cancelled by the user.
The trade pair must be valid matching product available in the list of pairs for trading. Ex:BTC-INR.
Side indicates the side at which the order is placed. Bid side indicates a downtick and conversely Ask side indicates the uptick.
This indicates the Date and time when the order is placed.
The status of the order can be determined and then classified into ‘pending’ or ‘complete’. Eg : A limit order will show pending unless “filled or cancelled”
{
"trade_pair": "xrp-btc",
"side": "ask",
"size": 1,
"price": 0.0005
}
{
"id": 555677,
"price": 0.0005,
"size": 1,
"type": "limit",
"trade_pair": "xrp-btc",
"side": "ask",
"created_at": 1538576785865,
"status": "pending"
}
List your current orders. You can view open as well as settled orders. We need to pass ORDER STATUS "Pending" to get all un-settled orders, "all" to get all orders.
GET /orders
Description
Optional : The trade pair must be valid matching product available in the list of pairs for trading. Ex:BTC-INR
Optional : Default value is 'pending'. The status of the order can be determined and then classified into ‘pending’ or ‘complete’. Order will have 'complete' status if it is fully executed in other cases, status will be 'pending'
Optional : Order Id
Optional : Page Number of the records to be seen.
Optional : Number of records to be fetch in Single Page
Description
Order Id
The price must be specified in the minimum order tick price. For the BTC/TUSD product the minimum order tick price is 0.01. Prices lesser than the minimum tick will not be accepted.
Size indicates the amount of base currency required to Bid or Ask against the quote currency.
Limit order is the Default order type which requires specifying the price and size. If the limit order is not seen filled , it will become the part of the order book unless filled or cancelled by the user.
The trade pair must be valid matching product available in the list of pairs for trading.
Side indicates the side at which the order is placed. Bid side indicates a downtick and conversely Ask side indicates the uptick.
This indicates the Date and time when the order is placed.
Executed value is filled_size * [price ]
Amount of cancel value by price
Fee applicable
Quantity of order executed
The status of the order can be determined and then classified into ‘pending’ or ‘complete’. Eg : A limit order will show pending unless “filled or cancelled”
Order is settled or in progress
{
"id": 555583,
"price": 17,
"size": 0.5,
"type": "limit",
"trade_pair": "BTG-USDT",
"side": "Ask",
"created_at": 1538576785865,
"executed_value": 8.5,
"cancel_value": 0,
"fill_fees": 0.025,
"filled_size": 0.5,
"status": "complete",
"settled": true
}
Get a single order's detail/fills by order id.
GET /orders/{orderid }/fills
Description
Valid Order Id
Size indicates the amount of base currency required to Bid or Ask against the quote currency.
The price must be specified in the minimum order tick price. For the BTC/TUSD product the minimum order tick price is 0.01. Prices lesser than the minimum tick will not be accepted.
Amount shows the total executed value of order placed by the user.
Orders which provide liquidity are charged different fees from orders taking liquidity. Makers are charged differently than the market takers.
Zebpay operates a maker-taker model. The fee is assessed as a percentage of the match amount (price * size).
Orders of equivalent quantity executed on both sides of the book on same day attract exclusive intraday fees of 0.1%.
Total fees is calculated on 24-hour cycle which is cumulated of market maker, taker and intraday fees. Any excessive fees charged attracts rebate at the end of the time-cycle.
Fees for a given pair will be charged always in terms of the quote currency. Eg: For the pair ETHBTC, the attracted trade fee on the given pair will be in BTC.
This indicates the Date and time when the order is placed.
{
"orderId": 555806,
"size": 0.5,
"price": 17,
"amount": 8.5,
"feesType": "taker",
"fees": 0,
"intradayFees": 0.01,
"totalFees": 0.01,
"feeCurrency": "USDT",
"createDate": 1538576785865
}
Cancel a previously placed order.
DELETE /orders/{orderid }
Description
Valid Order Id
Success
{
"data": null,
"statusCode": 200,
"statusDescription": "success"
}
"Pair-Trading" in cryptocurrency in simple language means "exchanging one virtual currency for another". Every cryptocurrency in today's world is associated a value, which is a multiple of value of domestic fiat currency. The same concept is applied while "Crypto-Crypto trading" where the base value of the relative alternative coins is decided to that of the Bitcoin.
Left Hand Side will be the currency we want to trade:
Bitcoin Cash - Bitcoin
Ether - Bitcoin
Ripple - Bitcoin
Litecoin - Bitcoin
TRON - Bitcoin
EOS - Bitcoin
Bitcoin - Euro
Bitcoin Cash - Euro
Ether - Euro
Ripple - Euro
Litecoin - Euro
TRON - Euro
EOS - Euro
These endpoints are used to interact and make payments to lightning network.
Decodes Lightning invoice
POST /lightning/decode
Description
Example "lntb1530n1pwgpnr7pp5l62gagc880aw7qhknddjxtuc9ew5slkt6qhjwwepa7y0d8kvchuqdpcf45kcmrfdahzqsnfw33k76twypyx7mt9wpskwefqfaexgetjyq3njde4cqzysxqzfvcn27vxmzkrsgw6udwkfqgh4hylv3qvsdzpf42svc6pz6lrgh08cxtxf60q83hxpgxwq3t9uj344p4pwdpktnvy34hs2acaxyf42e0ygplvhhqe"
{
"invoice": {
"coinType": "testnet",
"payeeNodeKey": "023bcc1daeb7c85208991e993a2eacf86f7d9584a6dc33291bbe5e19c986a31568",
"satoshis": 153,
"signature": "c4d5e61b62b0e0876b8d7592045eb727d910320d1053554198d045af8d1779f065993a780f1b982833811597928d6a1a85cd0d97361235bc15dc74c44d559791",
"timeExpireDate": 1551945130,
"timestampString": "2019-03-07T07:47:10.000Z",
"timestamp": 1551944830,
"description": "1 Espresso Coin Panna, 1 Scala Chip Frappuccino",
"description_hash": "",
"expiry": "300",
"tags": [
{
"tagName": "payment_hash",
"data": "fe948ea3073bfaef02f69b5b232f982e5d487ecbd02f273b21ef88f69eccc5f8"
},
{
"tagName": "description",
"data": "Million Bitcoin Homepage Order #975"
},
{
"tagName": "min_final_cltv_expiry",
"data": 144
},
{
"tagName": "expire_time",
"data": 300
}
],
"payeeName": "Name not available"
},
"path": true
}
{
"statusCode": 400,
"statusDescription" : "Error",
"data" : {
message: "Invoice Expired"
}
}
Makes a payment to lightning invoice
POST /lightning/pay
Description
Example "lntb1530n1pwgpnr7pp5l62gagc880aw7qhknddjxtuc9ew5slkt6qhjwwepa7y0d8kvchuqdpcf45kcmrfdahzqsnfw33k76twypyx7mt9wpskwefqfaexgetjyq3njde4cqzysxqzfvcn27vxmzkrsgw6udwkfqgh4hylv3qvsdzpf42svc6pz6lrgh08cxtxf60q83hxpgxwq3t9uj344p4pwdpktnvy34hs2acaxyf42e0ygplvhhqe"
100
{
"invoice": {
"coinType": "testnet",
"payeeNodeKey": "023bcc1daeb7c85208991e993a2eacf86f7d9584a6dc33291bbe5e19c986a31568",
"satoshis": 73,
signature"": "1b77f8c7b40023b66d084013b23b7c79b7316883ceeccb6ff7bcf9091900e8846ffd9435a827a590277e37dc5fb4e01c4d2a28a3e42ecd5f4810addde76ad9f4",
"timeExpireDate": 1551945944,
"timestampString": "2019-03-07T08:00:44.000Z",
"timestamp": 1551945644,
"description": "1 Espresso Coin Panna, 1 Scala Chip Frappuccino",
"description_hash": "",
"expiry": "300",
"tags": [
{
"tagName" : "payment_hash",
"data": "795dba87ebee09371b9a2d6f8b75544451f067832ebf8ed4384a7ee751bfd680"
},
{
"tagName" : "description",
"data": "Million Bitcoin Homepage Order #976"
},
{
"tagName": "min_final_cltv_expiry",
"data": 144
},
{
"tagName": "expire_time",
"data": 300
}
]
},
"path": true,
"status": "Payment Initiated"
}
{
"statusCode": 400,
"statusDescription": "Error",
"data" : {}
}
The websocket feed provides real-time market data updates for orders(book), tickers and
trades(history).
Websocket Feeds Endpoint URL
ws: //ws-feed.zebpay.com/marketdata
To connect to Zebpay websocket feed you have include socket.io library depending on your client. For example to use it just as a cross-browser WebSocket include js lib (you can download or refer from cdn )- and run below code in javascript:
var socket = io('ws: //ws-feed.zebpay.com/marketdata',{transports: ['websocket']});
socket.on('connect', function () {
console.log('Connected!').on
socket.on('message', function (msg) {
// my msg
});
});
Once the connection is established between your client and server, you can subscribe to different event by simply emitting a 'subscribe' events with the respective event names. The Format for event names are as follows:
Once you have the event names, you need to emit the subscribe event with the respective event name and server will start sending real time data.
ws.emit('subscribe', 'ticker/BTC-INR');
To capture the data for any event, you have to simply add a socket listener for that event.
ws.on('ticker/BTC-INR', (data) => {
console.log('in event ticker/BTC-INR', data);
});
Note - To capture data from any event make sure you have emitted a subscribe event for that event name.
For debugging purpose and catching socket server errors, you can directly listen for the ‘error’ event. No need to subscribe.
ws.on(‘error’, (message) => {
console.error(‘Error from socket server’, message);
});