EasyBit | API



The following API is for developers who want to integrate EasyBit exchange features to their project. You may request more features by contacting our Support team.

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

Introduction

General API Information

• The base endpoint is: https://api.easybit.com

• Server time is configured as UTC.

• All timestamps are defined in milliseconds.

• All endpoints return a JSON object.

• Data is returned in descending order. Newest first, oldest last.

• All endpoints will return a Successful or an Error response.

• Parameters definition:

⚬ For GET methods you need to define the parameters as a query string.

⚬ For POST methods you need to define the parameters as a JSON body.


Successful Response Example

Field Type Description
success Integer

Success flag. (1:success, 0:error)
data Object

The response data object

 
HTTP/1.1 200 OK
{
    "success": 1,
    "data": {}
}

Error Response Example

Name Type Description
success Integer

Success flag. (1:success, 0:error)
errorMessage String

Error message
errorCode Integer

Error code
data optional Object

Data object

 
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Error Message",
    "errorCode": 400,
    "data": {}
}

API 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 - Too Many Requests error will be returned.


Error Response Example

Name Type Description
success Integer

Success flag. (1:success, 0:error)
errorMessage String

Error message
errorCode Integer

Error code

 
HTTP/1.1 429 Too Many Requests
{
    "success": 0,
    "errorMessage": "Request limit exceeded. Limit is 1000 requests per minute",
    "errorCode": 429
}

API Extra Fee

After requesting an API key you may want to set up your way of profiting throught our API.

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

For example, lets say you are level 3 and your fee is 0.14%. You may choose to charge a 0.4% fee, thus, your users should pay a 0.54% fee in total. You can set up a fee from 0% to 10%

You can set up your desired commission fee for your account using the method. Additionally, if you want to set a different extra fee per order you can override the standard extra fee you have set for your account by specifying the extraFeeOverride parameter on the and methods.

Your API extra commission is included in all the receive amount results.


Authentication

To access the EasyBit API you need to use an API key. You can request an API key by contacting our Support team.

The API key should be set with each API call in the HTTP headers as follows: API-KEY: your_api_key

Currency

Supported Currency List

Get the list of supported currencies, and their supported networks

get 
https://api.easybit.com/currencyList

Header

Field Type Description
API-KEY String

Your API key

Parameter

Field Type Description
currency optional String

If the currency is not set, details for all currencies will be returned

 
curl -X GET 'https://api.easybit.com/currencyList' -H 'API-KEY: your_api_key'

Successful Response

Field Type Description
success Integer

Success flag
data Object[]

The response data array of objects
  currency String

Currency ticker BTC, ETH etc.
  name String

Currency name Bitcoin, Ethereum etc.
  sendStatusAll Boolean

Send status (true: At least one network available, false: All networks unavailable)
  receiveStatusAll Boolean

Receive status (true: At least one network available, false: All networks unavailable)
  networkList Object[]

Currency supported networks
    network String

Network ticker BTC, ETH etc.
    name String

Network name Bitcoin, Ethereum etc.
    isDefault Boolean

True if default network (Will be used when network is not deifned as a parameter)
    sendStatus Boolean

Network send status
    receiveStatus Boolean

Network receive status
    receiveDecimals Integer

The number of decimal places of the receive amount (0-8)
    confirmationsMinimum Integer

The minimum number of confirmations required to confirm the order
    confirmationsMaximum Integer

The maximum number of confirmations required to confirm the order
    explorer String

Explorer link
    explorerHash String

Hash explorer link. Replace "{{txid}}" with your transaction hash.
    explorerAddress String

Address explorer link. Replace "{{addr}}" with your address.
    hasTag Boolean

If network supports Tag/Extra ID in addition to the address
    tagNameoptional String

Tag/Extra ID name ("tag", "MEMO" etc.)
    contractAddressoptional String

Token Contract Address. Please ensure that the contract address for the sending token is the same. Deposit of tokens with different contract address will result in the funds to be lost.
    explorerContractoptional String

Contract explorer link. Replace "{{contr}}" with your transaction contract address.

 
HTTP/1.1 200 OK
{
    "success": 1,
    "data": [{
        "currency": "BTC",
        "name": "Bitcoin",
        "sendStatusAll": true,
        "receiveStatusAll": false,
        "networkList": [{
            "network": "BNB",
            "name": "BEP2",
            "isDefault": false,
            "sendStatus": true,
            "receiveStatus": false,
            "receiveDecimals": 8,
            "confirmationsMinimum": 1,
            "confirmationsMaximum": 1,
            "explorer": "https://explorer.binance.org/",
            "explorerHash": "https://explorer.binance.org/tx/{{txid}}",
            "explorerAddress": "https://explorer.binance.org/address/{{addr}}",
            "hasTag": true,
            "tagName": "MEMO",
            "contractAddress": "BTCB-1DE",
            "explorerContract": "https://binance.mintscan.io/assets/{{contr}}"
        },
        {
            "network": "BTC",
            "name": "BTC",
            "isDefault": ture,
            "sendStatus": true,
            "receiveStatus": true,
            "receiveDecimals": 8,
            "confirmationsMinimum": 1,
            "confirmationsMaximum": 2,
            "explorer": "https://www.blockchain.com/explorer/",
            "explorerHash": "https://www.blockchain.com/btc/tx/{{txid}}",
            "explorerAddress": "https://www.blockchain.com/btc/address/{{addr}}",
            "hasTag": false
        },
        {
            . . .
        }]
    },
    {
        "currency": "ETH",
        "name": "Ethereum",
        "sendStatusAll": true,
        "receiveStatusAll": true,
        "networkList": [{
            . . .
        }]
    },
    {
        . . .
    }]
}

Error

Name Type Description
success Integer

Success flag
errorMessage String

Error message
errorCode Integer

Error code
data Object

Data object
  currency String

Requested currency

 
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Unsupported currency",
    "errorCode": 1001,
    "data": {
        "currency": "BTL"
    }
}

Supported Pair List

Get the list of supported currency - network pairs

get 
https://api.easybit.com/pairList

Header

Field Type Description
API-KEY String

Your API key

Parameter

Field Type Description
- -

-

 
curl -X GET 'https://api.easybit.com/pairList' -H 'API-KEY: your_api_key'

Successful Response

Field Type Description
success Integer

Success flag
data String[]

Array of strings representing currency-network pairs. Each string in the data array represents a pair and follows the format: "sendCurrency_sendNetwork_receiveCurrency_receiveNetwork"

 
HTTP/1.1 200 OK
{
    "success": 1,
    "data": [
        "BTC_BTC_ETH_ETH", //"sendCurrency_sendNetwork_receiveCurrency_receiveNetwork"
        "BTC_BSC_USDT_TRX", //"sendCurrency_sendNetwork_receiveCurrency_receiveNetwork"
    . . .
    ]
}

Pair Information

Get exchange information for a pair of currencies - networks

get 
https://api.easybit.com/pairInfo

Header

Field Type Description
API-KEY String

Your API key

Parameter

Field Type Description
send String

Ticker of currency to send
receive String

Ticker of currency to receive
sendNetwork optional String

Ticker of network to send. Default network will be selected if omitted
receiveNetwork optional String

Ticker of network to receive. Default network will be selected if omitted
amountType optional String

Set this parameter as "receive" if you want to get the minimum and/or maximum of the receiving amount

 
curl -X GET 'https://api.easybit.com/pairInfo?send=ETH&receive=BTC&sendNetwork=BNB&receiveNetwork=BSC' -H 'API-KEY: your_api_key'

Successful Response

Field Type Description
success Integer

Success flag
data Object

The response data object
  minimumAmount String

Minimum amount to send
  maximumAmount String

Maximum amount to send
  networkFee String

Network fee of the receive currency (Included in the receiveAmount)
  confirmations Integer

The number of confirmations required to confirm the order
  processingTime String

Dash-separated min and max estimated processing time in minutes

 
HTTP/1.1 200 OK
{
    "success": 1,
    "data": {
        "minimumAmount": "0.01075",
        "maximumAmount": "420",
        "networkFee": "0.000005",
        "confirmations": 1,
        "processingTime": "3-5"
    }
}

Error

Name Type Description
success Integer

Success flag
errorMessage String

Error message
errorCode Integer

Error code
data optional Object

Data object
  currency optional String

Requested currency
  network optional String

Requested network
  side optional String

Send or receive side

 
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Unsupported currency",
    "errorCode": 1001,
    "data": {
        "currency": "BTL",
        "side": "send"
    }
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Unsupported pair of currencies-networks",
    "errorCode": 1002
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Unsupported network for currency",
    "errorCode": 1003,
    "data": {
        "currency": "BTC",
        "network": "BTL",
        "side": "send"
    }
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Currency suspended for specified network. Try again later",
    "errorCode": 1004,
    "data": {
        "currency": "BTC",
        "network": "BTC",
        "side": "send"
    }
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Could not provide rates for this pair of currencies. Try again later",
    "errorCode": 1011
}

Exchange Rate

The exchange rate for the requested pair is returned

get 
https://api.easybit.com/rate

Header

Field Type Description
API-KEY String

Your API key

Parameter

Field Type Description
send String

Ticker of currency to send
receive String

Ticker of currency to receive
amount Float

Amount to send
sendNetwork optional String

Ticker of network to send. Default network will be selected if omitted
receiveNetwork optional String

Ticker of network to receive. Default network will be selected if omitted
amountType optional String

Set this parameter as "receive" if you want to specify as "amount" the receive amount
extraFeeOverride optional Float

Use this parameter to override the extra fee for a specific call. Allowed value range: 0-0.1, Maximum step size: 0.0001

 
curl -X GET 'https://api.easybit.com/rate?send=ETH&receive=BTC&sendNetwork=BNB&receiveNetwork=BSC&amount=0.1' -H 'API-KEY: your_api_key'

Successful Response

Field Type Description
success Integer

Success flag
data Object

The response data object
  rate String

Actual rate (Exchange fee + API extra fee included),
  sendAmount String

The amount you have to send
  receiveAmount String

Estimated receive amount (All fees included)
  networkFee String

Network fee of the receive currency (Included in the receiveAmount)
  confirmations Integer

The number of confirmations required to confirm the order
  processingTime String

Dash-separated min and max estimated processing time in minutes

 
HTTP/1.1 200 OK
{
    "success": 1,
    "data": {
        "rate": "0.08195835",
        "sendAmount": "0.1",
        "receiveAmount": "0.00819083",
        "networkFee": "0.000005",
        "confirmations": 1,
        "processingTime": "3-5"
    }
}

Error

Name Type Description
success Integer

Success flag
errorMessage String

Error message
errorCode Integer

Error code
data optional Object

Data object
  currency optional String

Requested currency
  network optional String

Requested network
  side optional String

Send or receive side
  minimumAmount optional String

The minimum amount you can send. The minimum amount you can receive if "amountType" is set as "receive"
  maximumAmount optional String

The maximum amount you can send. The maximum amount you can receive if "amountType" is set as "receive"

 
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Unsupported currency",
    "errorCode": 1001,
    "data": {
        "currency": "BTL",
        "side": "send"
    }
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Unsupported pair of currencies-networks",
    "errorCode": 1002
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Unsupported network for currency",
    "errorCode": 1003,
    "data": {
        "currency": "BTC",
        "network": "BTL",
        "side": "send"
    }
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Currency suspended for specified network. Try again later",
    "errorCode": 1004,
    "data": {
        "currency": "BTC",
        "network": "BTC",
        "side": "send"
    }
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Not allowed amount",
    "errorCode": 1008,
    "data": {
        "minimumAmount": "0.00186",
        "maximumAmount": "30"
    }
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Could not provide rates for this pair of currencies. Try again later",
    "errorCode": 1011
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Invalid extra fee value. Enter a value between 0-0.1",
    "errorCode": 3001
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "You cannot set an extra fee. You are in affiliate share program",
    "errorCode": 3003
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Access to the extraFeeOverride parameter is granted only to API partners. If you would like to become an API partner contact us at [email protected]",
    "errorCode": 3005
}

Validate Address

Validate wallet address and tag for specified coin - network

get 
https://api.easybit.com/validateAddress

Header

Field Type Description
API-KEY String

Your API key

Parameter

Field Type Description
currency String

Ticker of currency to validate
address String

The wallet address you want to validate
network optional String

Ticker of network to validate. Default network will be selected if omitted
tag optional String

The wallet tag you want to validate

 
curl -X GET 'https://api.easybit.com/validateAddress?currency=BTC&address=0xeB2629a2734e272Bcc07BDA959863f316F4bD4Cf&network=BSC' -H 'API-KEY: your_api_key'

Successful Response

Field Type Description
success Integer

Success flag
data Object

The response data object
  address String

The wallet address you requested to validate
  tag optional String

The wallet tag you requested to validate

 
HTTP/1.1 200 OK
{
    "success": 1,
    "data": {
        "address": "0xeB2629a2734e272Bcc07BDA959863f316F4bD4Cf"
    }
}

Error

Name Type Description
success Integer

Success flag
errorMessage String

Error message
errorCode Integer

Error code
data Object

Data object
  currency String

Requested currency
  network optional String

Requested network
  address optional String

Requested address
  tag optional String

Requested tag

 
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Unsupported currency",
    "errorCode": 1001,
    "data": {
        "currency": "BTL"
    }
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Unsupported network for currency",
    "errorCode": 1003,
    "data": {
        "currency": "BTC",
        "network": "BTL"
    }
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Invalid address for specified network",
    "errorCode": 1005,
    "data": {
        "currency": "BTC",
        "network": "BTC",
        "address": "0xeB2629a2734e272Bcc07BDA959863f316F4bD4Cf"
    }
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Tag is not supported for specified network",
    "errorCode": 1006,
    "data": {
        "currency": "BTC",
        "network": "BTC"
    }
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Invalid tag for specified network",
    "errorCode": 1007,
    "data": {
        "currency": "XRP",
        "network": "XRP",
        "tag": "cd2f4dsk2-2x4V2f"
    }
}

Orders

Place Order

Place an exchange order

post 
https://api.easybit.com/order

Header

Field Type Description
API-KEY String

Your API key

Parameter

Field Type Description
send String

Ticker of currency to send
receive String

Ticker of currency to receive
amount Float

The amount you have to send
receiveAddress String

Receive wallet address
sendNetwork optional String

Ticker of network to send. Default network will be selected if omitted
receiveNetwork optional String

Ticker of network to receive. Default network will be selected if omitted
receiveTag optional String

Receive wallet address tag
amountType optional String

Set this parameter as "receive" if you want to specify as "amount" the receive amount
extraFeeOverride optional Float

Use this parameter to override the extra fee for a specific call. Allowed value range: 0-0.1, Maximum step size: 0.0001
vpm optional String

Volatility Protection Mode, 1-5 (maximum step size is 0.1) (If rates drop over the selected percentage cancel and refund)
refundAddress optional String

In case Volatility Protection Mode is on, you have to enter a refund address
refundTag optional String

In case Volatility Protection Mode is on, you may enter a refund tag

 
{
    "send": "BTC",
    "receive": "ETH",
    "amount": "0.123",
    "receiveAddress": "0xeB2629a2734e272Bcc07BDA959863f316F4bD4Cf"
}
curl -X POST 'https://api.easybit.com/order' -H 'API-KEY: your_api_key' -H "Content-type: application/json" -d '{"send":"BTC","receive":"ETH","amount":"0.123","receiveAddress":"0xeB2629a2734e272Bcc07BDA959863f316F4bD4Cf"}'

Successful Response

Field Type Description
success Integer

Success flag
data Object

The response data object
  id String

The order id
  send String

Ticker of currency to send
  receive String

Ticker of currency to receive
  sendNetwork String

Ticker of network to send
  receiveNetwork String

Ticker of network to receive
  sendAmount String

The amount you have to send
  receiveAmount String

Estimated receive amount (All fees included)
  sendAddress String

Our address you need to send the funds to
  sendTag String

Our address tag, null if not required (If tag is set and you fail to include it in your transfer the funds could be lost)
  receiveAddress String

Receive wallet address
  receiveTag String

Receive wallet tag
  refundAddress String

Refund wallet address
  refundTag String

Refund wallet tag
  vpm String

Volatility Protection Mode, "off" if it is not enabled
  createdAt Integer

Timestamp (UTC) (milliseconds)

 
HTTP/1.1 200 OK
{
    "success": 1,
    "data": {
        "id": "I1Y0EFP31Rwu",
        "send": "BTC",
        "receive": "ETH",
        "sendNetwork": "BTC",
        "receiveNetwork": "ETH",
        "sendAmount": "0.123",
        "receiveAmount": "1.73703678",
        "sendAddress": "1NiwKhcuV4Xrep5gnki4enFBBRH6hHuKzf",
        "sendTag": null,
        "receiveAddress": "0xeB2629a2734e272Bcc07BDA959863f316F4bD4Cf",
        "receiveTag": null,
        "refundAddress": null,
        "refundTag": null,
        "vpm": "off",
        "createdAt": 1643036313520
    }
}

Error

Name Type Description
success Integer

Success flag
errorMessage String

Error message
errorCode Integer

Error code
data optional Object

Data object
  currency optional String

Requested currency
  side optional String

Send or receive side
  network optional String

Requested network
  address optional String

Requested address
  tag optional String

Requested tag
  minimumAmount optional String

The minimum amount you can send. The minimum amount you can receive if "amountType" is set as "receive"
  maximumAmount optional String

The maximum amount you can send. The maximum amount you can receive if "amountType" is set as "receive"

 
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "We cannot accept any orders at the moment. Try again later",
    "errorCode": 1000
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Unsupported currency",
    "errorCode": 1001,
    "data": {
        "currency": "BTL",
        "side": "send"
    }
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Unsupported pair of currencies-networks",
    "errorCode": 1002
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Unsupported network for currency",
    "errorCode": 1003,
    "data": {
        "currency": "BTC",
        "network": "BTL",
        "side": "send"
    }
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Currency suspended for specified network. Try again later",
    "errorCode": 1004,
    "data": {
        "currency": "BTC",
        "network": "BTC",
        "side": "send"
    }
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Invalid address for specified network",
    "errorCode": 1005,
    "data": {
        "currency": "BTC",
        "network": "BTC",
        "address": "0xeB2629a2734e272Bcc07BDA959863f316F4bD4Cf"
    }
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Tag is not supported for specified network",
    "errorCode": 1006,
    "data": {
        "currency": "BTC",
        "network": "BTC"
    }
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Invalid tag for specified network",
    "errorCode": 1007,
    "data": {
        "currency": "XRP",
        "network": "XRP",
        "tag": "cd2f4dsk2-2x4V2f"
    }
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Not allowed amount",
    "errorCode": 1008,
    "data": {
        "minimumAmount": "0.00186",
        "maximumAmount": "30"
    }
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Invalid VPM value. Enter a value between 1-5",
    "errorCode": 1009
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Refund address is required when VPM is on",
    "errorCode": 1010
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Could not provide rates for this pair of currencies. Try again later",
    "errorCode": 1011
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Invalid extra fee value. Enter a value between 0-0.1",
    "errorCode": 3001
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "You cannot set an extra fee. You are in affiliate share program",
    "errorCode": 3003
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "VPM is disabled for your account. To enable it contact our support team",
    "errorCode": 3004
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Access to the extraFeeOverride parameter is granted only to API partners. If you would like to become an API partner contact us at [email protected]",
    "errorCode": 3005
}

Order Status

Get your order status

get 
https://api.easybit.com/orderStatus

Header

Field Type Description
API-KEY String

Your API key

Parameter

Field Type Description
id String

Order id

 
curl -X GET 'https://api.easybit.com/orderStatus?id=I1Y0EFP31Rwu' -H 'API-KEY: your_api_key'

Successful Response

Field Type Description
success Integer

Success flag
data Object

The response data object
  id String

The order id
  status String

"Awaiting Deposit" or "Confirming Deposit" or "Exchanging" or "Sending" or "Complete" or "Refund" or "Failed" or "Volatility Protection" or "Action Request" or "Request Overdue"
  receiveAmount String

Final receive amount if status is "Sending" or "Complete". Estimated receive amount for other statuses
  hashIn String

Hash/Txid of the send amount transfer
  hashOut String

Hash/Txid of the receive amount transfer
  createdAt Integer

Timestamp (UTC) (milliseconds)
  updatedAt Integer

Timestamp (UTC) (milliseconds)

 
HTTP/1.1 200 OK
{
    "success": 1,
    "data": {
        "id": "I1Y0EFP31Rwu",
        "status": "Awaiting Deposit",
        "receiveAmount": "1.73703678",
        "hashIn": null,
        "hashOut": null,
        "createdAt": 1643036313520,
        "updatedAt": 1643036313520
    }
}

Error

Name Type Description
success Integer

Success flag
errorMessage String

Error message
errorCode Integer

Error code

 
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Invalid order id",
    "errorCode": 2001
}

Orders

Get your orders

get 
https://api.easybit.com/orders

Header

Field Type Description
API-KEY String

Your API key

Parameter

Field Type Description
id optional String

Order id
limit optional Integer

How many orders to retreive 100, 500, 1000 or 2000
dateFrom optional Integer

Orders created after this Timestamp (UTC) (milliseconds)
dateTo optional Integer

Orders created before this Timestamp (UTC) (milliseconds)
sortDirection optional String

DESC for descending or ASC for ascending order. DESC by default
status optional String

Display orders with particular status

 
curl -X GET 'https://api.easybit.com/orders?dateFrom=1643016313520&sortDirection=ASC&status=Awaiting Deposit' -H 'API-KEY: your_api_key'

Successful Response

Field Type Description
success Integer

Success flag
data Object[]

The response data array of objects
  id String

The order id
  send String

Ticker of send currency
  receive String

Ticker of receive currency
  sendNetwork String

Ticker of send network
  receiveNetwork String

Ticker of receive network
  sendAmount String

Final send amount
  receiveAmount String

Final receive amount
  estimatedSendAmount String

Estimated send amount when the order was placed
  estimatedReceiveAmount String

Estimated receive amount when the order was placed
  sendAddress String

Our wallet address
  sendTag String

Our Wallet tag, null if not required
  receiveAddress String

Receive wallet address
  receiveTag String

Receive wallet tag
  refundAddress String

Refund wallet address
  refundTag String

Refund wallet tag
  vpm String

Volatility Protection Mode, "off" if it is not enabled
  status String

"Awaiting Deposit" or "Confirming Deposit" or "Exchanging" or "Sending" or "Complete" or "Refund" or "Failed" or "Volatility Protection" or "Action Request" or "Request Overdue"
  hashIn String

Hash/Txid of the send amount transfer
  hashOut String

Hash/Txid of the receive amount transfer
  networkFee String

Network fee of the receive currency (Included in the receiveAmount)
  earned String

The amount you earned in USDT
  createdAt Integer

Timestamp (UTC) (milliseconds)
  updatedAt Integer

Timestamp (UTC) (milliseconds)

 
HTTP/1.1 200 OK
{
    "success": 1,
    "data": [{
        "id": "I1Y0EFP31Rwu",
        "send": "BTC",
        "receive": "ETH",
        "sendNetwork": "BTC",
        "receiveNetwork": "ETH",
        "sendAmount": "0.123",
        "receiveAmount": "1.73703678",
        "estimatedSendAmount": "0.123",
        "estimatedReceiveAmount": "1.73703678",
        "sendAddress": "1NiwKhcuV4Xrep5gnki4enFBBRH6hHuKzf",
        "sendTag": null,
        "receiveAddress": "0xeB2629a2734e272Bcc07BDA959863f316F4bD4Cf",
        "receiveTag": null,
        "refundAddress": null,
        "refundTag": null,
        "vpm": "off",
        "status": "Awaiting Deposit",
        "hashIn": null,
        "hashOut": null,
        "networkFee": "0",
        "earned": "0",
        "createdAt": 1643036313520,
        "updatedAt": 1643036313520
    },
    {
        ...
    }]
}

Error

Name Type Description
success Integer

Success flag
errorMessage String

Error message
errorCode Integer

Error code

 
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Invalid order id",
    "errorCode": 2001
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Invalid status parameter",
    "errorCode": 2002
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Invalid limit parameter. Valid values: 100, 500, 1000 or 2000",
    "errorCode": 2003
}
HTTP/1.1 400 Bad Request
{
    "success": 0,
    "errorMessage": "Invalid sortDirection parameter. Valid values: DESC, ASC",
    "errorCode": 2004
}

Premium Partners

For our Premium API Partners we offer additional methods.
If you would like to become a Premium API Partner please contact our Support team.


Update Order

Access to this method is granted only to premium API partners.

post 
https://api.easybit.com/updateOrder

Pause Order

Access to this method is granted only to premium API partners.

post 
https://api.easybit.com/pauseOrder

Resume Order

Access to this method is granted only to premium API partners.

post 
https://api.easybit.com/resumeOrder

Refund Order

Access to this method is granted only to premium API partners.

post 
https://api.easybit.com/refundOrder
Suivi de Commande
Support