Orders API V2

Team Quickex

June 25, 2025

~1 min read

The orders section includes methods for creating an order and adding a user’s email to an existing order. Using the available methods, you can initiate an exchange through order creation, as well as attach an email for notifications about its status.

GET

orders

Endpoint URL

https://quickex.io/api/v2/orders

Documentation

General Description

The method returns a list of orders created by the user.

In fact, this is the order history for a specific partner/integration: each order in the response corresponds to a request to create an order sent with the same X-Api-Public-Key.

The method supports pagination and sorting by creation time.

HTTP Request

Method: GET
URL (prod): https://quickex.io/api/v2/orders

Request Example

curl -X 'GET' \
  'https://quickex.io/api/v2/orders?order=asc' \ -H 'accept: application/json' \ -H 'X-Api-Public-Key: {YOUR_PUBLIC_KEY}' \ -H 'X-Api-Timestamp: {UNIX_MS_TIMESTAMP}' \ -H 'X-Api-Signature: {SIGNATURE}' \

Headers

Header	Required	Description
Accept	Yes	Recommended value: `application/json`.
X-Api-Public-Key	Yes	Your public API key.
X-Api-Timestamp	Yes	Timestamp (usually UNIX in ms), used in the signature.
X-Api-Signature	Yes	Request signature (HMAC SHA256 per API v2 scheme).

Request Parameters

All parameters are passed in the query string.

Query Parameters

Parameter	Type	Required	Description
offset	int	No	Number of records to skip from the beginning. Used for pagination.
limit	int	No	Maximum number of orders in the response. Used for pagination.
order	string	No	Sorting order by creation date: `asc` — oldest to newest, `desc` — newest to oldest. Default `desc`.

If offset and limit are not specified, the full list of records for the partner is returned by default.

Response Format

The method returns a JSON array where each element is an order object created with the given API key.

Response Example

[
  {
    "orderId": 3209,
    "destinationAddress": "lnbc213490a70f987c097d897",
    "createdAt": "2025-12-10T15:15:32.394Z",
    "updatedAt": "2025-12-10T15:15:32.552Z",
    "destinationAddressMemo": null,
    "refundAddress": "TFe5tdqSy8CMGMDVHPJHLTK8hrAL6ddUpD",
    "refundAddressMemo": null,
    "claimedDepositAmount": "100",
    "claimedNetworkFee": "0.00002",
    "amountToGet": "0.00106686",
    "amountToGetUSDT": "98.15976599979",
    "amountToWithdrawFact": "0",
    "amountToWithdrawFactUSDT": "0",
    "instrumentFromCurrencyTitle": "USDT",
    "instrumentFromNetworkTitle": "TRC20",
    "instrumentToCurrencyTitle": "BTC",
    "instrumentToNetworkTitle": "Lightning Network",
    "ip": "77.246.100.22",
    "geoCode": "NL",
    "markup": "0",
    "userEmail": "qa@support.quickex.io",
    "completed": false,
    "state": "created"
  },
  {
    "orderId": 3208,
    "destinationAddress": "lnbc213490a70f987c097d897",
    "createdAt": "2025-12-10T15:12:05.830Z",
    "updatedAt": "2025-12-10T15:12:05.914Z",
    "destinationAddressMemo": null,
    "refundAddress": "TFe5tdqSy8CMGMDVHPJHLTK8hrAL6ddUpD",
    "refundAddressMemo": null,
    "claimedDepositAmount": "100",
    "claimedNetworkFee": "0.00002",
    "amountToGet": "0.0010655",
    "amountToGetUSDT": "98.15753399959",
    "amountToWithdrawFact": "0",
    "amountToWithdrawFactUSDT": "0",
    "instrumentFromCurrencyTitle": "USDT",
    "instrumentFromNetworkTitle": "TRC20",
    "instrumentToCurrencyTitle": "BTC",
    "instrumentToNetworkTitle": "Lightning Network",
    "ip": "77.246.100.22",
    "geoCode": "NL",
    "markup": "0",
    "userEmail": "qa@support.quickex.io",
    "completed": false,
    "state": "created"
  },
...
]

Response Field Breakdown

Each array element is an order object containing the following information:

Field	Type	Description
orderId	int	Unique order ID in the system.
destinationAddress	string	Recipient address where funds will be sent after exchange.
destinationAddressMemo	string / null	Additional field (memo/tag/payment ID) if required by the destination network.
refundAddress	string / null	Refund address if the deposit is invalid or an error occurs.
refundAddressMemo	string / null	Memo/tag for the refund address if required.
createdAt	string (ISO datetime)	Order creation date and time.
updatedAt	string (ISO datetime)	Last order update date and time.
claimedDepositAmount	string	Actual deposit amount received from the user.
claimedNetworkFee	string	Network fee calculated or actually deducted.
amountToGet	string	Amount the user should receive after exchange.
amountToGetUSDT	string	Equivalent of amountToGet in USDT.
amountToWithdrawFact	string	Amount actually sent to the user. If not sent yet — 0.
amountToWithdrawFactUSDT	string	Equivalent of amountToWithdrawFact in USDT.
instrumentFromCurrencyTitle	string	Deposit currency.
instrumentFromNetworkTitle	string	Deposit network.
instrumentToCurrencyTitle	string	Currency the user should receive.
instrumentToNetworkTitle	string	Network for withdrawal.
ip	string	User IP address.
geoCode	string	User country geolocation code (ISO).
markup	string	Partner markup (if any). Usually 0.
userEmail	string / null	User email, if provided.
completed	boolean	Order completion flag.
state	string	Current order status (created, kyc, trading, withdraw, refund).

Possible Use Cases

Retrieve the complete order history of a user.

Code Sample

Response Example

[
  {
    "orderId": 2096,
    "destinationAddress": "rMZiLhMHDKHSD9mMurzvixQGKFsDNLLP1",
    "createdAt": "2024-11-21T09:57:37.536Z",
    "updatedAt": "2024-11-21T09:57:37.536Z",
    "destinationAddressMemo": null,
    "refundAddress": null,
    "refundAddressMemo": null,
    "claimedDepositAmount": "11905.4",
    "claimedNetworkFee": "0.25",
    "amountToGet": "2000.535980286546",
    "amountToGetUSDT": "0",
    "amountToWithdrawFact": "0",
    "amountToWithdrawFactUSDT": "0",
    "instrumentFromCurrencyTitle": "TRX",
    "instrumentFromNetworkTitle": "TRX",
    "instrumentToCurrencyTitle": "XRP",
    "instrumentToNetworkTitle": "XRP",
    "ip": "165.22.73.162",
    "geoCode": "DE",
    "markup": "0",
    "userEmail": "qa@support.quickex.io",
    "completed": false,
    "state": "created"
  },
  {
    "orderId": 2097,
    "destinationAddress": "rMZiLhMHDKHSD9mMurzvixQGKFsDNLLP1",
    "createdAt": "2024-11-21T09:57:56.849Z",
    "updatedAt": "2024-11-21T09:57:56.849Z",
    "destinationAddressMemo": null,
    "refundAddress": null,
    "refundAddressMemo": null,
    "claimedDepositAmount": "500",
    "claimedNetworkFee": "0.25",
    "amountToGet": "88.201060256891",
    "amountToGetUSDT": "0",
    "amountToWithdrawFact": "0",
    "amountToWithdrawFactUSDT": "0",
    "instrumentFromCurrencyTitle": "TRX",
    "instrumentFromNetworkTitle": "TRX",
    "instrumentToCurrencyTitle": "XRP",
    "instrumentToNetworkTitle": "XRP",
    "ip": "165.22.73.162",
    "geoCode": "DE",
    "markup": "0",
    "userEmail": "qa@support.quickex.io",
    "completed": false,
    "state": "created"
  },
  {
    "orderId": 3038,
    "destinationAddress": "TFjfHBiDcL6B5S5W8g9b6gU2tbvnTR52ya",
    "createdAt": "2025-04-28T13:15:03.006Z",
    "updatedAt": "2025-07-22T10:36:58.557Z",
    "destinationAddressMemo": null,
    "refundAddress": null,
    "refundAddressMemo": null,
    "claimedDepositAmount": "0.034268",
    "claimedNetworkFee": "1.5",
    "amountToGet": "3263.05",
    "amountToGetUSDT": "3263.058154",
    "amountToWithdrawFact": "0",
    "amountToWithdrawFactUSDT": "0",
    "instrumentFromCurrencyTitle": "BTC",
    "instrumentFromNetworkTitle": "BTC",
    "instrumentToCurrencyTitle": "USDT",
    "instrumentToNetworkTitle": "TRC20",
    "ip": "45.76.90.73",
    "geoCode": "DE",
    "markup": "0",
    "userEmail": "qa@support.quickex.io",
    "completed": false,
    "state": "created"
  },
  {
    "orderId": 3172,
    "destinationAddress": "TPjT9p6UK5omA19h1QuYf4HbWvB9CukMzx",
    "createdAt": "2025-11-25T07:52:52.871Z",
    "updatedAt": "2025-11-27T11:34:19.690Z",
    "destinationAddressMemo": null,
    "refundAddress": null,
    "refundAddressMemo": null,
    "claimedDepositAmount": "52",
    "claimedNetworkFee": "2.054188275293",
    "amountToGet": "419.2",
    "amountToGetUSDT": "114.402051690569",
    "amountToWithdrawFact": "417.825363",
    "amountToWithdrawFactUSDT": "114.0245415627",
    "instrumentFromCurrencyTitle": "XRP",
    "instrumentFromNetworkTitle": "XRP",
    "instrumentToCurrencyTitle": "TRX",
    "instrumentToNetworkTitle": "TRX",
    "ip": "77.246.100.22",
    "geoCode": "NL",
    "markup": "0",
    "userEmail": "qa@support.quickex.io",
    "completed": true,
    "state": "withdraw"
  },
  {
    "orderId": 3192,
    "destinationAddress": "15vvDFQFksUS4r1cYxmjZuTVVUzWZSJauuUapg7Xjhgtkwqy",
    "createdAt": "2025-12-02T14:11:15.985Z",
    "updatedAt": "2025-12-02T14:11:16.107Z",
    "destinationAddressMemo": null,
    "refundAddress": "UQCGxjLy3msAFWG4r310Sk_rOz27QWRy252fdLMWJAMQJvSE",
    "refundAddressMemo": null,
    "claimedDepositAmount": "3300",
    "claimedNetworkFee": "0.14",
    "amountToGet": "2363.663",
    "amountToGetUSDT": "4999.384629917638",
    "amountToWithdrawFact": "0",
    "amountToWithdrawFactUSDT": "0",
    "instrumentFromCurrencyTitle": "TON",
    "instrumentFromNetworkTitle": "TON",
    "instrumentToCurrencyTitle": "DOT",
    "instrumentToNetworkTitle": "DOT",
    "ip": "77.246.100.22",
    "geoCode": "NL",
    "markup": "0",
    "userEmail": null,
    "completed": false,
    "state": "created"
  },
  {
    "orderId": 3193,
    "destinationAddress": "15vvDFQFksUS4r1cYxmjZuTVVUzWZSJauuUapg7Xjhgtkwqy",
    "createdAt": "2025-12-02T14:14:34.356Z",
    "updatedAt": "2025-12-02T14:14:34.557Z",
    "destinationAddressMemo": null,
    "refundAddress": "UQCGxjLy3msAFWG4r310Sk_rOz27QWRy252fdLMWJAMQJvSE",
    "refundAddressMemo": null,
    "claimedDepositAmount": "73",
    "claimedNetworkFee": "0.14",
    "amountToGet": "52.235",
    "amountToGetUSDT": "110.556162356583",
    "amountToWithdrawFact": "0",
    "amountToWithdrawFactUSDT": "0",
    "instrumentFromCurrencyTitle": "TON",
    "instrumentFromNetworkTitle": "TON",
    "instrumentToCurrencyTitle": "DOT",
    "instrumentToNetworkTitle": "DOT",
    "ip": "77.246.100.22",
    "geoCode": "NL",
    "markup": "0",
    "userEmail": null,
    "completed": false,
    "state": "created"
  }
]

Try it out

POST

orders/public/create

Endpoint URL

https://quickex.io/api/v2/orders/public/create

Documentation

General Description

The request creates a public exchange order at a pre-calculated rate.
The method is called after obtaining the rate via /api/v2/rates/public/one and fixes the trade parameters: instruments, deposit amount, rate, destination address, referral details, markup, etc.

HTTP Request

Method: POST
URL: https://quickex.io/api/v2/orders/public/create

Headers

Header	Required	Description
Accept	yes	application/json
Content-Type	yes	application/json
X-Api-Public-Key	yes	Your public API key
X-Api-Timestamp	yes	Arbitrary timestamp (usually in ms)
X-Api-Signature	yes	Request signature according to API v2 formula

Signature formula:

StrToSign = timestamp + body + publicKey
Signature = Base64(HMAC_SHA256(StrToSign, secretKey))

Request Example (the request was made using only mandatory parameters)

        curl -X 'POST' \
          'https://quickex.io/api/v2/orders/public/create' \
          -H 'Accept: application/json' \
          -H 'Content-Type: application/json' \
          -H 'X-Api-Public-Key: {YOUR_PUBLIC_KEY}' \
          -H 'X-Api-Timestamp: {UNIX_MS_TIMESTAMP}' \
          -H 'X-Api-Signature: {SIGNATURE}' \
          -d '{
            "instrumentFrom": {
              "currencyTitle": "TON",
              "networkTitle": "TON"
            },
            "instrumentTo": {
              "currencyTitle": "DOT",
              "networkTitle": "DOT"
            },
            "destinationAddress": "15vvDFQFksUS4r1cYxmjZuTVVUzWZSJauuUapg7Xjhgtkwqy",
            "refundAddress": "UQCGxjLy3msAFWG4r310Sk_rOz27QWRy252fdLMWJAMQJvSE",
            "claimedDepositAmount": "73"
          }'

Request Example

        curl -X 'POST' \
          'https://quickex.io/api/v2/orders/public/create' \
          -H 'Accept: application/json' \
          -H 'Content-Type: application/json' \
          -H 'X-Api-Public-Key: {YOUR_PUBLIC_KEY}' \
          -H 'X-Api-Timestamp: {UNIX_MS_TIMESTAMP}' \
          -H 'X-Api-Signature: {SIGNATURE}' \
          -d '{
          "instrumentFrom": { "currencyTitle": "USDT", "networkTitle": "TRC20"},
          "instrumentTo": { "currencyTitle": "LTC", "networkTitle": "LTC" },
          "destinationAddress": "MWYK4uQXFvWc1Bj1CPACyX5HTQxUUpRZ2e",
          "destinationAddressMemo": null,
          "refundAddress": "TFe5tdqSy8CMGMDVHPJHLTK8hrAL6ddUpD",
          "refundAddressMemo": null,
          "claimedDepositAmount": "3300",
          "claimedPublicRate": {
            "price": "0.014271620139287839394",
            "updatedAt": "2024-02-13T14:43:12.983Z",
            "claimedAmountToReceive": "47.09634645964987"
          },
          "claimedNetworkFee": "0.001",
          "userEmail": "test@example.com",
          "referrerId": "aff_some-affiliate-id",
          "markupAffiliateId": "aff_some-affiliate-id",
          "rateMode": "FLOATING",
          "utmData": {},
          "browserFingerprint": "string",
          "markup": "0.01",
          "mercuryoBearerToken": "string",
          "locale": "string"
        }'

Request Parameters

Parameters are passed in the request body (JSON).

Required Parameters

Field	Type	Required	Description
instrumentFrom	object	yes	The source instrument (what the user gives).
instrumentFrom.currencyTitle	string	yes	Currency code that the user sends (e.g., USDT).
instrumentFrom.networkTitle	string	yes	Network of the source instrument (e.g., TRC20).
instrumentTo	object	yes	Target instrument (what the user will receive).
instrumentTo.currencyTitle	string	yes	Target currency code (e.g., LTC).
instrumentTo.networkTitle	string	yes	Network of the target instrument (e.g., LTC).
destinationAddress	string	yes	Address to which funds will be sent after successful exchange.
destinationAddressMemo	string	no	Memo/Tag/Comment for the destination address (if required by the network).
refundAddress	string	yes	Address to return funds if the exchange does not occur.
refundAddressMemo	string	no	Memo/Tag for the refund address (if required by the network).
claimedDepositAmount	string	yes	Deposit amount the user commits to send.
claimedPublicRate	object	no	Rate and related parameters copied from /rates/public/one.
claimedPublicRate.price	string	no	Rate at which the exchange is calculated.
claimedPublicRate.updatedAt	string	no	Timestamp when the rate was valid (ISO8601).
claimedPublicRate.claimedAmountToReceive	string	no	Calculated amount the user will receive at this rate.
claimedNetworkFee	string	no	Network fee included in the calculation (if applicable).
userEmail	string	no	User email for notifications.
legacyOrderId	string	no	Order ID from a legacy system (for migration/mapping purposes).
referrerId	string	no	Referral/partner ID.
markupAffiliateId	string	no	Partner ID associated with the markup.
rateMode	string	no	Rate mode, e.g., FLOATING/FIXED depending on implementation.
utmData	object	no	Object with UTM tags (traffic source, campaign, etc.).
browserFingerprint	string	no	Browser fingerprint for additional protection/analytics.
markup	string	no	Partner markup (e.g., 0.01 for +1%).
mercuryoBearerToken	string	no	Third-party provider token (e.g., Mercuryo) if using off-ramp/on-ramp.
locale	string	no	User locale (e.g., en, ru) for email/UI templates.

Response Format

The method returns a JSON object describing the created order, deposit address, and current deposits/withdrawals.

Full Response Example

        {
          "deposits": [
            {
              "createdAt": "2025-12-02T08:52:08.178Z",
              "instrument": {
                "currencyTitle": "USDT",
                "networkTitle": "TRC20"
              },
              "amount": "1000.1",
              "confirmations": 0,
              "txId": "0xdeadc0dedeadbeef",
              "depositAddress": "0xdeadc0de",
              "isPending": true,
              "id": 0,
              "counterPartyAddress": "0xdeadc0dedeadbeef"
            }
          ],
          "withdrawals": [
            {
              "createdAt": "2025-12-02T08:52:08.178Z",
              "instrument": {
                "currencyTitle": "USDT",
                "networkTitle": "TRC20"
              },
              "amount": "1000.1",
              "networkFee": "1.1",
              "txId": "0xdeadc0dedeadbeef"
            }
          ],
          "depositAddress": {
            "orderId": 0,
            "liquidityProviderTitle": "WHITEBIT_BUSINESS_ACCOUNT",
            "instrument": {
              "currencyTitle": "USDT",
              "networkTitle": "TRC20"
            },
            "depositAddress": "0xdeadc0de",
            "depositAddressMemo": "string",
            "redirectUrl": "string"
          },
          "orderId": 0,
          "userId": 0,
          "legacyOrderId": "string",
          "pair": {
            "instrumentFrom": {
              "currencyTitle": "USDT",
              "networkTitle": "TRC20"
            },
            "instrumentTo": {
              "currencyTitle": "USDT",
              "networkTitle": "TRC20"
            }
          },
          "createdAt": "2025-12-02T08:52:08.179Z",
          "claimedDepositAmount": "10.01",
          "amountToGet": "10.01",
          "claimedPublicRate": {
            "price": "1000.1",
            "quotes": {
              "sellQuote": {
                "baseValue": "1000.1",
                "quoteValue": "1000.1"
              },
              "buyQuote": {
                "baseValue": "1000.1",
                "quoteValue": "1000.1"
              }
            },
            "updatedAt": "2025-12-02T08:52:08.179Z",
            "liquidityProviderPublicCode": "formulae",
            "claimedAmountToReceive": "0.01",
            "finalNetworkFeeAmount": "0.01",
            "platformFee_Absolute": "0.01",
            "fixedRate_maxAmount": "1000.000",
            "fixedRate_maxTimeMinutes": 1,
            "fixedRate_maxRateVolatilityPercent": "1000.000"
          },
          "claimedNetworkFee": "10.01",
          "KYCFormLink": "string",
          "orderEvents": [
            {
              "kind": "TRACKING_STARTED",
              "createdAt": "2025-12-02T08:52:08.179Z"
            }
          ],
          "userEmail": "test@example.com",
          "rateMode": "FLOATING",
          "destinationAddress": "0xdeadbeef",
          "destinationAddressMemo": "0xdeadbeef",
          "completed": false,
          "possibleCashbackAmountUSDT": "500.00",
          "redirectUrl": "https://payments.mercuryo.io/",
          "minConfirmationsToTrade": 3,
          "minConfirmationsToWithdraw": 3
        }

Response Field Breakdown

Deposits (deposits)

            "deposits": [
          {
            "createdAt": "2025-12-02T08:44:15.824Z",
            "instrument": {
              "currencyTitle": "USDT",
              "networkTitle": "TRC20"
            },
            "amount": "1000.1",
            "confirmations": 0,
            "txId": "0xdeadc0dedeadbeef",
            "depositAddress": "0xdeadc0de",
            "isPending": true,
            "id": 0,
            "counterPartyAddress": "0xdeadc0dedeadbeef"
          }
        ]

Field	Type	Description
deposits	array	List of deposits for the order (usually 0 or 1 record if user made one transfer).
createdAt	string	Deposit registration time.
instrument	object	Instrument in which deposit was made (currency and network).
instrument.currencyTitle	string	Deposit currency code (USDT).
instrument.networkTitle	string	Deposit network (TRC20).
amount	string	Deposit amount.
confirmations	number	Number of network confirmations for this deposit.
txId	string	Deposit transaction hash on blockchain.
depositAddress	string	Address to which the deposit was sent (Quickex/provider deposit address).
isPending	boolean	Flag indicating deposit is still awaiting sufficient confirmations.
id	number	Internal deposit record ID.
counterPartyAddress	string	Sender address (user wallet or source of funds).

Withdrawals (withdrawals)

            "withdrawals": [
          {
            "createdAt": "2025-12-02T08:44:15.825Z",
            "instrument": {
              "currencyTitle": "USDT",
              "networkTitle": "TRC20"
            },
            "amount": "1000.1",
            "networkFee": "1.1",
            "txId": "0xdeadc0dedeadbeef"
          }
        ]

Field	Type	Description
withdrawals	array	List of withdrawals to the user.
createdAt	string	Initiation or registration time of the withdrawal.
instrument	object	Withdrawal instrument (currency/network).
amount	string	Amount withdrawn to the user.
networkFee	string	Network fee deducted during withdrawal.
txId	string	Blockchain transaction hash for the withdrawal.

Deposit Address (depositAddress)

            "depositAddress": {
          "orderId": 0,
          "liquidityProviderTitle": "WHITEBIT_BUSINESS_ACCOUNT",
          "instrument": {
            "currencyTitle": "USDT",
            "networkTitle": "TRC20"
          },
          "depositAddress": "0xdeadc0de",
          "depositAddressMemo": "string",
          "redirectUrl": "string"
        }

Field	Type	Description
orderId	number	Order ID associated with the deposit address.
liquidityProviderTitle	string	Name of liquidity provider or deposit acceptance scheme.
instrument	object	Deposit instrument (currency/network).
depositAddress	string	Deposit address where user should send funds.
depositAddressMemo	string	Memo/Tag/Comment for the deposit (if required by network).
redirectUrl	string	Redirect URL (if using external payment provider/widget).

General Order Information

            "orderId": 0,
        "userId": 0,
        "legacyOrderId": "string",
        "pair": {
          "instrumentFrom": {
            "currencyTitle": "USDT",
            "networkTitle": "TRC20"
          },
          "instrumentTo": {
            "currencyTitle": "USDT",
            "networkTitle": "TRC20"
          }
        },
        "createdAt": "2025-12-02T08:44:15.825Z",
        "claimedDepositAmount": "10.01",
        "amountToGet": "10.01"

Field	Type	Description
orderId	number	Unique order ID in the Quickex system.
userId	number	User ID (if order is tied to an account).
legacyOrderId	string	Order ID in a legacy system (if used for migration/compatibility).
pair	object	Order instrument pair (from which currency to which currency).
pair.instrumentFrom	object	Source instrument of the order.
pair.instrumentTo	object	Target instrument of the order.
createdAt	string	Order creation time.
claimedDepositAmount	string	Deposit amount on which the order was created.
amountToGet	string	Amount the user should receive from the order.

claimedPublicRate Block

            "claimedPublicRate": {
          "price": "1000.1",
          "quotes": {
            "sellQuote": {
              "baseValue": "1000.1",
              "quoteValue": "1000.1"
            },
            "buyQuote": {
              "baseValue": "1000.1",
              "quoteValue": "1000.1"
            }
          }
        }

Field	Type	Description
claimedPublicRate	object	Rate and quotes used to create the order. Usually a copy or subset of /rates/public/one.
claimedPublicRate.price	string	Rate at which claimedDepositAmount and amountToGet were calculated.
claimedPublicRate.quotes	object	Detailed quotes (sell/buy) for debugging and analytics.
sellQuote.baseValue	string	Base value (volume of base asset).
sellQuote.quoteValue	string	Corresponding quote value.
buyQuote.baseValue	string	Base value for the buy operation.
buyQuote.quoteValue	string	Corresponding quote value.

Possible Use Cases

Creating an order from your frontend/bot/integration after obtaining a preliminary rate.

Code Sample

Response Example

{
  "deposits": [
    {
      "createdAt": "2025-12-02T08:52:08.178Z",
      "instrument": {
        "currencyTitle": "USDT",
        "networkTitle": "TRC20"
      },
      "amount": "1000.1",
      "confirmations": 0,
      "txId": "0xdeadc0dedeadbeef",
      "depositAddress": "0xdeadc0de",
      "isPending": true,
      "id": 0,
      "counterPartyAddress": "0xdeadc0dedeadbeef"
    }
  ],
  "withdrawals": [
    {
      "createdAt": "2025-12-02T08:52:08.178Z",
      "instrument": {
        "currencyTitle": "USDT",
        "networkTitle": "TRC20"
      },
      "amount": "1000.1",
      "networkFee": "1.1",
      "txId": "0xdeadc0dedeadbeef"
    }
  ],
  "depositAddress": {
    "orderId": 0,
    "liquidityProviderTitle": "WHITEBIT_BUSINESS_ACCOUNT",
    "instrument": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20"
    },
    "depositAddress": "0xdeadc0de",
    "depositAddressMemo": "string",
    "redirectUrl": "string"
  },
  "orderId": 0,
  "userId": 0,
  "legacyOrderId": "string",
  "pair": {
    "instrumentFrom": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20"
    },
    "instrumentTo": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20"
    }
  },
  "createdAt": "2025-12-02T08:52:08.179Z",
  "claimedDepositAmount": "10.01",
  "amountToGet": "10.01",
  "claimedPublicRate": {
    "price": "1000.1",
    "quotes": {
      "sellQuote": {
        "baseValue": "1000.1",
        "quoteValue": "1000.1"
      },
      "buyQuote": {
        "baseValue": "1000.1",
        "quoteValue": "1000.1"
      }
    },
    "updatedAt": "2025-12-02T08:52:08.179Z",
    "liquidityProviderPublicCode": "formulae",
    "claimedAmountToReceive": "0.01",
    "finalNetworkFeeAmount": "0.01",
    "platformFee_Absolute": "0.01",
    "fixedRate_maxAmount": "1000.000",
    "fixedRate_maxTimeMinutes": 1,
    "fixedRate_maxRateVolatilityPercent": "1000.000"
  },
  "claimedNetworkFee": "10.01",
  "KYCFormLink": "string",
  "orderEvents": [
    {
      "kind": "TRACKING_STARTED",
      "createdAt": "2025-12-02T08:52:08.179Z"
    }
  ],
  "userEmail": "test@example.com",
  "rateMode": "FLOATING",
  "destinationAddress": "0xdeadbeef",
  "destinationAddressMemo": "0xdeadbeef",
  "completed": false,
  "possibleCashbackAmountUSDT": "500.00",
  "redirectUrl": "https://payments.mercuryo.io/",
  "minConfirmationsToTrade": 3,
  "minConfirmationsToWithdraw": 3
}

Try it out

POST

orders/public/set-email

Endpoint URL

https://quickex.io/api/v2/orders/public/set-email

Documentation

Overview

This method allows you to set an email for an already created public order.

It is used when the order was created without userEmail in the /api/v2/orders/public/create request, but later you need to attach an email (for example, so the user can receive notifications about the order status).

> Important: The email can be set only once. If the order already has a userEmail, it cannot be changed through this method.

HTTP Request

Method: POST
URL: https://quickex.io/api/v2/orders/public/set-email

Request Example

curl -X 'POST' \
  'https://quickex.io/api/v2/orders/public/set-email' \
  -H 'accept: application/json' \
  -H 'X-Api-Public-Key: {YOUR_PUBLIC_KEY}' \
  -H 'X-Api-Timestamp: {UNIX_MS_TIMESTAMP}' \
  -H 'X-Api-Signature: {SIGNATURE}' \
  -H 'Content-Type: application/json' \
  -d '{
  "orderId": 3038,
  "userEmail": "QA@quickex.com"
}'

Headers

Header	Required	Description
`Accept`	yes	Recommended value: `application/json`.
`Content-Type`	yes	application/json.
`X-Api-Public-Key`	yes	Your public API key.
`X-Api-Timestamp`	yes	Timestamp (usually UNIX in ms), included in the signature.
`X-Api-Signature`	yes	Request signature (HMAC SHA256 according to API v2 scheme).

Request Parameters

Body Parameters

{
  "orderId": 3038,
  "userEmail": "QA@quickex.com"
}

Field	Type	Required	Description
`orderId`	number	yes	The ID of the order for which you want to set the email.
`userEmail`	string	yes	The user’s email that will be attached to the order and used for notifications.

Constraints: If userEmail is already set for this order, the method will return a 403 ERR_FORBIDDEN error.

Response Format

If the request is successful, the method returns a JSON object of the order, similar to the response from POST /api/v2/orders/public/create / GET /api/v2/orders/info, but with the userEmail field set.

Response Example

{
  "deposits": [
    {
      "createdAt": "2025-12-02T09:31:46.246Z",
      "instrument": {
        "currencyTitle": "USDT",
        "networkTitle": "TRC20"
      },
      "amount": "1000.1",
      "confirmations": 0,
      "txId": "0xdeadc0dedeadbeef",
      "depositAddress": "0xdeadc0de",
      "isPending": true,
      "id": 0,
      "counterPartyAddress": "0xdeadc0dedeadbeef"
    }
  ],
  "withdrawals": [
    {
      "createdAt": "2025-12-02T09:31:46.246Z",
      "instrument": {
        "currencyTitle": "USDT",
        "networkTitle": "TRC20"
      },
      "amount": "1000.1",
      "networkFee": "1.1",
      "txId": "0xdeadc0dedeadbeef"
    }
  ],
  "depositAddress": {
    "orderId": 0,
    "liquidityProviderTitle": "WHITEBIT_BUSINESS_ACCOUNT",
    "instrument": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20"
    },
    "depositAddress": "0xdeadc0de",
    "depositAddressMemo": "string",
    "redirectUrl": "string"
  },
  "orderId": 0,
  "userId": 0,
  "legacyOrderId": "string",
  "pair": {
    "instrumentFrom": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20"
    },
    "instrumentTo": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20"
    }
  },
  "createdAt": "2025-12-02T09:31:46.246Z",
  "claimedDepositAmount": "10.01",
  "amountToGet": "10.01",
  "claimedPublicRate": {
    "price": "1000.1",
    "quotes": {
      "sellQuote": {
        "baseValue": "1000.1",
        "quoteValue": "1000.1"
      },
      "buyQuote": {
        "baseValue": "1000.1",
        "quoteValue": "1000.1"
      }
    },
    "updatedAt": "2025-12-02T09:31:46.246Z",
    "liquidityProviderPublicCode": "formulae",
    "claimedAmountToReceive": "0.01",
    "finalNetworkFeeAmount": "0.01",
    "platformFee_Absolute": "0.01",
    "fixedRate_maxAmount": "1000.000",
    "fixedRate_maxTimeMinutes": 1,
    "fixedRate_maxRateVolatilityPercent": "1000.000"
  },
  "claimedNetworkFee": "10.01",
  "KYCFormLink": "string",
  "orderEvents": [
    {
      "kind": "TRACKING_STARTED",
      "createdAt": "2025-12-02T09:31:46.246Z"
    }
  ],
  "userEmail": "QA@example.com",
  "rateMode": "FLOATING",
  "destinationAddress": "0xdeadbeef",
  "destinationAddressMemo": "0xdeadbeef",
  "completed": false,
  "possibleCashbackAmountUSDT": "500.00",
  "redirectUrl": "https://payments.mercuryo.io/",
  "minConfirmationsToTrade": 3,
  "minConfirmationsToWithdraw": 3
}

Key point: the userEmail field linked to the order will be filled in the response.

Errors

403 ERR_FORBIDDEN — Email Already Set

{
  "status": "ERR_FORBIDDEN",
  "message": "Order.userEmail already set and can not be modified"
}

This error is returned if you attempt to change the email for an order where userEmail has already been set (either during order creation or in a previous set-email call).

What to do:

Do not attempt to reset the email for existing orders.

Possible Use Cases

Adding an email for orders created anonymously (for example, via a widget without a required email field).

Code Sample

Response Example

{
  "deposits": [
    {
      "createdAt": "2025-12-02T09:31:46.246Z",
      "instrument": {
        "currencyTitle": "USDT",
        "networkTitle": "TRC20"
      },
      "amount": "1000.1",
      "confirmations": 0,
      "txId": "0xdeadc0dedeadbeef",
      "depositAddress": "0xdeadc0de",
      "isPending": true,
      "id": 0,
      "counterPartyAddress": "0xdeadc0dedeadbeef"
    }
  ],
  "withdrawals": [
    {
      "createdAt": "2025-12-02T09:31:46.246Z",
      "instrument": {
        "currencyTitle": "USDT",
        "networkTitle": "TRC20"
      },
      "amount": "1000.1",
      "networkFee": "1.1",
      "txId": "0xdeadc0dedeadbeef"
    }
  ],
  "depositAddress": {
    "orderId": 0,
    "liquidityProviderTitle": "WHITEBIT_BUSINESS_ACCOUNT",
    "instrument": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20"
    },
    "depositAddress": "0xdeadc0de",
    "depositAddressMemo": "string",
    "redirectUrl": "string"
  },
  "orderId": 0,
  "userId": 0,
  "legacyOrderId": "string",
  "pair": {
    "instrumentFrom": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20"
    },
    "instrumentTo": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20"
    }
  },
  "createdAt": "2025-12-02T09:31:46.246Z",
  "claimedDepositAmount": "10.01",
  "amountToGet": "10.01",
  "claimedPublicRate": {
    "price": "1000.1",
    "quotes": {
      "sellQuote": {
        "baseValue": "1000.1",
        "quoteValue": "1000.1"
      },
      "buyQuote": {
        "baseValue": "1000.1",
        "quoteValue": "1000.1"
      }
    },
    "updatedAt": "2025-12-02T09:31:46.246Z",
    "liquidityProviderPublicCode": "formulae",
    "claimedAmountToReceive": "0.01",
    "finalNetworkFeeAmount": "0.01",
    "platformFee_Absolute": "0.01",
    "fixedRate_maxAmount": "1000.000",
    "fixedRate_maxTimeMinutes": 1,
    "fixedRate_maxRateVolatilityPercent": "1000.000"
  },
  "claimedNetworkFee": "10.01",
  "KYCFormLink": "string",
  "orderEvents": [
    {
      "kind": "TRACKING_STARTED",
      "createdAt": "2025-12-02T09:31:46.246Z"
    }
  ],
  "userEmail": "QA@example.com",
  "rateMode": "FLOATING",
  "destinationAddress": "0xdeadbeef",
  "destinationAddressMemo": "0xdeadbeef",
  "completed": false,
  "possibleCashbackAmountUSDT": "500.00",
  "redirectUrl": "https://payments.mercuryo.io/",
  "minConfirmationsToTrade": 3,
  "minConfirmationsToWithdraw": 3
}

Try it out

GET

orders/public-info

Endpoint URL

https://quickex.io/api/v2/orders/public-info

Documentation

General Description

This method returns detailed information about a specific order by its orderId.
Unlike the order list (GET /api/v2/orders), it provides all data related to the selected order:
the full instrument pair with parameters, the fixed rate (claimedPublicRate),
confirmation limits, the event history (orderEvents), the deposit address,
as well as information about potential cashback or referral accruals and the completion status.
Access to orders is restricted by the current API key — you can only view orders that were created
using your X-Api-Public-Key.

HTTP Request

Method: GET
URL: https://quickex.io/api/v2/orders/public-info

Example Request

curl -X 'GET' \
  'https://quickex.io/api/v2/orders/public-info?orderId=3038' \
  -H 'accept: application/json' \
  -H 'X-Api-Public-Key: {YOUR_PUBLIC_KEY}' \
  -H 'X-Api-Timestamp: {UNIX_MS_TIMESTAMP}' \
  -H 'X-Api-Signature: {SIGNATURE}'

Headers

Header	Required	Description
Accept	yes	Recommended value: `application/json`.
X-Api-Public-Key	yes	Your public API key.
X-Api-Timestamp	yes	Timestamp (usually UNIX in ms), included in the signature.
X-Api-Signature	yes	Request signature (HMAC SHA256 according to API v2 scheme).

Request Parameters

Query Parameters

Parameter	Type	Required	Description
orderId	int	yes	Identifier of the order for which information is requested.

Response Format

The method returns a JSON object with full information about the order.

Example Response

{
  "orderId": 3038,
  "legacyOrderId": "4602ddf9-e516-4c3a-9146-7bc748edd89b",
  "pair": {>
    "instrumentFrom": {
      "currencyTitle": "BTC",
      "networkTitle": "BTC",
      "precisionDecimals": 7,
      "slug": "btc",
      "liquidityProviderCurrencies": [
        {
          "minConfirmationsToTrade": 3,
          "minConfirmationsToWithdraw": 3
        }
      ]
    },
    "instrumentTo": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20",
      "precisionDecimals": 5,
      "slug": "usdttrc20",
      "liquidityProviderCurrencies": [
        {
          "minConfirmationsToTrade": 3,
          "minConfirmationsToWithdraw": 3
        }
      ]
    }
  },
  "createdAt": "2025-04-28T13:15:03.006Z",
  "instrumentFromCurrencyTitle": "BTC",
  "instrumentFromNetworkTitle": "BTC",
  "instrumentToCurrencyTitle": "USDT",
  "instrumentToNetworkTitle": "TRC20",
  "feeMode": "FLOATING",
  "userId": 229,
  "userEmail": "qa@support.quickex.io",
  "isPlatformEmail": false,
  "refundAddress": null,
  "refundAddressMemo": null,
  "destinationAddress": "TFjfHBiDcL6B5S5W8g9b6gU2tbvnTR52ya",
  "destinationAddressMemo": null,
  "claimedNetworkFee": "1.5",
  "rateMode": "FLOATING",
  "claimedDepositAmount": "0.034268",
  "amountToGet": "3263.05",
  "platformFee": null,
  "redirectUrl": null,
  "orderEvents": [
    {
      "createdAt": "2025-04-28T13:15:03.021Z",
      "kind": "CREATION_END"
    }
  ],
  "depositAddress": {
    "instrument": {
      "currencyTitle": "BTC",
      "networkTitle": "BTC"
    },
    "depositAddress": "3LpR1ZKEVysoi6sxFqoGtB49638RsxzKSh",
    "depositAddressMemo": null
  },
  "deposits": [],
  "withdrawals": [],
  "KYCFormLink": null,
  "liquidityProviderPublicCode": "hat",
  "possibleRefferalAccrualAmount": "3.01",
  "possibleCashbackAmountUSDT": "0",
  "actualCashbackAmountUSDT": null,
  "claimedPublicRate": {
    "claimedAmountToReceive": "3259.38",
    "finalNetworkFeeAmount": "1.5",
    "price": "95158.1",
    "quotes": {
      "sellQuote": {
        "baseValue": "1",
        "quoteValue": "95114.32743505127"
      },
      "buyQuote": {
        "baseValue": "95158",
        "quoteValue": "0.9995400016924599"
      }
    },
    "updatedAt": "2025-04-28T13:11:30.251Z",
    "instrumentFrom": { ... },
    "instrumentTo": { ... }
  },
  "completed": false,
  "minConfirmationsToTrade": 3,
  "minConfirmationsToWithdraw": 3
}

Response Field Breakdown

Below are the key response fields. Some nested structures (e.g., instrumentFrom / instrumentTo) are similar to objects in the /instruments and /rates methods.

General Order Information

Field	Type	Description
orderId	number	Unique order identifier in the Quickex system.
legacyOrderId	string	Order identifier in the legacy system (if used for migration/compatibility).
createdAt	string	Order creation time (ISO8601).
instrumentFromCurrencyTitle	string	Source currency code (`BTC`).
instrumentFromNetworkTitle	string	Source network (`BTC`).
instrumentToCurrencyTitle	string	Target currency code (`USDT`).
instrumentToNetworkTitle	string	Target network (`TRC20`).
feeMode	string	Fee mode (e.g., `FLOATING`).
rateMode	string	Rate mode (`FLOATING`, `FIXED`).
claimedDepositAmount	string	Deposit amount used to create the order.
amountToGet	string	Amount the user should receive for this order.
claimedNetworkFee	string	Network fee applied in the order calculation.
platformFee	string	Platform fee
redirectUrl	string	Redirect URL to an external service .
completed	boolean	Order completion flag: `true` — exchange completed, `false` — in progress.
minConfirmationsToTrade	number	Minimum confirmations for deposit to be considered available for trade.
minConfirmationsToWithdraw	number	Minimum confirmations required for withdrawal.

Instrument Pair (pair)

{
  "pair": {
    "instrumentFrom": {
      "currencyTitle": "BTC",
      "networkTitle": "BTC",
      "precisionDecimals": 7,
      "slug": "btc",
      "liquidityProviderCurrencies": [
        {
          "minConfirmationsToTrade": 3,
          "minConfirmationsToWithdraw": 3
        }
      ]
    },
    "instrumentTo": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20",
      "precisionDecimals": 5,
      "slug": "usdttrc20",
      "liquidityProviderCurrencies": [
        {
          "minConfirmationsToTrade": 3,
          "minConfirmationsToWithdraw": 3
        }
      ]
    }
  },
  "user": {
    "userId": 229,
    "userEmail": "qa@support.quickex.io",
    "isPlatformEmail": false,
    "refundAddress": null,
    "refundAddressMemo": null,
    "destinationAddress": "TFjfHBiDcL6B5S5W8g9b6gU2tbvnTR52ya",
    "destinationAddressMemo": null
  },
  "depositAddressInfo": {
    "depositAddress": {
      "instrument": {
        "currencyTitle": "BTC",
        "networkTitle": "BTC"
      },
      "depositAddress": "3LpR1ZKEVysoi6sxFqoGtB49638RsxzKSh",
      "depositAddressMemo": null
    },
    "deposits": [],
    "withdrawals": []
  },
  "orderEvents": [
    {
      "createdAt": "2025-04-28T13:15:03.021Z",
      "kind": "CREATION_END"
    }
  ],
  "referralAndCashback": {
    "liquidityProviderPublicCode": "hat",
    "possibleRefferalAccrualAmount": "3.01",
    "possibleCashbackAmountUSDT": "0",
    "actualCashbackAmountUSDT": null
  },
  "claimedPublicRate": {
    "claimedAmountToReceive": "3259.38",
    "finalNetworkFeeAmount": "1.5",
    "price": "95158.1",
    "quotes": {
      "sellQuote": {
        "baseValue": "1",
        "quoteValue": "95114.32743505127"
      },
      "buyQuote": {
        "baseValue": "95158",
        "quoteValue": "0.9995400016924599"
      }
    },
    "updatedAt": "2025-04-28T13:11:30.251Z",
    "instrumentFrom": {
      "currencyTitle": "BTC",
      "networkTitle": "BTC",
      "precisionDecimals": 7,
      "slug": "btc"
    },
    "instrumentTo": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20",
      "precisionDecimals": 5,
      "slug": "usdttrc20"
    }
  }
}

Field	Type	Description
pair	object	Order instrument pair.
pair.instrumentFrom	object	Source instrument (what the user gives).
pair.instrumentTo	object	Target instrument (what the user receives).
currencyTitle	string	Currency code (`BTC`, `USDT`).
networkTitle	string	Network (`BTC`, `TRC20`).
precisionDecimals	number	Number of decimal places for operations with this instrument.
slug	string	Internal instrument slug in Quickex.
liquidityProviderCurrencies	array	Provider-specific settings for this instrument.
minConfirmationsToTrade	number	Confirmations needed for deposit to be counted as credited.
minConfirmationsToWithdraw	number	Confirmations needed for withdrawal.
Field	Type	Description
userId	number	User identifier in Quickex (if the order is linked to an account).
userEmail	string	User email provided when creating the order.
isPlatformEmail	boolean	Indicates if the email belongs to the platform (service/test email).
refundAddress	string	Refund address if the exchange is not completed.
refundAddressMemo	string	Memo/Tag for the refund address (if required by network).
destinationAddress	string	Address where the funds should be sent for this order.
destinationAddressMemo	string	Memo for the destination address.
Field	Type	Description
depositAddress	object	Deposit address details where the user should send funds.
depositAddress.instrument	object	Deposit instrument (currency/network).
depositAddress.depositAddress	string	Deposit address.
depositAddress.depositAddressMemo	string	Memo for deposit (if required by network).
deposits	array	List of actual deposits for the order (may be empty).
withdrawals	array	List of actual withdrawals to the user.
Field	Type	Description
orderEvents	array	Chronological list of events related to the order.
createdAt	string	Event timestamp.
kind	string	Event type (e.g., `CREATION_END`).
Field	Type	Description
liquidityProviderPublicCode	string	Liquidity provider code for the exchange (e.g., `hat`).
possibleRefferalAccrualAmount	string	Potential referral accrual for this order (in partner program currency).
possibleCashbackAmountUSDT	string	Potential cashback for the user in USDT.
actualCashbackAmountUSDT	string	Actually credited cashback (if already calculated).
Field	Type	Description
claimedPublicRate	object	Claimed rate and parameters used to create the order (snapshot of `/rates/public/one` response).
claimedAmountToReceive	string	Calculated amount the user should receive at this rate.
finalNetworkFeeAmount	string	Total network fee included in the calculation.
price	string	Exchange rate at the moment of order creation.
quotes	object	Quotes structure (sell/buy) for analysis and debugging.
quotes.sellQuote.baseValue	string	Base value in sell quote.
quotes.sellQuote.quoteValue	string	Corresponding value in quoted currency.
quotes.buyQuote.baseValue	string	Base value in buy quote.
quotes.buyQuote.quoteValue	string	Corresponding value in quoted currency.
updatedAt	string	Timestamp of the rate used for calculation.
instrumentFrom	object	Source instrument info for this rate (same structure as `pair.instrumentFrom`).
instrumentTo	object	Target instrument info for this rate (same structure as `pair.instrumentTo`).

Possible Use Cases

Retrieve the full card/details of a specific order in a user dashboard or admin panel.

Code Sample

Response Example

{
  "orderId": 3038,
  "legacyOrderId": "4602ddf9-e516-4c3a-9146-7bc748edd89b",
  "pair": {
    "instrumentFrom": {
      "currencyTitle": "BTC",
      "networkTitle": "BTC",
      "precisionDecimals": 7,
      "slug": "btc",
      "liquidityProviderCurrencies": [
        {
          "minConfirmationsToTrade": 3,
          "minConfirmationsToWithdraw": 3
        }
      ]
    },
    "instrumentTo": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20",
      "precisionDecimals": 5,
      "slug": "usdttrc20",
      "liquidityProviderCurrencies": [
        {
          "minConfirmationsToTrade": 3,
          "minConfirmationsToWithdraw": 3
        }
      ]
    }
  },
  "createdAt": "2025-04-28T13:15:03.006Z",
  "instrumentFromCurrencyTitle": "BTC",
  "instrumentFromNetworkTitle": "BTC",
  "instrumentToCurrencyTitle": "USDT",
  "instrumentToNetworkTitle": "TRC20",
  "feeMode": "FLOATING",
  "userId": 229,
  "userEmail": "qa@support.quickex.io",
  "isPlatformEmail": false,
  "refundAddress": null,
  "refundAddressMemo": null,
  "destinationAddress": "TFjfHBiDcL6B5S5W8g9b6gU2tbvnTR52ya",
  "destinationAddressMemo": null,
  "claimedNetworkFee": "1.5",
  "rateMode": "FLOATING",
  "claimedDepositAmount": "0.034268",
  "amountToGet": "3263.05",
  "platformFee": null,
  "redirectUrl": null,
  "orderEvents": [
    {
      "createdAt": "2025-04-28T13:15:03.021Z",
      "kind": "CREATION_END"
    }
  ],
  "depositAddress": {
    "instrument": {
      "currencyTitle": "BTC",
      "networkTitle": "BTC"
    },
    "depositAddress": "3LpR1ZKEVysoi6sxFqoGtB49638RsxzKSh",
    "depositAddressMemo": null
  },
  "deposits": [],
  "withdrawals": [],
  "KYCFormLink": null,
  "liquidityProviderPublicCode": "hat",
  "possibleRefferalAccrualAmount": "3.01",
  "possibleCashbackAmountUSDT": "0",
  "actualCashbackAmountUSDT": null,
  "claimedPublicRate": {
    "claimedAmountToReceive": "3259.38",
    "finalNetworkFeeAmount": "1.5",
    "price": "95158.1",
    "quotes": {
      "sellQuote": {
        "baseValue": "1",
        "quoteValue": "95114.32743505127"
      },
      "buyQuote": {
        "baseValue": "95158",
        "quoteValue": "0.9995400016924599"
      }
    },
    "updatedAt": "2025-04-28T13:11:30.251Z",
    "instrumentFrom": {
      "currencyTitle": "BTC",
      "networkTitle": "BTC",
      "precisionDecimals": 7,
      "slug": "btc",
      "liquidityProviderCurrencies": [
        {
          "minConfirmationsToTrade": 3,
          "minConfirmationsToWithdraw": 3
        }
      ]
    },
    "instrumentTo": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20",
      "precisionDecimals": 5,
      "slug": "usdttrc20",
      "liquidityProviderCurrencies": [
        {
          "minConfirmationsToTrade": 3,
          "minConfirmationsToWithdraw": 3
        }
      ]
    }
  },
  "completed": false,
  "minConfirmationsToTrade": 3,
  "minConfirmationsToWithdraw": 3
}

Try it out

Share this article:

Orders API V2

Documentation

General Description

HTTP Request

Request Example

Headers

Request Parameters

Query Parameters

Response Format

Response Example

Response Field Breakdown

Possible Use Cases

Code Sample

Response Example

Try it out

Query Parameters

Headers

Documentation

General Description

HTTP Request

Headers

Signature formula:

Request Example (the request was made using only mandatory parameters)

Request Example

Request Parameters

Required Parameters

Response Format

Full Response Example

Response Field Breakdown

Deposits (deposits)

Withdrawals (withdrawals)

Deposit Address (depositAddress)

General Order Information

claimedPublicRate Block

Possible Use Cases

Code Sample

Response Example

Try it out

Request Body

Headers

Documentation

Overview

HTTP Request

Request Example

Headers

Request Parameters

Body Parameters

Response Format

Response Example

Errors

403 ERR_FORBIDDEN — Email Already Set

Possible Use Cases

Code Sample

Response Example

Try it out

Request Body

Headers

Documentation

General Description

HTTP Request

Example Request

Headers

Request Parameters

Query Parameters

Response Format

Example Response

Response Field Breakdown

General Order Information

Instrument Pair (pair)

Possible Use Cases

Code Sample

Response Example

Try it out

Query Parameters

Headers