Skip to main content

Get Withdrawal Address List

Query the withdrawal addresses in the address book.

tip
  • The API key for querying this endpoint must have withdrawal permissions.

HTTP Request

GET /v5/asset/withdraw/query-address

Request Parameters

ParameterRequiredTypeComments
coinfalsestringCoin:
  • When passing coin=baseCoin, it refers to the universal addresses.
  • When passing a coin name, it refers to the regular address on the chain.
chainfalsestringChain name:
  • When only passing the chain name, it returns both regular addresses and universal addresses.
  • When passing the chain name and coin=baseCoin, it only returns the universal address corresponding to the chain.
addressTypefalseintegerAddress type. 0: OnChain Address Type(Regular Address Type and Universal Address Type). 1: Internal Transfer Address Type(Invalid "coin" & "chain" Parameters) 2: On chain address and internal transfer address type (Invalid "coin" & "chain" Parameters)
limitfalseintegerLimit for data size per page. [1, 50]. Default: 50
cursorfalsestringCursor. Use the nextPageCursor token from the response to retrieve the next page of the result set

Response Parameters

ParameterTypeComments
rowsarrayObject
> coinstringCoin
> chainstringChain name
> addressstringAddress
> tagstringAddress tag
> remarkstringremark
> statusintegerAddress status:0: Normal. 1: New Addresses are prohibited from withdrawing coins for 24 Hours.
> addressTypeintegerAddress type. 0: OnChain Address Type(Regular Address Type And Universal Address Type) 1: Internal Transfer Address Type. 2: Internal Transfer Address Type And OnChain Address Type
> verifiedintegerWhether the address has been verified or not: 0: Unverified Address. 1: Verified Address.
> createAtstringAddress create time
nextPageCursorstringCursor. Used for pagination

Request Example

GET /v5/asset/withdraw/query-address HTTP/1.1
Host: api-testnet.bybit.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx
X-BAPI-TIMESTAMP: 1672194949557
X-BAPI-RECV-WINDOW: 5000

Response Example

{
"retCode": 0,
"retMsg": "success",
"result": {
"rows": [
{
"coin": "USDT",
"chain": "ETH",
"address": "0x48101adb67d426cb15e46be5f1d9f6ab25f311ea",
"tag": "",
"remark": "",
"status": 0,
"addressType": 0,
"verified": 0,
"createdAt": "1760951195"
},
{
"coin": "baseCoin",
"chain": "ETH",
"address": "0x48101adb67d426cb15e46be5f1d9f6ab25f311ea",
"tag": "",
"remark": "Universal Address",
"status": 0,
"addressType": 0,
"verified": 0,
"createdAt": "1760951332"
}
],
"nextPageCursor": "eyJtaW5JRCI6MTA1MDgsIm1heElEIjoxMDUwOX0="
},
"retExtInfo": {},
"time": 1760960379395
}