Class: BittrexEnterprise::SubAccounts

Inherits:
Object
  • Object
show all
Includes:
ApiHelpers
Defined in:
lib/bittrex-enterprise/sub_accounts.rb

Class Method Summary collapse

Methods included from ApiHelpers

included

Class Method Details

.create ⇒ Object

—————————————— CREATE —————————————— Create a new subaccount. (NOTE: This API is limited to partners and not available for traders.)

—— PARAMS —— no params required. Passes an empty hash



37
38
39
 
# File 'lib/bittrex-enterprise/sub_accounts.rb', line 37

def self.create()
  post_signed 'subaccounts', {}
end

.list(params = {}) ⇒ Object

—————————————— LIST ——————————————– List subaccounts. (NOTE: This API is limited to partners and not available for traders.) Pagination and the sort order of the results are in inverse order of the CreatedAt field.

—— PARAMS —— PARAMS MUST BE PASSED AS KEY VALUE PAIRS nextPageToken - string - The unique identifier of the item that the resulting query result

should start after, in the sort order of the given endpoint. Used for traversing
a paginated set in the forward direction. (May only be specified if PreviousPageToken
is not specified.)

previousPageToken - string - The unique identifier of the item that the resulting query

result should end before, in the sort order of the given endpoint. Used for traversing
a paginated set in the reverse direction. (May only be specified if NextPageToken is
not specified.)

pageSize - integer - maximum number of items to retrieve – default 100, minimum 1, maximum 200



26
27
28
 
# File 'lib/bittrex-enterprise/sub_accounts.rb', line 26

def self.list(params={})
  get_signed 'subaccounts', params
end

.retrieve(sub_account_id) ⇒ Object

————————————— RETRIEVE ——————————————- Retrieve details for a specified subaccount. (NOTE: This API is limited to partners and not available for traders.)

—— PARAMS —— sub_account_id - string - required - (guid-formatted string) - ID of the subaccount to

retrieve details for



50
51
52
 
# File 'lib/bittrex-enterprise/sub_accounts.rb', line 50

def self.retrieve()
  get_signed 'subaccounts/{subaccountId}', subaccountId: 
end