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. |
https://coincraddle.com/v1/api/validate-address?key=3r8wzm4c8uo9ep5tk¤cy=BTC&address=bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh
Parameter
Parameter | Type | Example |
---|---|---|
key | string | 3r8wzm4c8uo9ep5tk |
currency | string | BTC |
address | string | bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh |
Response 200
{
"result":true
}
/rate - Exchange rate for transaction amount |
---|
This request gets the current exchange rate. Transaction fee is not included. |
https://coincraddle.com/v1/api/rate?key=3r8wzm4c8uo9ep5tk&from=BTC&to=USDT&amount=1
Parameter
Parameter | Type | Example |
---|---|---|
key | string | 3r8wzm4c8uo9ep5tk |
from | string | BTC |
to | string | USDT |
amount | float | 1 |
Response 200
{
"rate": 16776.052484164,
"withdrawalFee": 3.96626 USDT,
"result": true
}
* withdrawalFee - approximate commission for withdrawal. Floating parameter.
/currencies - Currency List |
---|
This request gets the list of all available currencies. |
https://coincraddle.com/v1/api/currencies?key=3r8wzm4c8uo9ep5tk
Parameter
Parameter | Type | Example |
---|---|---|
key | string | 3r8wzm4c8uo9ep5tk |
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. |
https://coincraddle.com/v1/api/pairs?key=3r8wzm4c8uo9ep5tk
Parameter
Parameter | Type | Example |
---|---|---|
key | string | 3r8wzm4c8uo9ep5tk |
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. |
https://coincraddle.com/v1/api/exchange-create?key=3r8wzm4c8uo9ep5tk&from=BTC&to=ETH&amount=0.1&destinationAddress=0xDAFEA492D9c6733ae3d56b7Ed1ADB60692c98Bc5&refundAddress=bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh
Parameter
Parameter | Type | Example |
---|---|---|
key | string | 3r8wzm4c8uo9ep5tk |
destinationAddress | string | 0xDAFEA492D9c6733ae3d56b7Ed1ADB60692c98Bc5 |
destinationTagoptional | string | |
refundAddress | string | bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh |
refundTagoptional | string | |
from | string | BTC |
to | string | ETH |
amount | float | 0.1 |
Response 200
{
'id' : '2a8ce4b6-ed5c-4c43-b4bd-ee2a9347fa7a',
'depositAddress' : 'bc1qgdjqv0av3q56jvd82tkdjpy7gdp9ut8tlqmgrpmv24sq90ecnvqqjwvw97',
'depositTag' : '',
}
/exchange-status - Getting exchange status |
---|
Getting information about the current exchange status |
https://coincraddle.com/v1/api/exchange-status?key=3r8wzm4c8uo9ep5tk&id=2a8ce4b6-ed5c-4c43-b4bd-ee2a9347fa7a
Parameter
Parameter | Type | Example |
---|---|---|
key | string | 3r8wzm4c8uo9ep5tk |
id | string | 2a8ce4b6-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,
"result" : true
}
Explanatory Note
List of used statuses: waiting_deposit
- waiting for the deposit 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 failed
- the exchange ended with an error sending_failed
- sending attempt failed reverted
- the funds were returned to the client
If you have any questions regarding the integration, be sure to contact us:
© 2020-2023 coincraddle.com