API​ Documentation
The following API is for developers who want to include EasyBit exchange features. You may request more features by contacting our support team.

Getting Started:
• Request an API key by contacting our support team.
• Read the following documentation.

Documentation contents:
General information
Request rate limit
API extra fee
Methods
 • Supported currency list
 • Get pair information
 • Get exchange rates
 • Validate address
 • Place order
 • Order status
 • Order history
 • Account information
 • Set extra fee
General API Information
• The base endpoint is: https://easybit.com/api/
• All endpoints return a JSON object.
• Data is returned in descending order. Newest first, oldest last.
• Server time is configured as UTC.
• All endpoints will return a success or an error Response.

A success Response example is as follows:
{
 "Response": "success",
 "Error": "",
 "Message": "success",
 "Data": { .... }
}
Response and Message is success, Error is null, response data will be given inside the Data array.
An error response example is as follows:​
{
 "Response": "error",
 "Error": "1",
 "Message": "Invalid API key"
}
The Response is error, the Error displays the error number, the Message describes the error.​
Request rate limit
The access limit for REST API is applied per API key. For average users, the request limit for each API key is 1000 requests per minute.

When a rate limit is exceeded, a 429 error for Too Many Requests will be returned.

The error Response will be as follows:
{
 "Response": "error",
 "Error": "429",
 "Message": "Request limit exceeded. More than 1000 requests per minute. If there is a need to increase your limit please contact support.",
}
API extra fee
After requesting an API key you may want to set up your API extra fee.

Our fee is from 0.10% to 0.20% depending on your Level. For more info check our Fee structure.

For example, lets say that you are level 4 and your fee is 0.16%. You may choose to charge a 0.4% fee (you can set up a fee from 0% to 50%). Thus, your users should pay a 0.56% fee in total.

You can set up your desired commission fee using the Set extra fee method.

Your API extra commission is included in all the receiving amount results.
Supported currency list
GET /api/currencylist
Parameters

apikey:
Your API key.

Optional parameters:

symbol:
If the symbol is not set, details for all symbols will be returned in an array.

Response

Response:
"success" or "error",
Error:
"" or "1" or "2",
Message:
"success" or "Invalid API key" or "Not supported symbol",
Symbol:
Currency ticker BTC, ETH etc,
Name:
Currency name Bitcoin, Ethereum etc,
Deposit:
Currency deposit status ("ok" or "suspended"),
Receive:
Currency receive status ("ok" or "suspended"),
Has_tag:
If coin has an extra ID in addition to the address ("yes" or "no"),
Receive_decimals:
The number of decimal places of the receiving amount (0-8),
Max_confirmations:
The maximum number of confirmations needed to confirm the deposit.
Request example:
https://easybit.com/api/currencylist?apikey=yourkey&symbol=BTC
Response examples:

Success:
{
 "Response": "success",
 "Error": "",
 "Message": "success",
 "Data": [
  {
   "Symbol": "BTC",
   "Name": "Bitcoin",
   "Deposit": "ok",
   "Receive": "ok",
   "Has_tag": "no",
   "Receive_decimals": "8"
   "Max_confirmations": "2"
  }
  ]
}
Errors:
Error 1:
{
 "Response": "error",
 "Error": "1",
 "Message": "Invalid API key"
}

Error 2:
{
 "Response": "error",
 "Error": "2",
 "Message": "Not supported symbol"
}
Get pair information
GET /api/pairinfo
Parameters

apikey:
Your API key,
from:
Ticker of currency to deposit,
to:
Ticker of currency to receive.

Response

Response:
"success" or "error",
Error:
"" or "1" or "3" or "4",
Message:
"success" or "Invalid API key" or "Pair is currently unavailable" or "Pair is not supported",
Min:
Minimum amount to deposit,
Max:
Maximum amount to deposit,
Network_fee:
Network fee of the receiving currency,
Confirmations:
The number of confirmations needed to confirm the deposit.
Request example:
https://easybit.com/api/pairinfo?apikey=yourkey&from=BTC&to=ETH
Response examples:

Success:
{
 "Response": "success",
 "Error": "",
 "Message": "success",
 "Data": [
  {
   "Min": "0.006466",
   "Max": "36.94",
   "Network_fee": "0.01"
   "Confirmations": "2"
  }
  ]
}
Errors:
Error 1:
{
 "Response": "error",
 "Error": "1",
 "Message": "Invalid API key"
}

Error 3:
{
 "Response": "error",
 "Error": "3",
 "Message": "BTC_ETH is currently unavailable try again later"
}

Error 4:
{
 "Response": "error",
 "Error": "4",
 "Message": "BTC_LSX is not a supported pair of currencies"
}
Get exchange rates
GET /api/exrates
Parameters

apikey:
Your API key,
from:
Ticker of currency to deposit,
to:
Ticker of currency to receive,
amount:
Amount to deposit.

Optional parameters:

amounttype:
Set this parameter as "receive" if you want to specify as "amount" the amount you want to receive,

Response

Response:
"success" or "error",
Error:
"" or "1" or "3" or "4" or "5",
Message:
"success" or "Invalid API key" or "Pair is currently unavailable" or "Pair is not supported" or "Not allowed amount",
Rate:
Actual rate (Commission fee + API extra fee included),
Network_fee:
Network fee of the receiving currency,
Deposit_amount:
The exact amount you have to deposit,
Receive_amount:
Estimated receiving amount (All fees included).
Request example:
https://easybit.com/api/exrates?apikey=yourkey&from=BTC&to=ETH&amount=1
Response examples:

Success:
{
 "Response": "success",
 "Error": "",
 "Message": "success",
 "Data": [
  {
   "Rate": "29.9933824",
   "Network_fee": "0.01",
   "Deposit_amount": "1"
   "Receive_amount": "29.98338783"
  }
  ]
}
Errors:
Error 1:
{
 "Response": "error",
 "Error": "1",
 "Message": "Invalid API key"
}

Error 3:
{
 "Response": "error",
 "Error": "3",
 "Message": "BTC_ETH is currently unavailable try again later"
}

Error 4:
{
 "Response": "error",
 "Error": "4",
 "Message": "BTC_LSX is not a supported pair of currencies"
}

Error 5:
{
 "Response": "error",
 "Error": "5",
 "Message": "Not allowed amount",
 "Min": "0.006466",
 "Max": "36.94"
}
Validate address
GET /api/validateaddress
Parameters

apikey:
Your API key,
symbol:
Ticker of currency to validate,
address:
The wallet address that you want to validate.

Optional parameters:

tag:
The wallet tag you want to validate.

Response

Response:
"success" or "error",
Error:
"" or "1" or "2" or "6" or "7",
Message:
"success" or "Invalid API key" or "Not supported symbol" or "Invalid {Symbol} address" or "Invalid {Symbol} tag",
Address:
The wallet address you requested to check,
Tag:
The wallet tag you requested to check.
Request example:
https://easybit.com/api/validateaddress?apikey=yourkey&symbol=BTC&address=theBTCaddress
Response examples:

Success:
{
 "Response": "success",
 "Error": "",
 "Message": "success",
 "Data": [
  {
   "Address": "{The BTC address}",
  }
  ]
}
Errors:
Error 1:
{
 "Response": "error",
 "Error": "1",
 "Message": "Invalid API key"
}

Error 2:
{
 "Response": "error",
 "Error": "2",
 "Message": "Not supported symbol"
}

Error 6:
{
 "Response": "error",
 "Error": "6",
 "Message": "Invalid {Symbol} address",
 "Address": "{The receiving address you set}"
}

Error 7:
{
 "Response": "error",
 "Error": "7",
 "Message": "Invalid {Symbol} tag",
 "Tag": "{The receiving tag you set}"
}
Place order
GET /api/placeorder
Parameters

apikey:
Your API key,
from:
Ticker of currency to deposit,
to:
Ticker of currency to receive,
amount:
The exact amount you have to deposit (If you deposit other amount the order will fail),
address:
Receiving wallet address.

Optional parameters:

tag:
Receiving wallet address tag, "no" if not set,
amounttype:
Set this parameter as "receive" if you want to specify as "amount" the amount you want to receive,
vpm:
Volatility Protection Mode, 1-5 (maximum step size is 0.1) or "off" (If rates drop over the selected percentage cancel and refund). "off" if not set. VPM feature is disabled for new accounts, to enable VPM for your account please contact our support team,
refundaddress:
In case Volatility Protection Mode is on, you have to enter a refund address,
refundtag:
In case Volatility Protection Mode is on, you may enter a refund tag, "no" if not set.

Response

Response:
"success" or "error",
Error:
"" or "1" or "3" or "4" or "5" or "6" or "7" or "8" or "9" or "10" or "11" or "16",
Message:
"success" or "Invalid API key" or "Pair is currently unavailable" or "Pair is not supported" or "Not allowed amount" or "Invalid address" or "Invalid tag" or "Invalid refund address" or "Invalid refund tag" or "Volatility Protection Mode is on, refund address not set" or "Security limitation" or "Invalid VPM value. Enter a value between 1-5",
Id:
The transaction id,
From:
Ticker of currency to deposit,
To:
Ticker of currency to receive,
Deposit_amount:
The exact amount you have to deposit,
Receive_amount:
Estimated receiving amount (All fees included),
Deposit_address:
Our wallet address,
Deposit_tag:
Our wallet tag, "no" is set if not needed (If tag is set and you fail to include it in your deposit your funds will be lost),
Receive_address:
Receiving wallet address,
Receive_tag:
Receiving wallet tag,
Refund_address:
Refund wallet address,
Refund_tag:
Refund wallet tag,
Protection:
Volatility Protection Mode,
Created_at:
Timestamp (UTC).
Request example:
https://easybit.com/api/placeorder?apikey=yourkey&from=BTC&to=ETH&amount=1&address=yourETHaddress
Response examples:

Success:
{
 "Response": "success",
 "Error": "",
 "Message": "success",
 "Data": [
  {
   "Id": "Ksiw82Kls201",
   "From": "BTC",
   "To": "ETH",
   "Deposit_amount": "1",
   "Receive_amount": "29.98338783",
   "Deposit_address": "{Our BTC address}",
   "Deposit_tag": "no",
   "Receive_address": "{Your ETH address}",
   "Receive_tag": "no",
   "Refund_address": "no",
   "Refund_tag": "no",
   "Protection": "off",
   "Created_at": "1554977359"
  }
  ]
}
Errors:
Error 1:
{
 "Response": "error",
 "Error": "1",
 "Message": "Invalid API key"
}

Error 3:
{
 "Response": "error",
 "Error": "3",
 "Message": "BTC_ETH is currently unavailable try again later"
}

Error 4:
{
 "Response": "error",
 "Error": "4",
 "Message": "BTC_LSX is not a supported pair of currencies"
}

Error 5:
{
 "Response": "error",
 "Error": "5",
 "Message": "Not allowed amount",
 "Min": "0.006466",
 "Max": "36.94"
}

Error 6:
{
 "Response": "error",
 "Error": "6",
 "Message": "Invalid {Symbol} address",
 "Address": "{The receiving address you set}"
}

Error 7:
{
 "Response": "error",
 "Error": "7",
 "Message": "Invalid {Symbol} tag",
 "Tag": "{The receiving tag you set}"
}

Error 8:
{
 "Response": "error",
 "Error": "8",
 "Message": "Invalid {Symbol} refund address",
 "Address": "{The refund address you set}"
}

Error 9:
{
 "Response": "error",
 "Error": "9",
 "Message": "Invalid {Symbol} refund tag",
 "Tag": "{The refund tag you set}"
}

Error 10:
{
 "Response": "error",
 "Error": "10",
 "Message": "Volatility Protection Mode is on, refund address not set"
}

Error 11:
{
 "Response": "error",
 "Error": "11",
 "Message": "Security limitation. We cannot accept the exact amount of 1 {Symbol}. Try with a slightly lower or higher amount, or you will be able to place the order in 10 minutes",
 "Minutes": "10"
}

Error 16:
{
 "Response": "error",
 "Error": "16",
 "Message": "Invalid VPM value. Enter a value between 1-5",
}
Order status
GET /api/orderstatus
Parameters

apikey:
Your API key,
id:
Transaction id.

Response

Response:
"success" or "error",
Error:
"" or "1" or "12",
Message:
"success" or "Invalid API Key" or "Invalid transaction id",
Id:
The transaction id,
Status:
"Awaiting Deposit" or "Confirming Deposit" or "Exchanging" or "Sending" or "Complete" or "Refund" or "Failed" or "On Hold",
Receive_amount:
Final receive amount if status is "Sending" or "Complete". Estimated receive amount for other statuses.
Updated_at:
Timestamp (UTC).
Request example:
https://easybit.com/api/orderstatus?apikey=yourkey&id=Ksiw82Kls201
Response examples:

Success:
{
 "Response": "success",
 "Error": "",
 "Message": "success",
 "Data": [
  {
   "Id": "Ksiw82Kls201",
   "Status": "Complete",
   "Receive_amount": "30.02412398",
   "Updated_at": "1554977359"
  }
  ]
}
Errors:
Error 1:
{
 "Response": "error",
 "Error": "1",
 "Message": "Invalid API key"
}

Error 12:
{
 "Response": "error",
 "Error": "12",
 "Message": "Invalid transaction id"
}
Order history
GET /api/orders
Parameters

apikey:
Your API key.

Optional parameters:

id:
The transaction id,
status:
Display orders with particular status,
limit:
How many orders to retreive 25 or 50 or 100.

Response

Response:
"success" or "error",
Error:
"" or "1" or "12" or "13" or "14",
Message:
"success" or "Invalid API Key" or "Invalid transaction id" or "Invalid status parameter" or "Invalid limit number",
Order Details
,
Estimated_amount:
Receiving estimated amount when the order was placed,
Receive_amount:
Final receive amount,
Status:
"Awaiting Deposit" or "Confirming Deposit" or "Exchanging" or "Sending" or "Complete" or "Refund" or "Failed" or "On Hold".
Hash_in:
Txid of your withdrawal or null.
Hash_out:
Txid of our withdrawal or null.
Network_fee:
Network fee of the receiving currency.
Earned:
The amount you earned based on your API extra fee in BTC.
Created_at:
Timestamp (UTC).
Updated_at:
Timestamp (UTC).
Request example:
https://easybit.com/api/orders?apikey=yourkey
Response examples:

Success:
{
 "Response": "success",
 "Error": "",
 "Message": "success",
 "Data": [
  {
   "Id": "Ksiw82Kls201",
   "From": "BTC",
   "To": "ETH",
   "Deposit_amount": "1",
   "Estimated_amount": "29.98338783",
   "Receive_amount": "30.02412398",
   "Receive_address": "{Your ETH address}",
   "Receive_tag": "no",
   "Refund_address": "no",
   "Refund_tag": "no",
   "Protection": "off",
   "Status": "Complete",
   "Hash_in": "{transactionhash}",
   "Hash_out": "{transactionhash}",
   "Network_Fee": "{Amount in receiving currency}",
   "Earned": "{Amount in BTC}",
   "Created_at": "1554977359",
   "Updated_at": "1554977359"
  },
  {
   "Id": "Xi9e2ksEs02s",
   "From": "ETH",
   "To": "DASH",
   "Deposit_amount": "12.5",
   "Estimated_amount": "16.93512132",
   "Receive_amount": "16.93463341",
   "Receive_address": "{Your DASH address}",
   "Receive_tag": "no",
   "Refund_address": "no",
   "Refund_tag": "no",
   "Protection": "off",
   "Status": "Complete",
   "Hash_in": "{transactionhash}",
   "Hash_out": "{transactionhash}",
   "Network_Fee": "{Amount in receiving currency}",
   "Earned": "{Amount in BTC}",
   "Created_at": "1554977359",
   "Updated_at": "1554977359"
  }
  ]
}
Errors:
Error 1:
{
 "Response": "error",
 "Error": "1",
 "Message": "Invalid API key"
}

Error 12:
{
 "Response": "error",
 "Error": "12",
 "Message": "Invalid transaction id"
}

Error 13:
{
 "Response": "error",
 "Error": "13",
 "Message": "Invalid status parameter"
}

Error 14:
{
 "Response": "error",
 "Error": "14",
 "Message": "Invalid limit number, try 25 or 50 or 100"
}
Account information
GET /api/account
Parameters

apikey:
Your API key.

Response

Response:
"success" or "error",
Error:
"" or "1",
Message:
"success" or "Invalid API Key",
Level:
Your account level,
Volume:
Your exchange volume of the current month in BTC,
Fee:
Our fee based on your account level,
Extra_fee:
The API extra fee you set
Request example:
https://easybit.com/api/account?apikey=yourkey
Response examples:

Success:
{
 "Response": "success",
 "Error": "",
 "Message": "success",
 "Data": [
  {
   "Level": "4"
   "Volume": "16.24126573"
   "Fee": "0.0016"
   "Extra_fee": "0.004"
  }
  ]
}
Errors:
Error 1:
{
 "Response": "error",
 "Error": "1",
 "Message": "Invalid API key"
}
Set extra fee
GET /api/setextrafee
Allowed values 0-0.1. If you want for example to set an API fee of 0.4% the extrafee parameter must be 0.004.
The maximum step size is 0.0001. You can set more than 4 decimal places but they will be ignored.
Parameters

apikey:
Your API key.
extrafee:
Your API extra fee.

Response

Response:
"success" or "error",
Error:
"" or "1" or 15",
Message:
"success" or "Invalid API Key" or "Invalid value. Enter a value between 0-0.1",
Fee:
Our fee based on your account level,
Extra_fee:
Your new API extra fee,
Total_fee:
Total fee for your users
Request example:
https://easybit.com/api/setextrafee?apikey=yourkey&extrafee=0.004
Response examples:

Success:
{
 "Response": "success",
 "Error": "",
 "Message": "success",
 "Data": [
  {
   "Fee": "0.0016"
   "Extra_fee": "0.004"
   "Total_fee": "0.0056"
  }
  ]
}
Errors:
Error 1:
{
 "Response": "error",
 "Error": "1",
 "Message": "Invalid API key"
}

Error 15:
{
 "Response": "error",
 "Error": "15",
 "Message": "Invalid value. Enter a value between 0-0.1"
}
Track Order
Support
Copied to clipboard
Access Denied
The service is unavailable for your geographic location.