Skip to main content

Get Deposit & Withrawal Address

API Description​

This interface allows users to obtain the deposit address for a specific crypto and its associated blockchain.

Note: Deposit & withdrawal address data only available via RESTful API.

Precautions​

None

Authentication​

This is a private interface and requires authentication. For details on using the RESTful API, refer to Common > Authentication & Code Snippet > Spot > RESTful Private Interface.

Request Method​

POST

Endpoint​

/api/v1/private?command=returnDepositAddresses

Frequency limit​

The frequency limit for this interface is 3 requests/s per user ID. In addition to this per-interface limit, a global rate limit is also enforced.

For detailed information on Global rate limits and API Rate Limiting Policy, please refer to the "Frequency Limit" section at click here

Request Parameters​

ParameterMandatoryTypeDescription
symbolIdTrueStringBase currency identifier, e.g., "50" represents "BTC".
The mapping relationship between base currency identifier and base currency can be obtained through the Get Coin Deposits Withdrawal Limits interface.
chainTrueStringBlockchain name

Response Parameters​

ParameterTypeDescription
minRechargeAmountStringMinimum deposit amount
chainNameStringBlockchain name
addressIntegerDeposit and withdrawal address

Request Example​

The following Python code shows how get deposit and withdrawal address of BTC.

Note: For a complete code example, please refer to Common > Authentication & Code Snippet > Spot > RESTful Private Interface.

api_url = "/api/v1/private?command=returnDepositAddresses"
method = "post"
params = {
"symbolId": "50",
"chain" : "BTC"
}
SpotRestfulPrivate(host, api_url, method, api_key, params, secret_key) # function SpotRestfulPrivate() is defined in section (Common > Authentication & Code Snippet > Spot > RESTful Private Interface)

Note: For a complete Java code example, please refer to Common > Authentication & Code Snippet > Spot > RESTful Private Interface.

Response Example​

The following is an example response returned by the above Python request:

{'code': '200',
'data': [{'chainName': 'BTC',
'address': '1HCtJq9kWbBG1W24CLQ7SAiDivy6E7xHFj',
'memo': None,
'minRechargeAmount': '0.00001'}],
'msg': 'SUCCESS',
'success': True,
'failed': False}