Withdraw

Apply for Withdrawal

post

Submit a withdrawal request to the platform.

Weight: 100 (IP/UID)

Header parameters

X-CH-APIKEYstringRequired

Your API-key

X-CH-SIGNstringRequired

Request signature

X-CH-TSintegerRequired

Timestamp in milliseconds

Body

withdrawOrderIdstringRequired

Custom withdrawal ID (unique)

amountstringRequired

Withdrawal quantity

addressstringRequired

Withdrawal address

labelstringOptional

Optional secondary address label (e.g. for XRP, XMR)

symbolstringOptional

Currency symbol (must be precise for multi-chain coins)

Responses

200

Withdrawal request submitted successfully.

application/json

post

HTTPcURLJavaScriptPython

POST /sapi/v1/withdraw/apply HTTP/1.1
Host: openapi.coinlocally.com
X-CH-APIKEY: text
X-CH-SIGN: text
X-CH-TS: 1
Content-Type: application/json
Accept: */*
Content-Length: 90

{
  "withdrawOrderId": "text",
  "amount": "text",
  "address": "text",
  "label": "text",
  "symbol": "text"
}

200

Withdrawal request submitted successfully.

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

Withdrawal Record Query

post

Query withdrawal records based on filters.

Weight: 100 (IP/UID)

Header parameters

X-CH-APIKEYstringRequired

X-CH-SIGNstringRequired

X-CH-TSstringRequired

Body

symbolstringOptional

withdrawIdstringOptional

withdrawOrderIdstringOptional

startTimestringOptional

endTimestringOptional

pagestringOptional

Responses

200

Successfully retrieved withdrawal records.

application/json

post

HTTPcURLJavaScriptPython

POST /sapi/v1/withdraw/query HTTP/1.1
Host: openapi.coinlocally.com
X-CH-APIKEY: text
X-CH-SIGN: text
X-CH-TS: text
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "symbol": "text",
  "withdrawId": "text",
  "withdrawOrderId": "text",
  "startTime": "text",
  "endTime": "text",
  "page": "text"
}

200

Successfully retrieved withdrawal records.

{
  "code": "0",
  "msg": "success",
  "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
  }
}