Withdraw

All endpoints in this section require ALL THREE authentication headers

Apply for Withdrawal

post

https://openapi.gaiaex.comhttps://futuresopenapi.gaiaex.com

/sapi/v1/withdraw/apply

Submit a withdrawal request for a specific asset

Header parameters

X-CH-SIGNstringRequired

Signature generated using your API Secret

X-CH-TSstringRequired

Current timestamp in milliseconds

X-CH-APIKEYstringRequired

API Key from your GaiaEx account

Body

application/json

withdrawOrderIdstringRequired

Custom withdrawal id, guaranteed to be unique

Example: withdraw-123456

amountstringRequired

Withdrawal quantity

Example: 1.5

addressstringRequired

Withdrawal address

Example: 0x1234abcd...

labelstringOptional

Some currencies such as XRP, XMR allow filling of secondary address labels

Example: 12345

symbolstringOptional

Currency name. For coins that support multiple mainchains, the actual currency name needs to be transmitted

Example: BTC

Responses

200

OK

application/json

post

/sapi/v1/withdraw/apply

cURLPythonJavaScriptJavaGo

curl -X POST 'https://openapi.gaiaex.com/sapi/v1/withdraw/apply' \
-H 'X-CH-APIKEY: YOUR_API_KEY' \
-H 'X-CH-TS: 1499827319559' \
-H 'X-CH-SIGN: YOUR_SIGNATURE' \
-H 'Content-Type: application/json' \
-d '{
  "withdrawOrderId": "withdraw-123456",
  "amount": "1.5",
  "address": "0x1234abcd...",
  "symbol": "BTC"
}'

200

OK

{
  "code": "0",
  "msg": "success",
  "data": {
    "id": 518353
  }
}

Query Withdrawal Records

post

https://openapi.gaiaex.comhttps://futuresopenapi.gaiaex.com

/sapi/v1/withdraw/query

Query withdrawal history with optional filters

Header parameters

X-CH-SIGNstringRequired

Signature generated using your API Secret

X-CH-TSstringRequired

Current timestamp in milliseconds

X-CH-APIKEYstringRequired

API Key from your GaiaEx account

Body

application/json

symbolstringOptional

Currency Name. For coins that support multiple mainchains, the actual currency name needs to be transmitted

Example: TUSDT

withdrawIdstringOptional

Platform withdrawal id

Example: 749864

withdrawOrderIdstringOptional

Custom withdrawal id

Example: abc123

startTimestringOptional

Start time, timestamp, default 90 days ago

Example: 1600000000000

endTimestringOptional

End time, timestamp, default current time

Example: 1670000000000

pagestringOptional

Page number, starting at 1

Example: 1

Responses

200

OK

application/json

post

/sapi/v1/withdraw/query

cURLPythonJavaScriptJavaGo

curl -X POST 'https://openapi.gaiaex.com/sapi/v1/withdraw/query' \
-H 'X-CH-APIKEY: YOUR_API_KEY' \
-H 'X-CH-TS: 1499827319559' \
-H 'X-CH-SIGN: YOUR_SIGNATURE' \
-H 'Content-Type: application/json' \
-d '{
  "symbol": "TUSDT",
  "startTime": "1600000000000",
  "endTime": "1670000000000",
  "page": "1"
}'

200

OK

{
  "code": "0",
  "msg": "成功",
  "data": {
    "withdrawList": [
      {
        "symbol": "TUSDT",
        "amount": 19.99999,
        "address": "TFFrjNfBAagmFWypE3Hnv6zPKAFhd3VcDf",
        "withdrawOrderId": "abc123",
        "fee": 0.00001,
        "ctime": 1605585397000,
        "txId": "749864_20201117115930",
        "id": 749864,
        "applyTime": 1666754820000,
        "status": 5,
        "info": ""
      },
      {
        "symbol": "TUSDT",
        "amount": 10.50999,
        "address": "TYsTiVVDU5VmnUPufzGD52CD1hSbPATT3Q",
        "withdrawOrderId": "abc456",
        "fee": 0.00001,
        "ctime": 1607089149000,
        "txId": "764294_20201204094130",
        "id": 764294,
        "applyTime": 1666754820000,
        "status": 5,
        "info": ""
      }
    ],
    "count": 2
  }
}