Skip to content

User

Quick Guide

Restful API

Public Interface

User Interface

Order Interface

WebSocket API

WebSocket Guide

Public Interface

User Interface

Order Interface


1. Checking account balance

Signature

HTTP Request

GET: /api/spot/v1/user/account

Request Parameters

Parameter Type Mandatory Notes
None

Return

Parameter Type Mandatory Notes
code number Y Errod Code
msg string Y Description
data object[] N Account Information

data

Parameter Type Mandatory Notes
coin string Y Token
balance number Y Balance
balanceLocked number Y In Use

2. Submit withdrawal request

Signature

HTTP Request

POST: /api/spot/v1/withdraw

API Description

  • You can only withdraw to address or accounts that have added under quick-withdrawal. You can set up the quick-withdrawal address on the webesite or application.A
  • Tag or MEMO: Some tokens like XRP will require a Tag or MEMO, or payment_id. This is the only string that matching your deposit address. Please make sure you have enter the correct information, otherwise your assets may be lost.
  • Only the apikey that has enabled withdrawal permission can be used to withdraw. Otherwise it will be rejected.

Request Parameters(Rules: 10 times/1 second(IP)

Parameter Type Mandatory Notes
coin string Y Token
You can get this in QueryTokenData Interface
network string Y Network
address string Y Withdrawal address
amount decimal Y Withdrawal amount
Withdrawal Amount(Withdrawal amount - fee = Actual amount)
Decimals can be found in QueryTokenData interface.
memo string N Tag or memo
{
    "coin": "TRX",
    "network": "Tron (TRC-20)",
    "address": "TJmW5D1p1LnMdTMmxuY1VELHht7v5HV7rU",
    "amount": 20.00
}

Return

Parameter Type Mandatory Notes
code number Y Error code
msg string Y Description
data object N Withdrawal Order ID

data

Parameter Type Mandatory Notes
withdrawId string Y WIthdrawal Order ID
{
    "code": "0",
    "msg": "result.success",
    "data": "1909879608889339906",
    "success": true
}

3. Cancel Withdrawal

Signature

HTTP Request

POST: /api/spot/v1/withdraw/cancel

API Description

  • When it's under manual review and on the intial reviewing stage, it can be canceled Once it's approved or it's on the network, it can't be canceled.

Request Parameters(Rules: 10 times/1 second(IP)

Parameter Type Mandatory Notes
withdrawId string Y Withdrawal Order ID
{
    "withdrawId": "1909879608889339906"
}

Return

Parameter Type Mandatory Notes
code number Y Error Code
msg string Y Description
data object N Null
{
    "code": "0",
    "msg": "result.success",
    "data": null,
    "success": true
}

4. Initiate Internal Transfer

Signature

HTTP Request

POST: /api/spot/v1/inside_transfer

API Description

  • Only the apikey that has enabled withdrawal permission can be used to withdraw. Otherwise it will be rejected.

Request Parameters(Rules: 10 times/1 second(IP)

Parameter Type Mandatory Notes
coin string Y Token
You can get this in QueryTokenData interface
amount decimal Y Transfer amount
Decimals can be found in QueryTokenData interface
toType string Y Method
uid via UID
phonevia mobile number
emailvia email
toUid int64 N UID
toPhoneCountryCode string N Area code
toPhoneNumber string N Mobile number
toEmail string N Email address
{
    "coin": "USDT",
    "amount": 10,
    "toType": "uid",
    "toUid": 681979174
}

Return

Parameter Type Mandatory Notes
code number Y Error code
msg string Y Description
data string Y Internal Transfer Order ID

data

Parameter Type Mandatory Notes
insideTransferId string Y Order ID
 {
    "code": "0",
    "msg": "result.success",
    "data": "1909921053381820417",
    "success": true
}

5. Cancel Internal Transfer

Signature

HTTP Request

POST: /api/spot/v1/inside_transfer/cancel

API Description

  • When it's under manual review and on the intial reviewing stage, it can be canceled Once it's approved, it can't be canceled.

Request Parameters(Rules: 10 times/1 second(IP)

Parameter Type Mandatory Notes
insideTransferId string Y Internal Transfer Order ID
It can be acquired by using RequestInternalTransfer interface
{
    "insideTransferId": "1909921053381820417"
}

Return

Parameter Type Mandatory Notes
code number Y Error code
msg string Y description
data object N Order ID

data

Parameter Type Mandatory Notes
insideTransferId string Y Order ID
 {
    "code": "0",
    "msg": "result.success",
    "data": null,
    "success": true
}

6. Request Withdrawal History(Withdrawal and Internal Transfer Included)

Signature

HTTP Request

POST: /api/spot/v1/withdraw_transfer/page

Request Parameters(Rules: 10 times/1 second(IP)

Parameter Type Mandatory Notes
id string N Withdrawal Order ID / Internal Transfer Order ID
coin string N Token
You can get this in QueryTokenData interface
transactionHash string N TxID
Valid only with the type iswithdraw
type string N Withdrawal Type
withdraw Withdrawal
inside_transfer Internal Transfer
startTime int64 N Starting time of the request,Unix timestamp, 如:1597026383085
endTime int64 N Ending time of the request,Unix timestamp, 如:1597026683085
limit int32 N Number of the results. Default:100. Maximum: 100. It will return 100 by default if it's not entered.
{
    "id": "1909877667383767042",
    "limit": 10
}

Return

Parameter Type Mandatory Notes
code number Y Error Code
msg string Y Description
data object N Withdrawal / Internal Transfer Records

data

Parameter Type Mandatory Notes
id string Y Withdrawal Order ID / Internal Transfer Order ID
coin string Y Token Name
network string Y Network
amount decimal Y Actual Receiving Amount
feeCoin string Y Fee Token
fee decimal Y Fee
type string Y Type
withdraw: On-chain withdrawal
inside_transfer_out: Internal Transfer
toAddress string N Address(It will only be returned when type=withdraw
transactionHash string N TxID (It will only be returned when type=withdraw
toType string N Method
uid:Via ID
phone:Via Mobile Number
email:Via Email
toUid int64 N Receiving UID(It will only be returned when toType=uid
toPhoneCountryCode string N Area Code(It will only be returned when toType=phone
toPhoneNumber string N Mobile(It will only be returned when toType=phone
toEmail string N Email(It will only be returned whentoType=email
status string Y Status
pending:Pending
cancelled:Cancelled
success:Completed
fail:Failed
ctime int64 Y Time of the request creation,Unix timestamp. For example:1597026383085
{
    "code": "0",
    "msg": "result.success",
    "data": [
        {
            "id": "1909877667383767042",
            "type": "withdraw",
            "coin": "TRX",
            "amount": "19.00000000000000000000",
            "status": "pending",
            "ctime": 1744185294000,
            "network": "Tron (TRC-20)",
            "address": "TJmW5D1p1LnMdTMmxuY1VELHht7v5HV7rU",
            "transactionHash": null,
            "feeCoin": null,
            "fee": null,
            "memo": null,
            "toType": null,
            "toUid": null,
            "toPhoneCountryCode": null,
            "toPhoneNumber": null,
            "toEmail": null
        }
    ],
    "success": true
}

7. Transfer

Siganature

HTTP Request

POST: /api/spot/v1/funds_transfer

API Description

  • Transfer of different types of fudns within personal account. For example, transfering funds from spot account to futures account.

Request Parameters(Rules: 10 times/1 second(IP)

Parameter Type Mandatory Notes
type string Y Transfer Type
spot_futures From spot account to futures account
futures_spot From futures account to spot account
coin String Y Token
You can get this in QueryTokenData interface
amount decimal Y Transfer amount
Decimals can be found in QueryTokenData interface
{
    "type": "spot_futures",
    "coin": "USDT",
    "amount": 100.01
}

Return

Parameter Type Mandatory Notes
code number Y Error Code
msg string Y Description
data string Y Transfer Order ID

data

Parameter Type Mandatory Notes
transferId string Y Transfer Order ID
{
    "code": "0",
    "msg": "result.success",
    "data": "1909902180506972162",
    "success": true
}