Wallet Endpoints

Query the currency information

Request

Get /api/v3/capital/config/getall

Response

[
  {
    "coin": "EOS",
    "Name": "EOS",
    "networkList": [
      {
          "coin": "EOS",
          "depositDesc": null,
          "depositEnable": true,
          "minConfirm": 0,
          "Name": "EOS",
          "network": "EOS",
          "withdrawEnable": false,
          "withdrawFee": "0.000100000000000000",
          "withdrawIntegerMultiple": null,
          "withdrawMax": "10000.000000000000000000",
          "withdrawMin": "0.001000000000000000",
          "sameAddress": false,
          "contract": "TN3W4H6rK2ce4vX9YnFQHwKENnHjoxbm9",
          "withdrawTips": "Both a MEMO and an Address are required.",
          "depositTips": "Both a MEMO and an Address are required.",
          "netWork": "EOS"
      },
      {
          "coin": "BTC",
          "depositDesc": null,
          "depositEnable": true,
          "minConfirm": 0,
          "Name": "BTC-BSC",
          "network": "BEP20(BSC)",
          "withdrawEnable": true,
          "withdrawFee": "0.000010000000000000",
          "withdrawIntegerMultiple": null,
          "withdrawMax": "100.000000000000000000",
          "withdrawMin": "0.000100000000000000",
          "sameAddress": false,
          "contract": "0x7130d2a12b9bcbfae4f2634d864a1ee1ce3ead9c",
          "withdrawTips": null,
          "depositTips": null,
          "network": "BTC"
      }
    ]
  },
]

GET /api/v3/capital/config/getall

Permission: SPOT_WITHDRAW_READ

Weight(IP): 10

Query currency details and the smart contract address

Parameters:

None

Response:

Name	Description
depositEnable	depositEnable
withdrawEnable	withdrawEnable
withdrawFee	withdrawFee
withdrawMax	Max withdraw amount
withdrawMin	Min withdraw amount
contract	coin contract
withdrawTips	withdrawTips
depositTips	depositTips
network	withdraw network(previous params,offline soon)
netWork	withdraw network(new params,for new withdraw endpoint)

Withdraw(new)

Request

post /api/v3/capital/withdraw?coin=EOS&address=zzqqqqqqqqqq&amount=10&netWork=EOS&memo=MX10086&timestamp={{timestamp}}&signature={{signature}}

Response

{
    "id":"7213fea8e94b4a5593d507237e5a555b"
}

POST /api/v3/capital/withdraw

Permission: SPOT_WITHDRAW_WRITE

Weight(IP): 1

Parameters:

Name	Type	Mandatory	Description
coin	string	YES	coin
withdrawOrderId	string	NO	withdrawOrderId
netWork	string	NO	withdraw network
contractAddress	string	NO	coin contract address
address	string	YES	withdraw address
memo	string	NO	memo(If memo is required in the address, it must be passed in)
amount	string	YES	withdraw amount
remark	string	NO	remark
timestamp	string	YES	timestamp
signature	string	YES	signature

Can get netWork via endpoints Get /api/v3/capital/config/getall's response params networkList.

Response:

Name	Description
id	withdraw ID

Cancel withdraw

Request

delete /api/v3/capital/withdraw?id=ca7bd51895134fb5bd749f1cf875b8af&timestamp={{timestamp}}&signature={{signature}}

Response

{
    "id": "ca7bd51895134fb5bd749f1cf875b8af"
}

DELETE /api/v3/capital/withdraw

Permission: SPOT_WITHDRAW_W

Weight(IP): 1

Request

Name	Type	Mandatory	Description
id	string	Yes	withdraw id

Response

Name	Description
id	withdraw id

Deposit History(supporting network)

Request

get /api/v3/capital/deposit/hisrec?coin=EOS&timestamp={{timestamp}}&signature={{signature}}

Response

[
  {
        "amount": "50000",
        "coin": "EOS",
        "network": "EOS",
        "status": 5,
        "address": "0x20b7cf77db93d6ef1ab979c49142ec168427fdee",
        "txId": "01391d1c1397ef0a3cbb3c7f99a90846f7c8c2a8dddcdcf84f46b530dede203e1bc804",
        "insertTime": 1659513342000,
        "unlockConfirm": "10",
        "confirmTimes": "241",
        "memo": "xxyy1122"
  }
]

GET /api/v3/capital/deposit/hisrec

Permission: SPOT_WITHDRAW_READ

Weight(IP): 1

Parameters:

Name	Type	Mandatory	Description
coin	string	NO	coin
status	string	NO	status
startTime	string	NO	default: 7 days ago from current time
endTime	string	NO	default:current time
limit	string	NO	default:1000,max:1000
timestamp	string	YES	timestamp
signature	string	YES	signature

default return the records of the last 7 days.
Ensure that the default timestamp of 'startTime' and 'endTime' does not exceed 7 days.
can query 90 days data at most.

Response:

Name	Description
amount	deposit amount
coin	coin
network	deposit network
status	deposit status,1:SMALL,2:TIME_DELAY,3:LARGE_DELAY, 4:PENDING,5:SUCCESS,6:AUDITING,7:REJECTED 8:REFUND,9:PRE_SUCCESS,10:INVALID, 11:RESTRICTED,12:COMPLETED
address	deposit adress
addressTag	addressTag
txId	txId
insertTime	insertTime
unlockConfirm	unlockConfirm
confirmTimes	confirmTimes
memo	memo

Withdraw History (supporting network)

Request

get /api/v3/capital/withdraw/history?coin=USDT&timestamp={{timestamp}}&signature={{signature}}

Response

[
  {
        "id": "bb17a2d452684f00a523c015d512a341",
        "txId": null,
        "coin": "EOS",
        "network": "EOS",
        "address": "zzqqqqqqqqqq",
        "amount": "10",
        "transferType": 0,
        "status": 3,
        "transactionFee": "0",
        "confirmNo": null,
        "applyTime": 1665300874000,
        "remark": "",
        "memo": "MX10086",
        "transHash": "0x0ced593b8b5adc9f600334d0d7335456a7ed772ea5547beda7ffc4f33a065c",
        "updateTime": 1712134082000,
        "coinId": "128f589271cb495b03e71e6323eb7be",
        "vcoinId": "af42c6414b9a46c8869ce30fd51660f"
  }
]

GET /api/v3/capital/withdraw/history

Permission: SPOT_WITHDRAW_READ

Weight(IP): 1

Parameters:

Name	Type	Mandatory	Description
coin	string	NO	coin
status	string	NO	withdraw status
limit	string	NO	default:1000, max:1000
startTime	string	NO	default: 7 days ago from current time
endTime	string	NO	default:current time
timestamp	string	YES	timestamp
signature	string	YES	signature

default return the records of the last 7 days.
Ensure that the default timestamp of 'startTime' and 'endTime' does not exceed 7 days.
can query 90 days data at most.
Supported multiple network coins's withdraw history may not return the 'network' field.

Response:

Name	Description
address	withdraw address
amount	withdraw amount
applyTime	apply time
coin	coin
id	withdraw id
withdrawOrderId	withdrawOrderId
network	withdraw network
transferType	transferType, 0: outside transfer,1: inside transfer
status	withdraw status,1:APPLY,2:AUDITING,3:WAIT,4:PROCESSING,5:WAIT_PACKAGING, 6:WAIT_CONFIRM,7:SUCCESS,8:FAILED,9:CANCEL,10:MANUAL
transactionFee	transactionFee
confirmNo	confirmNo
txId	txId
remark	remark
memo	memo
transHash	transaction Hash
coinId	asset id
vcoinId	currency id

Generate deposit address (supporting network)

Request

post /api/v3/capital/deposit/address?coin=EOS&network=EOS&timestamp={{timestamp}}&signature={{signature}}

Response

[
  {
      "coin": "USDT",
      "network": "TRC20",
      "address": "TXobiKkdciupZrhdvZyTSSLjE8CmZAufS",
      "tag": null
  },
  {
     "coin": "EOS",
     "network": "EOS",
     "address": "zzqqqqqqqqqq",
     "memo": "MX10068"
  }
]

POST /api/v3/capital/deposit/address

Permission: SPOT_WITHDRAW_WRITE

Weight(IP): 1

Parameters:

Name	Type	Mandatory	Description
coin	string	YES	coin
network	string	YES	deposit network
timestamp	string	YES	timestamp
signature	string	YES	signature

Response:

Name	Description
address	deposit address
coin	coin
memo	memo
network	network

Deposit Address (supporting network)

Request

get /api/v3/capital/deposit/address?coin=USDT&timestamp={{timestamp}}&signature={{signature}}

Response

[
  {
      "coin": "USDT",
      "network": "TRC20",
      "address": "TXobiKkdciupZrhdvZyTSSLjE8CmZAufS",
      "memo": null
  },
  {
      "coin": "USDT",
      "network": "BEP20(BSC)",
      "address": "0xebe4804f7ecc22d5011c42e6ea1f2e6c891d89b",
      "memo": null
  },
  {
      "coin": "USDT",
      "network": "ERC20",
      "address": "0x3f4d1f43761b52fd594e5a77cd83cab6955e85b",
      "memo": null
  }
]

GET /api/v3/capital/deposit/address

Permission: SPOT_WITHDRAW_READ

Weight(IP): 10

Parameters:

Name	Type	Mandatory	Description
coin	string	YES	coin
network	string	NO	deposit network
timestamp	string	YES	timestamp
signature	string	YES	signature

Response:

Name	Description
address	deposit address
coin	coin
memo	memo
network	network

Withdraw Address (supporting network)

Request

get /api/v3/capital/withdraw/address?coin=USDT&timestamp={{timestamp}}&signature={{signature}}

Response

{
    "data": [
        {
            "coin": "USDT",
            "network": "TRC20",
            "address": "TArGWdTApuuZtiWMjupXqbZqQYsBTy126o",
            "addressTag": "test",
            "memo": null
        },
        {
            "coin": "USDT",
            "network": "BEP20(BSC)",
            "address": "0xa82898C70BeB5E1b1621fdA62fD17Ba27227BBC5",
            "addressTag": "usdt",
            "memo": null
        }
    ],
    "totalRecords": 2,
    "page": 1,
    "totalPageNum": 1
}

GET /api/v3/capital/withdraw/address

Permission: SPOT_WITHDRAW_R

Weight(IP): 10

Request

Name	Type	Mandatory	Description
coin	string	No	coin
page	number	No	page,default 1
limit	number	No	limit for per page
timestamp	string	Yes	timestamp
signature	string	Yes	signature

Response

Name	Description
coin	coin
network	network
address	address
addressTag	addressTag
memo	memo
totalRecords	totalRecords
totalPageNum	totalPageNum
page	page

User Universal Transfer

Request

post /api/v3/capital/transfer?fromAccountType=FUTURES&toAccountType=SPOT&asset=USDT&amount=1&timestamp={{timestamp}}&signature={{signature}}

Response

[
  {
    "tranId": "c45d800a47ba4cbc876a5cd29388319"
  }
]

POST /api/v3/capital/transfer

Permission: SPOT_TRANSFER_WRITE

Weight(IP): 1

Parameters:

Name	Type	Mandatory	Description
fromAccountType	string	YES	fromAccountType:"SPOT","FUTURES"
toAccountType	string	YES	toAccountType:"SPOT","FUTURES"
asset	string	YES	asset
amount	string	YES	amount
timestamp	string	YES	timestamp
signature	string	YES	signature

Response:

Name	Description
tranId	tranId

Query User Universal Transfer History

Request

get /api/v3/capital/transfer

Response

[
  {
    "rows":[
    {
      "tranId":"11945860693",
      "clientTranId":"test",
      "asset":"BTC",
      "amount":"0.1",
      "fromAccountType":"SPOT",
      "toAccountType":"FUTURE",
      "fromSymbol":"SPOT",
      "toSymbol":"FUTURE",
      "status":"SUCCESS",
      "timestamp":1544433325000
    },
    {
      "tranId":"11945860693",
      "clientTranId":"test",
      "asset":"BTC",
      "amount":"0.1",
      "fromAccountType":"SPOT",
      "toAccountType":"FUTURE",
      "fromSymbol":"SPOT",
      "toSymbol":"FUTURE",
      "status":"SUCCESS",
      "timestamp":1544433325000
    }],
    "total": 2,
  }
]

GET /api/v3/capital/transfer

Permission: SPOT_TRANSFER_READ

Weight(IP): 1

Parameters:

Name	Type	Mandatory	Description
fromAccountType	string	YES	fromAccountType:"SPOT","FUTURES"
toAccountType	string	YES	toAccountType:"SPOT","FUTURES"
startTime	string	NO	startTime
endTime	string	NO	endTime
page	string	NO	default:1
size	string	NO	default:10, max:100
timestamp	string	YES	timestamp
signature	string	YES	signature

Only can quary the data for the last six months
If 'startTime' and 'endTime' are not send, will return the last seven days' data by default

Response:

Name	Description
total	total
tranId	tranId
clientTranId	client ID
asset	coin
amount	amount
fromAccountType	fromAccountType
toAccountType	toAccountType
symbol	symbol
status	status
timestamp	timestamp

Query User Universal Transfer History （by tranId）

Request

get /api/v3/capital/transfer/tranId?tranId=cb28c88cd20c42819e4d5148d5fb5742&timestamp={{timestamp}}&signature={{signature}}

Response

{
    "tranId": "cb28c88cd20c42819e4d5148d5fb5742",
    "clientTranId": null,
    "asset": "USDT",
    "amount": "10",
    "fromAccountType": "SPOT",
    "toAccountType": "FUTURES",
    "symbol": null,
    "status": "SUCCESS",
    "timestamp": 1678603205000
}

GET /api/v3/capital/transfer/tranId

Permission: SPOT_TRANSFER_R

Weight(IP): 1

request

Name	Type	Mandatory	Description
tranId	string	YES	tranId
timestamp	string	YES	timestamp
signature	string	YES	signature

Only can quary the data for the last six months

response

Name	Description
tranId	tranId
clientTranId	client ID
asset	coin
amount	amount
fromAccountType	fromAccountType
toAccountType	toAccountType
symbol	symbol
status	status
timestamp	timestamp

Get Assets That Can Be Converted Into MX

Request

get {{api_url}}/api/v3/capital/convert/list?timestamp={{timestamp}}&signature={{signature}}

Response

[
    {
           "convertMx": "0.000009",
           "convertUsdt": "0.000009",
           "balance": "0.000441",
           "asset": "USDT",
           "code": "30021",
           "message": "xxxxxxx"
 },
{
           "convertMx": "0.000009",
           "convertUsdt": "0.000009",
           "balance": "0.000441",
           "asset": "BTC",
           "code": "30021",
           "message": "xxxxxxx"
 }
]

GET /api/v3/capital/convert/list

Permission: SPOT_ACCOUNT_READ

Weight(IP): 1

Parameters:

Name	Type	Mandatory	Description
timestamp	string	YES	timestamp
signature	string	YES	signature

Response:

Name	Description
convertMx	MX amount（Deducted commission fee）
convertUsdt	usdt amount
balance	Convertible balance
asset	asset
code	code
message	message

Dust Transfer

Request

post {{api_url}}/api/v3/capital/convert?asset=BTC,FIL,ETH&timestamp={{timestamp}}&signature={{signature}}

Response

{
  "successList":["ALGO","OMG"],
  "failedList":[],
  "totalConvert":"0.07085578",
  "convertFee":"0.00071571"
  }

POST /api/v3/capital/convert

Permission: SPOT_ACCOUNT_W

Weight(IP): 10

Parameters:

Name	Type	Mandatory	Description
asset	string	YES	The asset being converted.(max 15 assert)eg:asset=BTC,FIL,ETH
timestamp	string	YES	timestamp
signature	string	YES	signature

Response:

Name	Description
totalConvert	Convert MX amount(Deducted commission fee)
convertFee	convertFee
successList	convert success List
failedList	convert failed List
-asset	asset
-message	message
-code	code

DustLog

Request

get {{api_url}}/api/v3/capital/convert?timestamp={{timestamp}}&signature={{signature}}

Response

{
    "data": [
        {
            "totalConvert": "0.00885018",
            "totalFee": "0.000177",
            "convertTime": 1665360563000,
            "convertDetails": [
                {
                    "id": "3e52a99c5c3447b2af2163cd829dca28",
                    "convert": "0.00885018",
                    "fee": "0.000177",
                    "amount": "0.007130464601986065",
                    "time": 1665360563000,
                    "asset": "ETHF"
                }
            ]
        },
        {
            "totalConvert": "0.026782",
            "totalFee": "0.00053562",
            "convertTime": 1663631477000,
            "convertDetails": [
                {
                    "id": "6483bfb1766d41d8a4b6b6315ded6e99",
                    "convert": "0.02098255",
                    "fee": "0.00041965",
                    "amount": "0.00000098",
                    "time": 1663631477000,
                    "asset": "BTC"
                },
                {
                    "id": "f9e886f28c454f5dae45eec6a11f6c6a",
                    "convert": "0.00084019",
                    "fee": "0.0000168",
                    "amount": "2",
                    "time": 1663631477000,
                    "asset": "JAM"
                }
            ]
        }
    ],  
    "totalRecords": 4,
    "page": 1,
    "totalPageNum": 1
}

GET /api/v3/capital/convert

Permission: SPOT_DEAL_READ

Weight(IP): 1

Parameters:

Name	Type	Mandatory	Description
startTime	long	NO	startTime
endTime	long	NO	endTime
page	int	NO	page,default 1
limit	int	NO	limit,default 1; max 1000
timestamp	string	YES	timestamp
signature	string	YES	signature

Response:

Name	Type	Description
totalConvert	string	Convert MX amount(Deducted commission fee)
totalFee	string	Total fee amount
convertTime	long	Convert time
convertDetails	object	Convert details
id	string	Convert id
convert	string	Convert mx
fee	string	fee amount
amount	string	amount
time	long	Convert time
asset	string	asset
page	int	page
totalRecords	int	totalRecords
totalPage	int	totalPage

Internal Transfer

Request

post /api/v3/capital/transfer/internal?&timestamp={{timestamp}}&signature={{signature}}

Response

  {
    "tranId": "c45d800a47ba4cbc876a5cd29388319"
  }

POST /api/v3/capital/transfer/internal

Permission: SPOT_WITHDRAW_WRITE

Weight(IP): 1

Parameters

Name	Type	Mandatory	Description
toAccountType	string	Yes	toAccountTyp:EMAIL/UID/MOBILE
toAccount	string	Yes	toAccount:EMAIL/UID/MOBILE
areaCode	string	No	areaCode of mobile
asset	string	Yes	asset
amount	string	Yes	amount
timestamp	string	Yes	timestamp
signature	string	Yes	signature

Response

Name	Description
tranId	tranId

Query Internal Transfer history

Request

get /api/v3/capital/transfer/internal?&timestamp={{timestamp}}&signature={{signature}}

Response

  {
    "page": 1,  
    "totalRecords": 1,  
    "totalPageNum": 1,  
    "data": [
             {
      "tranId":"11945860693",
      "asset":"BTC",
      "amount":"0.1",
      "toAccountType":"EMAIL",
      "toAccount":"156283619@outlook.com",
      "fromAccount":"156283618@outlook.com",
      "status":"SUCCESS",
      "timestamp":1544433325000
    },
    {
      "tranId":"",
      "asset":"BTC",
      "amount":"0.8",
      "toAccountType":"UID",
      "fromAccount":"156283619@outlook.com",
      "toAccount":"87658765",
      "status":"SUCCESS",
      "timestamp":1544433325000
    }
    ]
}

GET /api/v3/capital/transfer/internal

Permission: SPOT_WITHDRAW_READ

Weight(IP): 1

Parameters

Name	Type	Mandatory	Description
startTime	long	No
endTime	long	No
page	int	No	default 1
limit	int	No	default 10
tranId	string	No	tranid
timestamp	string	Yes	timestamp
signature	string	Yes	signature

If startTime and endTime are not provided, will default to returning data from the last 7 days.

Response

Name	Description
page	page
totalRecords	totalRecords
totalPage	totalPage
tranId	tranId
asset	asset
amount	amount
fromAccountType	fromAccountType
toAccountType	toAccountType
status	status:"SUCCESS","FAILED","WAIT"
timestamp	timestamp

Withdraw(previous,offline soon)

Request

post /api/v3/capital/withdraw/apply?coin=EOS&address=zzqqqqqqqqqq&amount=10&network=EOS&memo=MX10086&timestamp={{timestamp}}&signature={{signature}}

Response

[
  {
    "id":"7213fea8e94b4a5593d507237e5a555b"
  }
]

POST /api/v3/capital/withdraw/apply

Permission: SPOT_WITHDRAW_WRITE

Weight(IP): 1

Parameters:

Name	Type	Mandatory	Description
coin	string	YES	coin
withdrawOrderId	string	NO	withdrawOrderId
network	string	NO	withdraw network
address	string	YES	withdraw address
memo	string	NO	memo(If memo is required in the address, it must be passed in)
amount	string	YES	withdraw amount
remark	string	NO	remark
timestamp	string	YES	timestamp
signature	string	YES	signature

Can get network via endpoints Get /api/v3/capital/config/getall's response params networkList.

Response:

Name	Description
id	withdraw ID

Query the currency information​

Withdraw(new)​

Cancel withdraw​

Deposit History(supporting network)​

Withdraw History (supporting network)​

Generate deposit address (supporting network)​

Deposit Address (supporting network)​

Withdraw Address (supporting network)​

User Universal Transfer​

Query User Universal Transfer History​

Query User Universal Transfer History （by tranId）​

Get Assets That Can Be Converted Into MX​

Dust Transfer​

DustLog​

Internal Transfer​

Query Internal Transfer history​

Withdraw(previous,offline soon)​

Query the currency information

Withdraw(new)

Cancel withdraw

Deposit History(supporting network)

Withdraw History (supporting network)

Generate deposit address (supporting network)

Deposit Address (supporting network)

Withdraw Address (supporting network)

User Universal Transfer

Query User Universal Transfer History

Query User Universal Transfer History （by tranId）

Get Assets That Can Be Converted Into MX

Dust Transfer

DustLog

Internal Transfer

Query Internal Transfer history

Withdraw(previous,offline soon)