Class: BittrexEnterprise::Deposits
- Inherits:
-
Object
- Object
- BittrexEnterprise::Deposits
- Includes:
- ApiHelpers
- Defined in:
- lib/bittrex-enterprise/deposits.rb
Class Method Summary collapse
-
.by_tx_id(tx_id, sub_account_id = '') ⇒ Object
———————————- BY TRANSACTION ID ————————————— Retrieves all deposits for this account with the given TxId.
-
.closed(params = {}) ⇒ Object
—————————————– CLOSED ——————————————- List closed deposits.
-
.open(params = {}) ⇒ Object
—————————————— OPEN ——————————————– List open deposits.
-
.retrieve(deposit_id, sub_account_id = '') ⇒ Object
————————————— RETRIEVE ——————————————- Retrieve information for a specific deposit.
Methods included from ApiHelpers
Class Method Details
.by_tx_id(tx_id, sub_account_id = '') ⇒ Object
———————————- BY TRANSACTION ID ————————————— Retrieves all deposits for this account with the given TxId
—— PARAMS —— tx_id - string - required - the transaction id to lookup
sub_account_id: string - optional - ID of the subaccount to use for this call
69 70 71 |
# File 'lib/bittrex-enterprise/deposits.rb', line 69 def self.by_tx_id(tx_id, sub_account_id='') get_signed 'deposits/ByTxId/{tdId}', txId: tx_id, sub_account_id: sub_account_id end |
.closed(params = {}) ⇒ Object
—————————————– CLOSED ——————————————- List closed deposits. StartDate and EndDate filters apply to the CompletedAt field. Pagination and the sort order of the results are in inverse order of the CompletedAt field.
—— PARAMS —— PARAMS MUST BE PASSED AS KEY VALUE PAIRS status - string enum [COMPLETED, ORPHANED, INVALIDATED] - optional - filter by deposit status
currencySymbol - string - optional - filter by currency
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
startDate - string(date-time) - Filters out results before this timestamp. In ISO 8601 format
(e.g., "2019-01-02T16:23:45Z"). Precision beyond one second is not supported. Use
pagination parameters for more precise filtering.
endDate - string(date-time) - Filters out result after this timestamp. Uses the same format
as StartDate. Either, both, or neither of StartDate and EndDate can be set. The only
constraint on the pair is that, if both are set, then EndDate cannot be before StartDate.
sub_account_id: string - optional - ID of the subaccount to use for this call
56 57 58 |
# File 'lib/bittrex-enterprise/deposits.rb', line 56 def self.closed(params={}) get_signed 'deposits/closed', params end |
.open(params = {}) ⇒ Object
—————————————— OPEN ——————————————– List open deposits. Results are sorted in inverse order of UpdatedAt, and are limited to the first 1000.
—— PARAMS —— PARAMS MUST BE PASSED AS KEY VALUE PAIRS status - string enum [PENDING] - optional - filter by an open deposit status
currencySymbol - string - optional - filter by currency
sub_account_id: string - optional - ID of the subaccount to use for this call
20 21 22 |
# File 'lib/bittrex-enterprise/deposits.rb', line 20 def self.open(params={}) get_signed 'deposits/open', params end |
.retrieve(deposit_id, sub_account_id = '') ⇒ Object
————————————— RETRIEVE ——————————————- Retrieve information for a specific deposit.
—— PARAMS —— deposit_id - string - required - (guid-formatted string) - ID of the deposit to retrieve
sub_account_id: string - optional - ID of the subaccount to use for this call
82 83 84 |
# File 'lib/bittrex-enterprise/deposits.rb', line 82 def self.retrieve(deposit_id, sub_account_id='') get_signed 'deposits/{depositId}', depositId: deposit_id, sub_account_id: sub_account_id end |