Module: Binance::Client::REST::WithdrawAPI

Included in:
Binance::Client::REST
Defined in:
lib/binance/client/rest/withdraw_api.rb

Overview

Public: A Module containing all of the Withdraw API endpoints

Instance Method Summary collapse

Instance Method Details

#account_status(options) ⇒ Object

Public: Retrieve current account status

options - The Hash which hosts various REST query params.

:recvWindow - The Number of how long a request is valid for in
              milliseconds (optional).

Returns a Hash with the request response



77
78
79
 
# File 'lib/binance/client/rest/withdraw_api.rb', line 77

def (options)
  request :withdraw, :get, :accountStatus, options
end

#deposit_address(options) ⇒ Object

Public: Retrieve the deposit address for a specific asset

options - The Hash which hosts various REST query params.

:asset      - The String of which asset to retrieve (optional).
:recvWindow - The Number of how long a request is valid for in
              milliseconds (optional).

Returns a Hash with the request response



66
67
68
 
# File 'lib/binance/client/rest/withdraw_api.rb', line 66

def deposit_address(options)
  request :withdraw, :get, :depositAddress, options
end

#deposit_history(options = {}) ⇒ Object

Public: Retrieve the deposit history for the authenticated account

options - The Hash which hosts various REST query params.

:asset      - The String of which asset to retrieve (optional).
:status     - The Number of which status to retrieve (optional).
:startTime  - The Timestamp of when to start the history in
              milliseconds (optional).
:endTime    - The Timestamp of when to end the history in
              milliseconds (optional).
:recvWindow - The Number of how long a request is valid for in
              milliseconds (optional).

Returns a Hash with the request response



37
38
39
 
# File 'lib/binance/client/rest/withdraw_api.rb', line 37

def deposit_history(options = {})
  request :withdraw, :get, :depositHistory, options
end

#withdraw(options) ⇒ Object

Public: Withdraw the specified asset to the given address using the authenticated account

options - The Hash which hosts various REST query params.

:asset      - The String of which asset to withdraw.
:address    - The String of where to send the asset to.
:addressTag - The String secondary address identifier (optional).
:amount     - The String decimal value of how much to withdraw.
:name       - The String description of the address
:recvWindow - The Number of how long a request is valid for in
              milliseconds (optional).

Returns a Hash with the request response



20
21
22
 
# File 'lib/binance/client/rest/withdraw_api.rb', line 20

def withdraw(options)
  request :withdraw, :post, :withdraw, options
end

#withdraw_history(options = {}) ⇒ Object

Public: Retrieve the withdraw history for the authenticated account

options - The Hash which hosts various REST query params.

:asset      - The String of which asset to retrieve (optional).
:status     - The Number of which status to retrieve (optional).
:startTime  - The Timestamp of when to start the history in
              milliseconds (optional).
:endTime    - The Timestamp of when to end the history in
              milliseconds (optional).
:recvWindow - The Number of how long a request is valid for in
              milliseconds (optional).

Returns a Hash with the request response



54
55
56
 
# File 'lib/binance/client/rest/withdraw_api.rb', line 54

def withdraw_history(options = {})
  request :withdraw, :get, :withdrawHistory, options
end