Quickex API Documentation

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

API URI https://quickex.io/v1/api

Response type json

GET REQUESTS

Address Validation

GET /validate-address
This request checks the validity of the address.

URI Example

GET https://quickex.io/v1/api/validate-address?key=partnerfe8f178d78e6450eadf8cf94d625f99d&currency=BTC&address=1NazEnVA6LwJdnKy5FSzck4jie1dMeqBGr

Parameter

Parameter Type Mandatory Example
key string
*
 partnerfe8f178d78e6450eadf8cf94d625f99d
currency string
*
 BTC
address string
*
 32L8R3RroBN2DvSWQdTS6FuXxb6S1w8aVj

Response 200

                        
{
    "result":true
}

Exchange rate for transaction amount

GET /rate
This request gets the current exchange rate. Transaction fee is not included.

URI Example

GET https://quickex.io/v1/api/rate?key=partnerfe8f178d78e6450eadf8cf94d625f99d&from=BTC&to=ETH&amount=0.1

URI Parameters

Parameter Type Mandatory Example
key string
*
 partnerfe8f178d78e6450eadf8cf94d625f99d
from string
*
 BTC
to string
*
 ETH
amount float
*
 0.1

Response 200

                        
{
  "rate": 5.71401849,
  "withdrawalFee": 0.0016 ETH,
  "result": true
}

* withdrawalFee - approximate commission for withdrawal. Floating parameter.

Currency List

GET /currencies
This request gets the list of all available currencies.

URI Example

GET https://quickex.io/v1/api/currencies?key=partnerfe8f178d78e6450eadf8cf94d625f99d

URI Parameters

Parameter Type Mandatory Example
key string
*
 partnerfe8f178d78e6450eadf8cf94d625f99d

Response 200

                        
{
  "BTC": {
    "minamount": "0.1",
    "tagname": "",
    "network":""
  },
  "USDT": {
    "minamount": 712.97423099,
    "tagname": "",
    "network":"erc20"
  },
 "XRP": {
    "minamount": 3764.53873239,
    "tagname": "TAG",
    "network":""
  },
  "BNB": {
    "minamount": 54.17387092,
    "tagname": "MEMO",
    "network":""
  },
  ...
}

Note

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

Pairs List

GET /pairs
This request gets all pairs available for exchange.

URI Example

GET https://quickex.io/v1/api/pairs?key=partnerfe8f178d78e6450eadf8cf94d625f99d

URI Parameters

Parameter Type Mandatory Example
key string
*
 partnerfe8f178d78e6450eadf8cf94d625f99d

Response 200

                        
{
  "USDS": [
    "BTC",
    "USDT",
    "BNB",
    "USDC",
    "PAX",
    "TUSD"
  ],
  "STORM": [
    "BTC",
    "USDT",
    "ETH",
    "BNB"
  ],
  "RDN": [
    "BTC",
    "ETH",
    "BNB"
  ],
  "BNT": [
    "BTC",
    "ETH"
  ],
  "EDO": [
    "BTC",
    "ETH"
  ],
  "GAS": [
    "BTC"
  ],
  "BGBP": [
    "USDC"
  ],
  "BTCB": [
    "BTC"
  ],
  ...
}

Exchange Initiation

GET /exchange-create
This request creates – initiates - the exchange.

URI Example

GET https://quickex.io/v1/api/exchange-create?key=partnerfe8f178d78e6450eadf8cf94d625f99d&from=BTC&to=ETH&amount=0.1&destinationAddress=0x56e26af2862f7b2d34a3504073b95325e1886b16&refundAddress=1PK8GBxMJDYBnrkHuQZyRWZuHRiEzWYTbr

URI Parameters

Parameter Type Mandatory Example
key string
*
 partnerfe8f178d78e6450eadf8cf94d625f99d
destinationAddress string
*
 0x56e26af2862f7b2d34a3504073b95325e1886b16
destinationTag string
refundAddress string
*
 1PK8GBxMJDYBnrkHuQZyRWZuHRiEzWYTbr
refundTag string
from string
*
 BTC
to string
*
 ETH
amount float
*
 0.1

Response 200

                        
{
    'id'             : '6f30947f-2d42-4eca-8358-0f60fa44079e',
    'depositAddress' : '1NazEnVA6LwJdnKy5FSzck4jie1dMeqBGr',
    'depositTag'     : '',
}

Getting exchange status

GET /exchange-status
Getting information about the current exchange status

URI Example

GET https://quickex.io/v1/api/exchange-status?key=partnerfe8f178d78e6450eadf8cf94d625f99d&id=6f30947f-2d42-4eca-8358-0f60fa44079e

URI Parameters

Parameter Type Mandatory Example
key string
*
 partnerfe8f178d78e6450eadf8cf94d625f99d
id string
*
 6f30947f-2d42-4eca-8358-0f60fa44079e

Response 200

                        
{
    'status'             : 'deposit_received',
    'from'               : 'BTC',
    'to'                 : 'USDT',
    'depositAddress'     : '1NazEnVA6LwJdnKy5FSzck4jie1dMeqBGr',
    'depositTag'         : '',
    'destinationAddress' : '0x56e26af2862f7b2d34a3504073b95325e1886b16',
    'destinationTag'     : '',
    'refundAddress'      : '1PK8GBxMJDYBnrkHuQZyRWZuHRiEzWYTbr',
    'refundTag'          : '',
    'expectedAmountFrom' : '0.1',
    "expectedAmountTo"   : '5443.75908463',
    "amountFrom"         : '0.1',
    "date"               : '10.03.2020 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:
Email: [email protected] Telegram: Telegram

© 2017-2019 Quickex.io