VIP Clients

Coincraddle API Documentation

Start
All requests sent to API Coincraddle maust include the parameter key (API key) available after signing up to our Partnership Program.

API URI https://coincraddle.com/v1/api

Response type json

GET REQUESTS

/validate-address - Address Validation
This request checks the validity of the address.
GET
https://coincraddle.com/v1/api/validate-address?key=3r8wzm4c8uo9ep5tk&currency=BTC&address=bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh

Parameter

ParameterTypeExample
keystring3r8wzm4c8uo9ep5tk
currencystringBTC
addressstringbc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh

Response 200

{
    "result":true
}
/rate - Exchange rate for transaction amount
This request gets the current exchange rate. Transaction fee is not included.
GET
https://coincraddle.com/v1/api/rate?key=3r8wzm4c8uo9ep5tk&from=BTC&to=USDT&amount=1&fix=0

Parameter

ParameterTypeExample
keystring3r8wzm4c8uo9ep5tk
fromstringBTC
tostringUSDT
amountfloat1
fixint 0 or 10

Response 200

{
  "fix": false,
  "minamount": 0.02,
  "maxamount": 120,
  "rate": 16776.052484164,
  "withdrawalFee": 3.96626 USDT,
  "result": true
}

* fix: true - fixed rate, false - floating rate

* withdrawalFee: approximate commission for withdrawal. Floating parameter.

/payment/rate - Payment rate for transaction amount
This request allows you to get the current exchange rate and calculate the amount of funds you need to send to receive a payment.
GET
https://coincraddle.com/v1/api/payment/rate?key=3r8wzm4c8uo9ep5tk&from=BTC&to=USDT&amountTo=1000

Parameter

ParameterTypeExample
keystring3r8wzm4c8uo9ep5tk
fromstringBTC
tostringUSDT
amountTofloat1000

Response 200

{
  "minamount": 0.02,
  "maxamount": 120,
  "rate": 0.04281856,
  "result": true
}

* rate: amount of funds to be sent

/currencies - Currency List
This request gets the list of all available currencies.
GET
https://coincraddle.com/v1/api/currencies?key=3r8wzm4c8uo9ep5tk

Parameter

ParameterTypeExample
keystring3r8wzm4c8uo9ep5tk

Response 200

{
  "BTC": {
    "coinName": "Bitcoin",
    "minamount": 0.1,
    "maxamount": 120,
    "tagname": "",
    "network":"",
    "available": true
  },
  "USDT": {
    "coinName": "Tether USD",
    "minamount": 1678.66,
    "maxamount": 2757528,
    "tagname": "",
    "network":"erc20",
    "available": true
  },
 "ETC": {
    "coinName": "Ethereum Classic",
    "minamount": 102.51,
    "maxamount": 1021451,
    "tagname": "",
    "network":"",
    "available": true
  },
  "HBAR": {
    "coinName": "Hedera",
    "minamount": 34045.98,
    "maxamount": 39867109,
    "tagname": "MEMO",
    "network": "",
    "available": true
  },
  ...
}

Note

If the tagname is not an empty value, the tag is a mandatory parameter for this currency.

/pairs - Pairs List
This request gets all pairs available for exchange.
GET
https://coincraddle.com/v1/api/pairs?key=3r8wzm4c8uo9ep5tk

Parameter

ParameterTypeExample
keystring3r8wzm4c8uo9ep5tk

Response 200

{
  "BTC": [
    "ZEC",
    "DAI",
    "USDT",
    "ETC",
    "BNB",
    "XRP"
  ],
  "XMR": [
    "USDC",
    "BTC",
    "USDT",
    "TUSD"
  ],
  "DASH": [
    "BTC",
    "USDT",
    "УЕР"
  ],
  "USDC": [
    "USDT",
    "ZEC"
  ],
  "LOOM": [
    "ETH",
    "PERL"
  ],
  "XRP": [
    "TRX"
  ],
  "ADA": [
    "USDT"
  ],
  "QTUM": [
    "BTC"
  ],
  ...
}
/exchange-create - Exchange Initiation
This request creates – initiates - the exchange.
GET
https://coincraddle.com/v1/api/exchange-create?key=3r8wzm4c8uo9ep5tk&from=BTC&to=ETH&amount=0.1&destinationAddress=0xDAFEA492D9c6733ae3d56b7Ed1ADB60692c98Bc5&refundAddress=bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh&fix=0

Parameter

ParameterTypeExample
keystring3r8wzm4c8uo9ep5tk
destinationAddressstring0xDAFEA492D9c6733ae3d56b7Ed1ADB60692c98Bc5
destinationTagoptionalstring
refundAddressstringbc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh
refundTagoptionalstring
fromstringBTC
tostringETH
amountfloat0.1
fixint 0 or 10

Response 200

{
    'id'             : '2a8ce4b6-ed5c-4c43-b4bd-ee2a9347fa7a',
    'depositAddress' : 'bc1qgdjqv0av3q56jvd82tkdjpy7gdp9ut8tlqmgrpmv24sq90ecnvqqjwvw97',
    'depositTag'     : '',
}
/payment/exchange-create - Payment Initiation
This request creates – initiates - the payment.
GET
https://coincraddle.com/v1/api/payment/exchange-create?key=3r8wzm4c8uo9ep5tk&from=BTC&to=ETH&amountTo=0.1&destinationAddress=0xDAFEA492D9c6733ae3d56b7Ed1ADB60692c98Bc5&refundAddress=bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh

Parameter

ParameterTypeExample
keystring3r8wzm4c8uo9ep5tk
destinationAddressstring0xDAFEA492D9c6733ae3d56b7Ed1ADB60692c98Bc5
destinationTagoptionalstring
refundAddressstringbc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh
refundTagoptionalstring
fromstringBTC
tostringETH
amountTofloat0.1

Response 200

{
    'id'             : '2a8ce4b6-ed5c-4c43-b4bd-ee2a9347fa7a',
    'depositAddress' : 'bc1qgdjqv0av3q56jvd82tkdjpy7gdp9ut8tlqmgrpmv24sq90ecnvqqjwvw97',
    'depositTag'     : '',
}
/payment/emergency - Time Expired Action Choice
Selecting an action (continuation of exchange or return) for an order in the payment_time_expired status.
GET
https://coincraddle.com/v1/api/payment/emergency?key=3r8wzm4c8uo9ep5tk&id=2a8ce4b6-ed5c-4c43-b4bd-ee2a9347fa7a&needExchange=0&refundAddress=bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh

Parameter

ParameterTypeExample
keystring3r8wzm4c8uo9ep5tk
idstring2a8ce4b6-ed5c-4c43-b4bd-ee2a9347fa7a
needExchangeint 0 or 10
refundAddressoptionalstringbc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh
refundTagoptionalstring

Response 200

{
    "result": true
}

* needExchange: 1 — Continue the exchange at the market rate at the time the selection was made or at the time the order was corrected. 0 — Refund minus miner fee.

* refundAddress: Required if "needExchange" = 0

/exchange-status - Getting exchange status
Getting information about the current exchange status
GET
https://coincraddle.com/v1/api/exchange-status?key=3r8wzm4c8uo9ep5tk&id=2a8ce4b6-ed5c-4c43-b4bd-ee2a9347fa7a

Parameter

ParameterTypeExample
keystring3r8wzm4c8uo9ep5tk
idstring2a8ce4b6-ed5c-4c43-b4bd-ee2a9347fa7a

Response 200

{
    'status'             : 'deposit_received',
    'from'               : 'BTC',
    'to'                 : 'USDT',
    'depositAddress'     : '1F1tAaz5x1HUXrCNLbtMDqcw6o5GNn4xqX',
    'depositTag'         : '',
    'destinationAddress' : '0xDAFEA492D9c6733ae3d56b7Ed1ADB60692c98Bc5',
    'destinationTag'     : '',
    'refundAddress'      : 'bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh',
    'refundTag'          : '',
    'expectedAmountFrom' : '0.1',
    "expectedAmountTo"   : '5443.75908463',
    "amountFrom"         : '0.1',
    "date"               : '01.05.2021 10:24:30',
    "txId"               : null,
    "amountTo"           : null,
    "emergency"          : {
        "status"         : 'EXPIRED'
    }
    "result"             : true
}

Explanatory Note

List of used statuses:
new - new exchange (awaiting deposit)
waiting_deposit - deposit confirming
deposit_received - deposit is received
exchanging - in the process of exchange
sending - in the process of sending
success - exchange completed successfully
time_expired - the waiting time for funds has expired
payment_time_expired - the waiting time for funds to make a payment has expired
failed - the exchange ended with an error
sending_failed - sending attempt failed
reverted - the funds were returned to the client
payment_halted - funds have arrived but an exchange is on hold

The list of statuses of suspended orders:
EXPIRED - the transaction was received after the expiration of the order
LESS - a transaction was sent with an amount less than in the order

/exchanges-status - Getting status for many exchanges
Getting information about the exchanges statuses
GET
https://coincraddle.com/v1/api/exchanges-status?key=3r8wzm4c8uo9ep5tk

Parameter

ParameterTypeExample
keystring3r8wzm4c8uo9ep5tk

Headers Parameter

ParameterTypeExample
idsarray['2a8ce4b6-ed5c-4c43-b4bd-ee2a9347fa7a', '3b5sa1n8-ev7c-4c43-b5ud-aa2a9347fa6k', '16257e7f-f9fc-4dbb-8ac7-63d0004b3064']

Response 200

{
   "0":{
      "id":"2a8ce4b6-ed5c-4c43-b4bd-ee2a9347fa7a",
      "status":"time_expired",
      "from":"ICX",
      "to":"BAT",
      "depositAddress":"hxd30cf2e9dd32f987d7858d7e964bf173b7429547",
      "depositTag":"",
      "destinationAddress":"0xc406e35bbcec5dc5c3576f159517bef0edc5ba98",
      "destinationTag":"",
      "refundAddress":"hx12b11f61c756609593040aa265e6bfb982b6f780",
      "refundTag":"",
      "expectedAmountFrom":"479",
      "expectedAmountTo":"440.26791571754",
      "amountFrom":null,
      "date":"19.09.2023 19:20:58",
      "txId":null,
      "amountTo":null
   },
   "1":{
      "id":"3b5sa1n8-ev7c-4c43-b5ud-aa2a9347fa6k",
      "status":"time_expired",
      "from":"TRX",
      "to":"USDTTRC20",
      "depositAddress":"TCQLDLUJ6iXaVx5ZYPUitgbsJietQmwXbu",
      "depositTag":"",
      "destinationAddress":"TLUQNgT28ha3hadx9CEptJeXrG7PeBaTC9",
      "destinationTag":"",
      "refundAddress":"TLUQNgT28ha3hadx9CEptJfXre7PeBaTC9",
      "refundTag":"",
      "expectedAmountFrom":"900",
      "expectedAmountTo":"71.689076",
      "amountFrom":null,
      "date":"12.09.2023 15:12:40",
      "txId":null,
      "amountTo":null
   },
   "2":{
      "id":"16257e7f-f9fc-4dbb-8ac7-63d0004b3064",
      "status":"success",
      "from":"ICX",
      "to":"BAT",
      "depositAddress":"hxfb212d7f1d5dba665c306f26d4bbcd83fdd77cf2",
      "depositTag":"",
      "destinationAddress":"0xc406e35bacec3dc5c3576f159517bef0edc5ba98",
      "destinationTag":"",
      "refundAddress":"hx12b11f61c756609593240aa265e6bfb982b6f780",
      "refundTag":"",
      "expectedAmountFrom":"348.884502",
      "expectedAmountTo":307.0772074462869,
      "amountFrom":"348.86450200",
      "date":"13.09.2023 09:13:25",
      "txId":"0xf7ab1826c2a186ce596abf67a964716f30efa40c8e07c70d92ac297cc4c94b88",
      "amountTo":"306.43493965"
   },
   "result":true
}

Explanatory Note

List of used statuses:
new - new exchange (awaiting deposit)
waiting_deposit - deposit confirming
deposit_received - deposit is received
exchanging - in the process of exchange
sending - in the process of sending
success - exchange completed successfully
time_expired - the waiting time for funds has expired
payment_time_expired - the waiting time for funds to make a payment has expired
failed - the exchange ended with an error
sending_failed - sending attempt failed
reverted - the funds were returned to the client
payment_halted - funds have arrived but an exchange is on hold

The list of statuses of suspended orders:
EXPIRED - the transaction was received after the expiration of the order
LESS - a transaction was sent with an amount less than in the order

/exchange-history - Getting a list of all exchanges
This method allows you to get all information on all exchanges
GET
https://coincraddle.com/v1/api/exchange-history?key=3r8wzm4c8uo9ep5tk

Parameter

ParameterTypeExample
keystring3r8wzm4c8uo9ep5tk
pageint0
limitint100 (max: 100)

Response 200

{
   "exchanges":[{
      "id":"2a8ce4b6-ed5c-4c43-b4bd-ee2a9347fa7a",
      "status":"time_expired",
      "from":"ICX",
      "to":"BAT",
      "depositAddress":"hxd30cf2e9dd32f987d7858d7e964bf173b7429547",
      "depositTag":"",
      "destinationAddress":"0xc406e35bbcec5dc5c3576f159517bef0edc5ba98",
      "destinationTag":"",
      "refundAddress":"hx12b11f61c756609593040aa265e6bfb982b6f780",
      "refundTag":"",
      "expectedAmountFrom":"479",
      "expectedAmountTo":"440.26791571754",
      "amountFrom":null,
      "date":"19.09.2023 19:20:58",
      "txId":null,
      "amountTo":null
   },
   {
      "id":"3b5sa1n8-ev7c-4c43-b5ud-aa2a9347fa6k",
      "status":"time_expired",
      "from":"TRX",
      "to":"USDTTRC20",
      "depositAddress":"TCQLDLUJ6iXaVx5ZYPUitgbsJietQmwXbu",
      "depositTag":"",
      "destinationAddress":"TLUQNgT28ha3hadx9CEptJeXrG7PeBaTC9",
      "destinationTag":"",
      "refundAddress":"TLUQNgT28ha3hadx9CEptJfXre7PeBaTC9",
      "refundTag":"",
      "expectedAmountFrom":"900",
      "expectedAmountTo":"71.689076",
      "amountFrom":null,
      "date":"12.09.2023 15:12:40",
      "txId":null,
      "amountTo":null
   },
   {
      "id":"16257e7f-f9fc-4dbb-8ac7-63d0004b3064",
      "status":"success",
      "from":"ICX",
      "to":"BAT",
      "depositAddress":"hxfb212d7f1d5dba665c306f26d4bbcd83fdd77cf2",
      "depositTag":"",
      "destinationAddress":"0xc406e35bacec3dc5c3576f159517bef0edc5ba98",
      "destinationTag":"",
      "refundAddress":"hx12b11f61c756609593240aa265e6bfb982b6f780",
      "refundTag":"",
      "expectedAmountFrom":"348.884502",
      "expectedAmountTo":307.0772074462869,
      "amountFrom":"348.86450200",
      "date":"13.09.2023 09:13:25",
      "txId":"0xf7ab1826c2a186ce596abf67a964716f30efa40c8e07c70d92ac297cc4c94b88",
      "amountTo":"306.43493965"
   }],
   "limit":100,
   "page":0,
   "result":true
}

Explanatory Note

List of used statuses:
new - new exchange (awaiting deposit)
waiting_deposit - deposit confirming
deposit_received - deposit is received
exchanging - in the process of exchange
sending - in the process of sending
success - exchange completed successfully
time_expired - the waiting time for funds has expired
payment_time_expired - the waiting time for funds to make a payment has expired
failed - the exchange ended with an error
sending_failed - sending attempt failed
reverted - the funds were returned to the client
payment_halted - funds have arrived but an exchange is on hold

The list of statuses of suspended orders:
EXPIRED - the transaction was received after the expiration of the order
LESS - a transaction was sent with an amount less than in the order

© 2020-2024 coincraddle.com

We use cookies to provide the experience on our website. By using CoinCraddle service, you agree to our Terms of use and Privacy policy.
Got it