Module: Wallet

API wallet endpoints

Source: restful/wallet.js, line 5

Methods

accountSnapshot(type, optionsopt)

Daily Account Snapshot (USER_DATA)

GET /sapi/v1/accountSnapshot

https://binance-docs.github.io/apidocs/spot/en/#daily-account-snapshot-user_data

Parameters:

Name Type Attributes Description

type

string

"SPOT", "MARGIN", "FUTURES"

options

object

Properties

Name	Type	Attributes	Description
`startTime`	number	<optional>
`endTime`	number	<optional>
`limit`	number	<optional>	min 5, max 30, default 5
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/wallet.js, line 57

accountStatus(optionsopt)

Account Status (USER_DATA)

GET /sapi/v1/account/status

Fetch account status detail.
https://binance-docs.github.io/apidocs/spot/en/#account-status-sapi-user_data

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/wallet.js, line 224

apiPermissions(optionsopt)

API Key Permission (USER_DATA)

GET /sapi/v1/account/apiRestrictions

https://binance-docs.github.io/apidocs/spot/en/#get-api-key-permission-user_data

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/wallet.js, line 448

assetDetail(optionsopt)

Asset Detail (USER_DATA)

GET /sapi/v1/asset/assetDetail

Fetch details of assets supported on Binance.
Please get network and other deposit or withdraw details from GET /sapi/v1/capital/config/getall.
https://binance-docs.github.io/apidocs/spot/en/#asset-detail-sapi-user_data

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`asset`	string	<optional>
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/wallet.js, line 333

assetDevidendRecord(optionsopt)

Asset Dividend Record (USER_DATA)

GET /sapi/v1/asset/assetDividend

Query asset dividend record.
https://binance-docs.github.io/apidocs/spot/en/#asset-dividend-record-user_data

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`asset`	string	<optional>
`startTime`	number	<optional>
`endTime`	number	<optional>
`limit`	number	<optional>	Default 20, max 500
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/wallet.js, line 312

bnbConvertibleAssets(optionsopt)

Get Assets That Can Be Converted Into BNB (USER_DATA)

POST /sapi/v1/asset/dust-btc

https://binance-docs.github.io/apidocs/spot/en/#dustlog-user_data

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/wallet.js, line 485

coinInfo(optionsopt)

All Coins' Information (USER_DATA)

GET /sapi/v1/capital/config/getall

Get information of coins (available for deposit and withdraw) for user.

https://binance-docs.github.io/apidocs/spot/en/#all-coins-39-information-user_data

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/wallet.js, line 35

depositAddress(coin, optionsopt)

Deposit Address (supporting network) (USER_DATA)

GET /sapi/v1/capital/deposit/address

https://binance-docs.github.io/apidocs/spot/en/#deposit-address-supporting-network-user_data

Parameters:

Name Type Attributes Description

coin string

options

object

Properties

Name	Type	Attributes	Description
`network`	string	<optional>
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/wallet.js, line 200

depositHistory(optionsopt)

Deposit History(supporting network) (USER_DATA)

GET /sapi/v1/capital/deposit/hisrec

https://binance-docs.github.io/apidocs/spot/en/#deposit-history-supporting-network-user_data

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`coin`	string	<optional>
`status`	number	<optional>	0:pending, 6:credited but cannot withdraw, 1:success
`startTime`	number	<optional>	Default: 90 days from current timestamp
`endTime`	number	<optional>	Default: present timestamp
`offest`	number	<optional>
`limit`	number	<optional>
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/wallet.js, line 155

disableFastWithdraw(optionsopt)

Disable Fast Withdraw Switch (USER_DATA)

GET /sapi/v1/account/disableFastWithdrawSwitch

https://binance-docs.github.io/apidocs/spot/en/#disable-fast-withdraw-switch-user_data

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/wallet.js, line 79

dustLog(optionsopt)

DustLog (USER_DATA)

GET /sapi/v1/asset/dribblet

https://binance-docs.github.io/apidocs/spot/en/#dustlog-sapi-user_data

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`startTime`	number	<optional>
`endTime`	number	<optional>
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/wallet.js, line 263

dustTransfer(asset, optionsopt)

Dust Transfer (USER_DATA)

POST /sapi/v1/asset/dust

Convert dust assets to BNB.
https://binance-docs.github.io/apidocs/spot/en/#dust-transfer-user_data

Parameters:

Name Type Attributes Description

asset

array

The asset being converted

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/wallet.js, line 283

enableFastWithdraw(optionsopt)

Enable Fast Withdraw Switch (USER_DATA)

GET /sapi/v1/account/enableFastWithdrawSwitch

https://binance-docs.github.io/apidocs/spot/en/#enable-fast-withdraw-switch-user_data

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/wallet.js, line 97

fundingWallet(optionsopt)

Funding Wallet (USER_DATA)

POST /sapi/v1/asset/get-funding-asset

https://binance-docs.github.io/apidocs/spot/en/#funding-wallet-user_data

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`asset`	string	<optional>
`needBtcValuation`	string	<optional>	true or false
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/wallet.js, line 430

systemStatus()

System Status (System)

GET /sapi/v1/system/status

https://binance-docs.github.io/apidocs/spot/en/#system-status-sapi-system

Source: restful/wallet.js, line 18

tradeFee(optionsopt)

Trade Fee (USER_DATA)

GET /sapi/v1/asset/tradeFee

Fetch trade fee
https://binance-docs.github.io/apidocs/spot/en/#trade-fee-sapi-user_data

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`symbol`	string	<optional>
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/wallet.js, line 354

tradingStatus(optionsopt)

Account API Trading Status (USER_DATA)

GET /sapi/v1/account/apiTradingStatus

Fetch account api trading status detail.
https://binance-docs.github.io/apidocs/spot/en/#account-api-trading-status-sapi-user_data

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/wallet.js, line 243

userAsset(optionsopt)

Get user assets, just for positive data. (USER_DATA)

POST /sapi/v3/asset/getUserAsset

https://binance-docs.github.io/apidocs/spot/en/#user-asset-user_data

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`asset`	string	<optional>	If asset is blank, then query all positive assets user have.
`needBtcValuation`	boolean	<optional>	Whether need btc valuation or not.

Source: restful/wallet.js, line 467

userUniversalTransfer(type, asset, amount, optionsopt)

User Universal Transfer (USER_DATA)

POST /sapi/v1/asset/transfer

https://binance-docs.github.io/apidocs/spot/en/#user-universal-transfer

Parameters:

Name Type Attributes Description

type string

asset string

amount number

options

object

Properties

Name	Type	Attributes	Description
`fromSymbol`	string	<optional>	must be sent when type are ISOLATEDMARGIN_MARGIN and ISOLATEDMARGIN_ISOLATEDMARGIN
`toSymbol`	string	<optional>	must be sent when type are MARGIN_ISOLATEDMARGIN and ISOLATEDMARGIN_ISOLATEDMARGIN
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/wallet.js, line 377

userUniversalTransferHistory(type, optionsopt)

Query User Universal Transfer History (USER_DATA)

GET /sapi/v1/asset/transfer

https://binance-docs.github.io/apidocs/spot/en/#query-user-universal-transfer-history

Parameters:

Name Type Attributes Description

type string

options

object

Properties

Name	Type	Attributes	Description
`startTime`	number	<optional>
`endTime`	number	<optional>
`current`	number	<optional>
`size`	number	<optional>
`fromSymbol`	string	<optional>	must be sent when type are ISOLATEDMARGIN_MARGIN and ISOLATEDMARGIN_ISOLATEDMARGIN
`toSymbol`	string	<optional>	must be sent when type are MARGIN_ISOLATEDMARGIN and ISOLATEDMARGIN_ISOLATEDMARGIN
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/wallet.js, line 408

withdraw(coin, address, amount, optionsopt)

Withdraw (USER_DATA)

POST /sapi/v1/capital/withdraw/apply

https://binance-docs.github.io/apidocs/spot/en/#withdraw-user_data

Parameters:

Name Type Attributes Description

coin string

address string

amount number

options

object

Properties

Name	Type	Attributes	Description
`withdrawOrderId`	string	<optional>	client id for withdraw
`network`	string	<optional>
`addressTag`	string	<optional>	Secondary address identifier for coins like XRP,XMR etc.
`transactionFeeFlag`	boolean	<optional>	When making internal transfer, true for returning the fee to the destination account; false for returning the fee back to the departure account. Default false.
`name`	string	<optional>	Description of the address. Space in name should be encoded into %20.
`walletType`	number	<optional>	The wallet type for withdraw，0-spot wallet, 1-funding wallet. Default is spot wallet
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/wallet.js, line 125

withdrawHistory(optionsopt)

Withdraw History(supporting network) (USER_DATA)

GET /sapi/v1/capital/withdraw/history

https://binance-docs.github.io/apidocs/spot/en/#withdraw-history-supporting-network-user_data

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`coin`	string	<optional>
`withdrawOrderId`	string	<optional>
`status`	number	<optional>	0:Email Sent 1:Cancelled 2:Awaiting Approval 3:Rejected 4:Processing 5:Failure 6:Completed
`startTime`	number	<optional>	Default: 90 days from current timestamp
`endTime`	number	<optional>	Default: present timestamp
`offest`	number	<optional>
`limit`	number	<optional>
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/wallet.js, line 180