BinanceWithdrawal: Withdrawal Management

Details

Provides methods for submitting withdrawals and querying withdrawal history on Binance. Inherits from BinanceBase.

Purpose and Scope

Withdrawal Submission: Initiate withdrawals to external addresses.
Withdrawal History: Retrieve paginated withdrawal records with status tracking.

Usage

All methods require authentication (valid API key and secret). The API key must have Withdrawal permission for add_withdrawal(). These are wallet (/sapi/) endpoints, not spot (/api/) endpoints.

Official Documentation

Binance Withdrawal Endpoints

Endpoints Covered

Method	Endpoint	HTTP
add_withdrawal	POST /sapi/v1/capital/withdraw/apply	POST
get_withdrawal_history	GET /sapi/v1/capital/withdraw/history	GET

Withdrawal Status Codes

0: Email Sent
1: Cancelled
2: Awaiting Approval
3: Rejected
4: Processing
5: Failure
6: Completed

Super class

binance::BinanceBase -> BinanceWithdrawal

Methods

Public methods

BinanceWithdrawal$add_withdrawal()
BinanceWithdrawal$get_withdrawal_history()
BinanceWithdrawal$clone()

Inherited methods

binance::BinanceBase$initialize()

Method `add_withdrawal()`

Submit Withdrawal

Initiates a withdrawal request. The API key must have Withdrawal permission enabled. Returns a withdrawal ID on success.

API Endpoint

POST https://api.binance.com/sapi/v1/capital/withdraw/apply

Official Documentation

Binance Withdraw Verified: 2026-03-10

Automated Trading Usage

Profit Extraction: Withdraw profits to a cold wallet at regular intervals.
Multi-Network Support: Specify network (e.g., "ETH", "TRX", "BSC") to select the cheapest or fastest network.
Wallet Selection: Use walletType to withdraw from spot (0) or funding (1) wallet.

curl

curl -X POST 'https://api.binance.com/sapi/v1/capital/withdraw/apply' \
  -H 'X-MBX-APIKEY: your-api-key' \
  -d 'coin=USDT&address=TKFRQXSDcY4kd3QLzw7uK16GmLrjJggwX8&amount=10&network=TRX&timestamp=...&signature=...'

JSON Request

{
  "coin": "USDT",
  "address": "TKFRQXSDcY4kd3QLzw7uK16GmLrjJggwX8",
  "amount": "10",
  "network": "TRX",
  "timestamp": 1661493146000,
  "signature": "..."
}

JSON Response

{ "id": "7213fea8e94b4a5593d507237e5a555b" }

Usage

BinanceWithdrawal$add_withdrawal(
  coin,
  address,
  amount,
  network = NULL,
  withdrawOrderId = NULL,
  addressTag = NULL,
  transactionFeeFlag = NULL,
  name = NULL,
  walletType = NULL,
  recvWindow = NULL
)

Arguments

coin: Character; coin symbol (e.g., "BTC", "USDT").
address: Character; destination wallet address.
amount: Numeric or character; withdrawal amount.
network: Character or NULL; blockchain network (e.g., "ETH", "TRX", "BSC"). If NULL, uses the coin's default network.
withdrawOrderId: Character or NULL; client-side withdrawal ID for tracking.
addressTag: Character or NULL; secondary address identifier (required for coins like XRP, XMR, XLM).
transactionFeeFlag: Logical or NULL; for internal transfers: TRUE returns fee to destination, FALSE to origin.
name: Character or NULL; description for the address (max 200 entries in address book).
walletType: Integer or NULL; 0 for spot wallet, 1 for funding wallet.
recvWindow: Integer or NULL; max 60000.

Returns

data.table (or promise<data.table> if async = TRUE) with columns:

id (character): Unique withdrawal identifier assigned by Binance.

Examples

\dontrun{
withdrawal <- BinanceWithdrawal$new()

# Withdraw USDT via TRC20
result <- withdrawal$add_withdrawal(
  coin = "USDT",
  address = "TKFRQXSDcY4kd3QLzw7uK16GmLrjJggwX8",
  amount = 10,
  network = "TRX"
)
print(result$id)
}

Method `get_withdrawal_history()`

Get Withdrawal History

Retrieves withdrawal transaction history with optional filtering by coin, status, and time range. Max time range is 90 days.

API Endpoint

GET https://api.binance.com/sapi/v1/capital/withdraw/history

Official Documentation

Binance Withdraw History Verified: 2026-03-10

Automated Trading Usage

Withdrawal Monitoring: Poll for status 6 (completed) to confirm funds have left the exchange.
Reconciliation: Match tx_id against on-chain transaction hashes for audit.
Failure Diagnosis: Check info field for error details on failed withdrawals.

curl

curl -X GET 'https://api.binance.com/sapi/v1/capital/withdraw/history?coin=USDT&status=6&timestamp=...&signature=...' \
  -H 'X-MBX-APIKEY: your-api-key'

JSON Response

[
  {
    "id": "b6ae22b3aa844210a7041aee7589627c",
    "amount": "8.91000000",
    "transactionFee": "0.004",
    "coin": "USDT",
    "status": 6,
    "address": "0x94df8b352de7f46f64b01d3666bf6e936e44ce60",
    "txId": "0xb5ef8c13b968a406cc62a93a8bd80f9e9a906ef1b3fcf20a2e48573c17659268",
    "applyTime": "2019-10-12 11:12:02",
    "network": "ETH",
    "transferType": 0,
    "withdrawOrderId": "WITHDRAWtest123",
    "info": "",
    "confirmNo": 3,
    "walletType": 1,
    "txKey": "",
    "completeTime": "2023-03-23 16:52:41"
  }
]

Usage

BinanceWithdrawal$get_withdrawal_history(
  coin = NULL,
  withdrawOrderId = NULL,
  status = NULL,
  startTime = NULL,
  endTime = NULL,
  offset = NULL,
  limit = NULL,
  recvWindow = NULL
)

Arguments

coin: Character or NULL; filter by coin (e.g., "BTC", "USDT").
withdrawOrderId: Character or NULL; filter by client-side withdrawal ID.
status: Integer or NULL; filter by status: 0 (email sent), 1 (cancelled), 2 (awaiting approval), 3 (rejected), 4 (processing), 5 (failure), 6 (completed).
startTime: Integer or NULL; start timestamp in milliseconds.
endTime: Integer or NULL; end timestamp in milliseconds.
offset: Integer or NULL; pagination offset (default 0).
limit: Integer or NULL; max results (default 1000, max 1000).
recvWindow: Integer or NULL; max 60000.

Returns

data.table (or promise<data.table> if async = TRUE) with columns:

id (character): Unique withdrawal identifier.
amount (character): Withdrawal amount.
transaction_fee (character): Fee charged for the withdrawal.
coin (character): Withdrawn coin symbol.
status (integer): Withdrawal status code (0-6).
address (character): Destination address.
tx_id (character): On-chain transaction hash.
apply_time (character): Time the withdrawal was submitted (UTC string).
network (character): Blockchain network used.
transfer_type (integer): 0=external, 1=internal.
withdraw_order_id (character): Client-side withdrawal ID.
info (character): Additional info or error message.
confirm_no (integer): Number of on-chain confirmations.
wallet_type (integer): 0=spot, 1=funding.
tx_key (character): Transaction key.
complete_time (character): Completion time (UTC string).

Examples

\dontrun{
withdrawal <- BinanceWithdrawal$new()

# Get all completed USDT withdrawals
history <- withdrawal$get_withdrawal_history(coin = "USDT", status = 6)
print(history[, .(amount, coin, status, address, apply_time)])

# Get withdrawals from the last 7 days
now_ms <- as.integer(as.numeric(Sys.time()) * 1000)
recent <- withdrawal$get_withdrawal_history(
  startTime = now_ms - 7 * 86400000L,
  endTime = now_ms
)
}

Method `clone()`

The objects of this class are cloneable with this method.

Usage

BinanceWithdrawal$clone(deep = FALSE)

Arguments

deep: Whether to make a deep clone.

Examples

if (FALSE) { # \dontrun{
# Synchronous
withdrawal <- BinanceWithdrawal$new()
history <- withdrawal$get_withdrawal_history(coin = "USDT")
print(history)

# Asynchronous
withdrawal_async <- BinanceWithdrawal$new(async = TRUE)
main <- coro::async(function() {
  history <- await(withdrawal_async$get_withdrawal_history(coin = "BTC"))
  print(history)
})
main()
while (!later::loop_empty()) later::run_now()
} # }


## ------------------------------------------------
## Method `BinanceWithdrawal$add_withdrawal`
## ------------------------------------------------

if (FALSE) { # \dontrun{
withdrawal <- BinanceWithdrawal$new()

# Withdraw USDT via TRC20
result <- withdrawal$add_withdrawal(
  coin = "USDT",
  address = "TKFRQXSDcY4kd3QLzw7uK16GmLrjJggwX8",
  amount = 10,
  network = "TRX"
)
print(result$id)
} # }

## ------------------------------------------------
## Method `BinanceWithdrawal$get_withdrawal_history`
## ------------------------------------------------

if (FALSE) { # \dontrun{
withdrawal <- BinanceWithdrawal$new()

# Get all completed USDT withdrawals
history <- withdrawal$get_withdrawal_history(coin = "USDT", status = 6)
print(history[, .(amount, coin, status, address, apply_time)])

# Get withdrawals from the last 7 days
now_ms <- as.integer(as.numeric(Sys.time()) * 1000)
recent <- withdrawal$get_withdrawal_history(
  startTime = now_ms - 7 * 86400000L,
  endTime = now_ms
)
} # }

BinanceWithdrawal: Withdrawal Management

Details

Purpose and Scope

Usage

Official Documentation

Endpoints Covered

Withdrawal Status Codes

Super class

Methods

Public methods

Method add_withdrawal()

API Endpoint

Official Documentation

Automated Trading Usage

curl

JSON Request

JSON Response

Usage

Arguments

Returns

Examples

Method get_withdrawal_history()

API Endpoint

Official Documentation

Automated Trading Usage

curl

JSON Response

Usage

Arguments

Returns

Examples

Method clone()

Usage

Arguments

Examples

Method `add_withdrawal()`

Method `get_withdrawal_history()`

Method `clone()`