Back to top

Quickex API Documentation

Communication protocol: REST

Welcome

This is the documentation of Quickex API. Below you can find the descriptions of each request/method available.

GET REQUESTS

Rate

Get rate
GET/rate/{currencyPair}

This request gets the current rate. This rate does not include the transaction (miner) fee charged on every transaction.

Example URI

GET https://api.quickex.io/rate/eth_btc
URI Parameters
HideShow
currencyPair
string (required) Example: eth_btc

Currency pair

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "pair": "eth_btc",
  "rate": 0.03101315
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "pair": {
      "type": "string",
      "description": "Currency pair"
    },
    "rate": {
      "type": "number",
      "description": "Rate for currency pair"
    }
  },
  "required": [
    "pair",
    "rate"
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": "Pair eth_fake is currently unavailable."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Error message"
    }
  },
  "required": [
    "error"
  ]
}

Deposit limit

Get deposit limit
GET/limit/{currencyPair}

This request gets the limit on the amount that can be exchanged set by Quickex at the moment. Any surplus amount will be sent to the refund address. This is value is subject to change due to sudden market swings.

Example URI

GET https://api.quickex.io/limit/eth_btc
URI Parameters
HideShow
currencyPair
string (required) Example: eth_btc

Currency pair

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "pair": "eth_btc",
  "limit": 0.00003699,
  "min": 0.000001
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "pair": {
      "type": "string",
      "description": "Currency pair"
    },
    "limit": {
      "type": "number",
      "description": "Max limit for currency pair"
    },
    "min": {
      "type": "number",
      "description": "Min limit for currency pair"
    }
  },
  "required": [
    "pair",
    "limit",
    "min"
  ]
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "error": "Unknown pair"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Error message"
    }
  },
  "required": [
    "error"
  ]
}

Marketinfo

Get marketinfo
GET/marketinfo/{currencyPair}

This request gets the current market data.

Example URI

GET https://api.quickex.io/marketinfo/eth_btc
URI Parameters
HideShow
currencyPair
string (optional) Example: eth_btc

Currency pair

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "rate": 0.03101315,
  "limit": 0.0410287605,
  "pair": "eth_btc",
  "min": 0.001
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "rate": {
      "type": "number",
      "description": "Rate for currency pair"
    },
    "limit": {
      "type": "number",
      "description": "Max limit"
    },
    "pair": {
      "type": "string",
      "description": "Currency pair"
    },
    "min": {
      "type": "number",
      "description": "Min limit"
    }
  },
  "required": [
    "rate",
    "limit",
    "pair",
    "min"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "rate": 0.03101315,
    "limit": 0.0410287605,
    "pair": "eth_btc",
    "min": 0.001
  },
  {
    "rate": 31.74313635,
    "limit": 0.00003699,
    "pair": "btc_eth",
    "min": 0.000001
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "error": "Unknown pair"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Error message"
    }
  },
  "required": [
    "error"
  ]
}

Exchange request info

Get exchange request info
GET/txStat/{depositAddress}

This request gets details of an exchange transaction by the deposit address stated in the transaction.

Example URI

GET https://api.quickex.io/txStat/0x4d6DDdAF0baFe591C1E4Fba5F13350fD909d978F
URI Parameters
HideShow
depositAddress
string (required) Example: 0x4d6DDdAF0baFe591C1E4Fba5F13350fD909d978F

Deposit address

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "address": "0x4d6DDdAF0baFe591C1E4Fba5F13350fD909d978F",
  "withdraw": "19npLWanndix2Kif2eRz4W9JyHQTQ6fdX",
  "incomingCoin": 0.001,
  "incomingType": "ETH",
  "outgoingCoin": 0.00006126,
  "outgoingType": "BTC",
  "transaction": "04c20dd8-740b-4254-9a2a-7720a8a20dbf"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Success exchange status"
    },
    "address": {
      "type": "string",
      "description": "Deposit address"
    },
    "withdraw": {
      "type": "string",
      "description": "Withdraw address"
    },
    "incomingCoin": {
      "type": "number",
      "description": "Deposit amount"
    },
    "incomingType": {
      "type": "string",
      "description": "Deposit currency"
    },
    "outgoingCoin": {
      "type": "number",
      "description": "Withdrawal amount"
    },
    "outgoingType": {
      "type": "string",
      "description": "Withdrawal currency"
    },
    "transaction": {
      "type": "string",
      "description": "Transaction id"
    }
  },
  "required": [
    "status",
    "address",
    "withdraw",
    "incomingCoin",
    "incomingType",
    "outgoingCoin",
    "outgoingType",
    "transaction"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "waiting_exchange",
  "address": "0x4d6DDdAF0baFe591C1E4Fba5F13350fD909d978F",
  "withdraw": "19npLWanndix2Kif2eRz4W9JyHQTQ6fdX",
  "incomingCoin": 0.001,
  "incomingType": "ETH"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Waiting exchange status"
    },
    "address": {
      "type": "string",
      "description": "Deposit address"
    },
    "withdraw": {
      "type": "string",
      "description": "Withdrawal address"
    },
    "incomingCoin": {
      "type": "number",
      "description": "Deposit amount"
    },
    "incomingType": {
      "type": "string",
      "description": "Deposit currency"
    }
  },
  "required": [
    "status",
    "address",
    "withdraw",
    "incomingCoin",
    "incomingType"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "canceled_by_customer",
  "address": "0x4d6DDdAF0baFe591C1E4Fba5F13350fD909d978F"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Exchange transaction status (available statuses: `pending_deposit`, `too_low_deposit`, `time_expired`, `canceled_by_customer`)"
    },
    "address": {
      "type": "string",
      "description": "Deposit address"
    }
  },
  "required": [
    "status",
    "address"
  ]
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "error",
  "address": "0x2CEb271B86DD201D1fE54Ab3BE350D0Ecf759279",
  "error": "This address is NOT a Quickex deposit address. Do not send anything to it."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Error status"
    },
    "address": {
      "type": "string",
      "description": "Deposit address"
    },
    "error": {
      "type": "string",
      "description": "Error message"
    }
  },
  "required": [
    "status",
    "address",
    "error"
  ]
}

Coins

Get list of supported coins
GET/getcoins

This request allows anyone to get the list of all currencies that Quickex currently supports at any given time.

Example URI

GET https://api.quickex.io/getcoins
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "BTC": {
    "name": "BTC",
    "symbol": "Bitcoin",
    "image": "https://quickex.io/images/coins/btc.png",
    "imageSmall": "https://quickex.io/images/coins-sm/btc.png",
    "status": "available"
  },
  "ETH": {
    "name": "ETH",
    "symbol": "Etherium",
    "image": "https://quickex.io/images/coins/eth.png",
    "imageSmall": "https://quickex.io/images/coins-sm/eth.png",
    "status": "available"
  },
  "USD": {
    "name": "USD",
    "symbol": "United States dollar",
    "image": "https://quickex.io/images/coins/usd.png",
    "imageSmall": "https://quickex.io/images/coins-sm/usd.png",
    "status": "unavailable"
  },
  "EUR": {
    "name": "EUR",
    "symbol": "Euro",
    "image": "https://quickex.io/images/coins/eur.png",
    "imageSmall": "https://quickex.io/images/coins-sm/eur.png",
    "status": "unavailable"
  },
  "GBP": {
    "name": "GBP",
    "symbol": "Pound sterling",
    "image": "https://quickex.io/images/coins/gbp.png",
    "imageSmall": "https://quickex.io/images/coins-sm/gbp.png",
    "status": "unavailable"
  },
  "LTC": {
    "name": "LTC",
    "symbol": "Litecoin",
    "image": "https://quickex.io/images/coins/ltc.png",
    "imageSmall": "https://quickex.io/images/coins-sm/ltc.png",
    "status": "unavailable"
  },
  "BCH": {
    "name": "BCH",
    "symbol": "Bitcoin Cash",
    "image": "https://quickex.io/images/coins/bch.png",
    "imageSmall": "https://quickex.io/images/coins-sm/bch.png",
    "status": "available"
  },
  "ETC": {
    "name": "ETC",
    "symbol": "Ethereum Classic",
    "image": "https://quickex.io/images/coins/etc.png",
    "imageSmall": "https://quickex.io/images/coins-sm/etc.png",
    "status": "unavailable"
  },
  "EOS": {
    "name": "EOS",
    "symbol": "EOS",
    "image": "https://quickex.io/images/coins/eos.png",
    "imageSmall": "https://quickex.io/images/coins-sm/eos.png",
    "status": "unavailable"
  },
  "DASH": {
    "name": "DASH",
    "symbol": "DASH",
    "image": "https://quickex.io/images/coins/dash.png",
    "imageSmall": "https://quickex.io/images/coins-sm/dash.png",
    "status": "unavailable"
  }
}
Schema
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "name": {
        "type": "string",
        "description": "Currency name"
      },
      "symbol": {
        "type": "string",
        "description": "Currency symbol"
      },
      "image": {
        "type": "string",
        "description": "Currency image"
      },
      "imageSmall": {
        "type": "string",
        "description": "Currency small image"
      },
      "status": {
        "type": "string",
        "description": "Currency status"
      }
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": "Coins is currently unavailable."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Error message"
    }
  },
  "required": [
    "error"
  ]
}

Get a list of the most recent transactions

Get recent transactions
GET/recenttx/{max}

This request gets the list of the most recent transactions.

Example URI

GET https://api.quickex.io/recenttx/5
URI Parameters
HideShow
max
number (optional) Example: 5

Maximum number of transactions to return. If parameter is not specified this will return 5 transactions. Also, parameter must be a number between 1 and 50 (inclusive).

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "txid": "613d76d3-2f72-4003-844e-92b6dd160432",
    "amount": 0.00191317,
    "curIn": "ETH",
    "curOut": "ETC",
    "timestamp": "1536307658"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": "Recent transaction list is currently unavailable."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Error message"
    }
  },
  "required": [
    "error"
  ]
}

Get list of transactions with a private api key

Get transactions by api key
GET/txbyapikey/{apikey}

This request gets a list of transactions by a private api key. It allows affiliate partners to get a list of all transactions that have ever been created with a specific API key. Transactions are created with an affiliate public key but they are looked up by the relevant private key. Using public and private keys protects the privacy of our affiliates` account details.

Example URI

GET https://api.quickex.io/txbyapikey/23efa324efb213a
URI Parameters
HideShow
apikey
string (required) Example: 23efa324efb213a

Is the affiliate`s private api key.

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "inputTXID": "5306c5ed-38b6-4da0-a1c8-0e78b725ddc9",
    "inputAddress": "0x56Dc35da0Bd2776c024Fbc14eB15CbE105059696",
    "inputCurrency": "ETH",
    "inputAmount": 0.0025,
    "outputTXID": "311c56a08b3444894373476f9576a62987078fb8499878b9ca0264e893622863",
    "outputAddress": "3771GPPSfDixm3cy3dM6GvjzKYYqXRmQCD",
    "outputCurrency": "BTC",
    "outputAmount": 0.00310434,
    "status": "time_expired"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "": {
      "type": "object",
      "properties": {
        "inputTXID": {
          "type": "string",
          "description": "Transaction id"
        },
        "inputAddress": {
          "type": "string",
          "description": "Input address"
        },
        "inputCurrency": {
          "type": "string",
          "description": "Input currency"
        },
        "inputAmount": {
          "type": "number",
          "description": "Input amount"
        },
        "outputTXID": {
          "type": "string",
          "description": "Transaction hash"
        },
        "outputAddress": {
          "type": "string",
          "description": "Output address"
        },
        "outputCurrency": {
          "type": "string",
          "description": "Output currency"
        },
        "outputAmount": {
          "type": "number",
          "description": "Output amount"
        },
        "status": {
          "type": "string",
          "description": "Transaction status"
        }
      },
      "required": [
        "inputTXID",
        "inputAddress",
        "inputCurrency",
        "inputAmount",
        "outputTXID",
        "outputAddress",
        "outputCurrency",
        "outputAmount",
        "status"
      ]
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": "Can't find transactions"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Error message"
    }
  },
  "required": [
    "error"
  ]
}

Get list of transactions with a specific withdrawal address and private api key

Get transactions by withdrawal address and api key
GET/txbyaddress/{withdrawalAddress}/{apikey}

This request allows affiliate partners to get the list of all transactions that have ever been sent to one of their addresses in particular. The affilliate’s private key must be provided. This allows to get the list of the transactions that were sent to a particular destination address and were created using the affiliate’s public key.

Example URI

GET https://api.quickex.io/txbyaddress/3771GPPSfDixm3cy3dM6GvjzKYYqXRmQCD/23efa324efb213a
URI Parameters
HideShow
withdrawalAddress
string (required) Example: 3771GPPSfDixm3cy3dM6GvjzKYYqXRmQCD

Withdrawal address

apikey
string (required) Example: 23efa324efb213a

Is the affiliate`s private api key.

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "inputTXID": "5306c5ed-38b6-4da0-a1c8-0e78b725ddc9",
    "inputAddress": "0x56Dc35da0Bd2776c024Fbc14eB15CbE105059696",
    "inputCurrency": "ETH",
    "inputAmount": 0.0025,
    "outputTXID": "311c56a08b3444894373476f9576a62987078fb8499878b9ca0264e893622863",
    "outputAddress": "3771GPPSfDixm3cy3dM6GvjzKYYqXRmQCD",
    "outputCurrency": "BTC",
    "outputAmount": 0.00310434,
    "status": "time_expired"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": "Can't find transactions"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Error message"
    }
  },
  "required": [
    "error"
  ]
}

Validate address

Validate address
GET/validateAddress/{address}/{currency}

This request allows users to verify that their destination address is valid according to a given wallet daemon. If the request returns the value ‘true’, this address is validated by the coin daemon indicated by the currency symbol.

Example URI

GET https://api.quickex.io/validateAddress/3DWFocD1xA4Ws5uREcHbKYqTY2viVMxSV5/btc
URI Parameters
HideShow
address
string (required) Example: 3DWFocD1xA4Ws5uREcHbKYqTY2viVMxSV5

Address

currency
string (required) Example: btc

Currency

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "isvalid": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "isvalid": {
      "type": "boolean",
      "description": "Is valid address"
    }
  },
  "required": [
    "isvalid"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "isvalid": false,
  "error": "Invalid address."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "isvalid": {
      "type": "boolean",
      "description": "Is valid address"
    },
    "error": {
      "type": "string",
      "description": "Error message"
    }
  },
  "required": [
    "isvalid",
    "error"
  ]
}

POST REQUESTS

Create quick transaction

Create quick transaction
POST/quick

This request creates a quick transaction (without specifying the amount).

Example URI

POST https://api.quickex.io/quick
Request  with body
HideShow
  • withdrawal: 12v4rjzyXnRF7dwNb4ukxTpYrugBTy6nct (required, string) - Withdrawal address

  • pair: eth_btc (required, string) - Currency pair

  • returnAddress: 0xd68CcC74C32BAB4c4c6F289b3b1754f46a8311FE (required, string) - Return address

  • destTag: XRP destination tag (optional, string) - XRP destination tag

  • apiKey: 234eac2234a423f (optional, string) - Public api key

Headers
Content-Type: application/json
Body
{
  "withdrawal": "12v4rjzyXnRF7dwNb4ukxTpYrugBTy6nct",
  "pair": "eth_btc",
  "returnAddress": "0xd68CcC74C32BAB4c4c6F289b3b1754f46a8311FE",
  "destTag": "XRP destination tag",
  "apiKey": "234eac2234a423f"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "withdrawal": "qpjs462knq4anmpyyf7axypplff5s4dyyql0k9rlkc",
  "withdrawalType": "BCH",
  "deposit": "0x886C0620d8A59DD5D53946644a1D91326862D1e7",
  "depositType": "ETH",
  "orderId": "678492f6-2944-45ba-b031-8ce9f4b14141",
  "apiPubKey": "abe1278ac423349e775",
  "xrpDestTag": "xrp destination tag"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "withdrawal": {
      "type": "string",
      "description": "Withdrawal address"
    },
    "withdrawalType": {
      "type": "string",
      "description": "Withdrawal currency"
    },
    "deposit": {
      "type": "string",
      "description": "Deposit address"
    },
    "depositType": {
      "type": "string",
      "description": "Deposit currency"
    },
    "orderId": {
      "type": "string",
      "description": "Order id"
    },
    "apiPubKey": {
      "type": "string",
      "description": "Public api key"
    },
    "xrpDestTag": {
      "type": "string",
      "description": "Destination tag for currency XRP"
    }
  },
  "required": [
    "withdrawal",
    "withdrawalType",
    "deposit",
    "depositType",
    "orderId"
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": "Can't create quick transaction"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Error message"
    }
  },
  "required": [
    "error"
  ]
}

Create fixed transaction

Create fixed transaction
POST/sendamount

This allows users to request a fixed amount to be sent to a withdrawal address. You provide the withdrawal address and the amount you want to be sent to it. We return the amount you want to withdraw and the address this amount must be sent to and wait for your confirmation.

Example URI

POST https://api.quickex.io/sendamount
Request  with body
HideShow
  • amount: 0.03101415 (optional, number) - Withdrawal amount

Caution

If parameter amount passed, the parameter depositAmount should not be used.

  • depositAmount: 1 (optional, number) - Deposit amount

Caution

If parameter depositAmount passed, the parameter amount should not be used.

  • withdrawal: 12v4rjzyXnRF7dwNb4ukxTpYrugBTy6nct (required, string) - Withdrawal address

  • pair: eth_btc (required, string) - Currency pair

  • returnAddress: 0xd68CcC74C32BAB4c4c6F289b3b1754f46a8311FE (required, string) - Return address

  • destTag: XRP destination tag (optional, string) - XRP destination tag

  • apiKey: 234eac2234a423f (optional, string) - Public api key

Headers
Content-Type: application/json
Body
{
  "amount": 0.03101415,
  "withdrawal": "12v4rjzyXnRF7dwNb4ukxTpYrugBTy6nct",
  "pair": "eth_btc",
  "returnAddress": "0xd68CcC74C32BAB4c4c6F289b3b1754f46a8311FE",
  "destTag": "XRP destination tag",
  "apiKey": "234eac2234a423f"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "pair": "eth_btc",
  "withdrawal": "qpjs462knq4anmpyyf7axypplff5s4dyyql0k9rlkc",
  "withdrawalAmount": 0.001,
  "expiration": 1540456968,
  "maxLimit": 10,
  "deposit": "0x886C0620d8A59DD5D53946644a1D91326862D1e7",
  "depositAmount": 0.002,
  "quotedRate": 1,
  "orderId": "678492f6-2944-45ba-b031-8ce9f4b14141",
  "apiPubKey": "abe1278ac423349e775"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "pair": {
      "type": "string",
      "description": "Currency pair"
    },
    "withdrawal": {
      "type": "string",
      "description": "Withdrawal address"
    },
    "withdrawalAmount": {
      "type": "number",
      "description": "Withdrawal amount"
    },
    "expiration": {
      "type": "number",
      "description": "Expiration time for deposit"
    },
    "maxLimit": {
      "type": "number",
      "description": "Max limit for deposit"
    },
    "deposit": {
      "type": "string",
      "description": "Deposit address"
    },
    "depositAmount": {
      "type": "number",
      "description": "Deposit amount"
    },
    "quotedRate": {
      "type": "number",
      "description": "Quoted rate"
    },
    "orderId": {
      "type": "string",
      "description": "Order id"
    },
    "apiPubKey": {
      "type": "string",
      "description": "Public api key"
    }
  },
  "required": [
    "pair",
    "withdrawal",
    "withdrawalAmount",
    "expiration",
    "maxLimit",
    "deposit",
    "depositAmount",
    "quotedRate",
    "orderId"
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": "Can't create fixed amount transaction"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Error message"
    }
  },
  "required": [
    "error"
  ]
}

Quoted rate request

Quoted rate request
POST/sendamount

This request will return only the information about a quoted rate. It will NOT generate the deposit address.

Example URI

POST https://api.quickex.io/sendamount
Request  with body
HideShow
  • amount: 0.03101415 (required, number) - Withdrawal amount

  • pair: eth_btc (required, string) - Currency pair

Headers
Content-Type: application/json
Body
{
  "amount": 0.03101415,
  "pair": "eth_btc"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "quotedRate": 1,
  "maxLimit": 0.041028,
  "pair": "eth_btc",
  "withdrawalAmount": 0.001,
  "depositAmount": 0.002,
  "expiration": 1540456968
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "quotedRate": {
      "type": "number",
      "description": "Quoted rate"
    },
    "maxLimit": {
      "type": "number",
      "description": "Max limit"
    },
    "pair": {
      "type": "string",
      "description": "Currency pair"
    },
    "withdrawalAmount": {
      "type": "number",
      "description": "Withdrawal amount"
    },
    "depositAmount": {
      "type": "number",
      "description": "Deposit amount"
    },
    "expiration": {
      "type": "number",
      "description": "Expiration time for deposit"
    }
  },
  "required": [
    "quotedRate",
    "maxLimit",
    "pair",
    "withdrawalAmount",
    "depositAmount",
    "expiration"
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": "Can't create fixed amount transaction"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Error message"
    }
  },
  "required": [
    "error"
  ]
}

Cancel pending transaction

Cancel pending transaction
POST/cancelpending

This allows users to request cancellation of a pending transaction selected by the deposit address.

Example URI

POST https://api.quickex.io/cancelpending
Request  with body
HideShow
  • address: 0xd68CcC74C32BAB4c4c6F289b3b1754f46a8311FE (required, string) - The deposit address associated with the pending transaction
Headers
Content-Type: application/json
Body
{
  "address": "12v4rjzyXnRF7dwNb4ukxTpYrugBTy6nct"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": "Exchange request successfully update",
  "error": "null"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "string",
      "description": "Success message"
    },
    "error": {
      "type": "string",
      "description": "Error message (always null)"
    }
  },
  "required": [
    "success",
    "error"
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": "Can't cancel pending transaction"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Error message"
    }
  },
  "required": [
    "error"
  ]
}

Receive transaction result by email

Receive transaction result by email
POST/mail

This request allows to receive transaction’s id and result by email.

Example URI

POST https://api.quickex.io/mail
Request  with body
HideShow
  • email: test@example.com (required, string) - Email

  • txid: 038d2bd3-8e31-4a01-9c55-f57a23f307d7 (required, string) - Transaction id

Headers
Content-Type: application/json
Body
{
  "email": "test@example.com",
  "txid": "038d2bd3-8e31-4a01-9c55-f57a23f307d7"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "email": {
    "status": "success",
    "message": "Email receipt sent"
  }
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Status"
    },
    "message": {
      "type": "string",
      "description": "Success message"
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "email": {
    "status": "fail",
    "message": "Can't send message to email"
  }
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Status"
    },
    "message": {
      "type": "string",
      "description": "Fail message"
    }
  }
}

Generated by aglio on 30 Oct 2018