Bittrex

v3.0.0

Bittrex v3.0.0 Bittrex.Withdrawals View Source

Implements /withdrawals endpoints.

Link to this section Summary

Functions

create_withdrawal(client, params \\ %{})

Create a new withdrawal

delete_withdrawal(client, withdrawal_id)

Cancel a withdrawal

get_withdrawal(client, withdrawal_id)

Retrieve information on a specified withdrawal

get_withdrawals(client, params \\ %{})

List withdrawals

Link to this section Functions

Link to this function

create_withdrawal(client, params \\ %{}) View Source 
create_withdrawal(
  %Bittrex.Client{api_key: term(), api_secret: term(), sub_account_id: term()},
  %{
    currency_symbol: String.t(),
    quantity: number(),
    address: String.t(),
    message: String.t()
  }
) ::
  StrawHat.Response.t(
    %Bittrex.Withdrawal{
      address: term(),
      completed_at: term(),
      created_at: term(),
      currency_symbol: term(),
      id: term(),
      quantity: term(),
      status: term(),
      tx_cost: term(),
      tx_id: term()
    },
    Bittrex.Client.error()
  )

Create a new withdrawal.

Link to this function

delete_withdrawal(client, withdrawal_id) View Source 
delete_withdrawal(
  %Bittrex.Client{api_key: term(), api_secret: term(), sub_account_id: term()},
  String.t()
) :: StrawHat.Response.t(String.t(), Bittrex.Client.error())

Cancel a withdrawal.

Link to this function

get_withdrawal(client, withdrawal_id) View Source 
get_withdrawal(
  %Bittrex.Client{api_key: term(), api_secret: term(), sub_account_id: term()},
  String.t()
) ::
  StrawHat.Response.t(
    %Bittrex.Withdrawal{
      address: term(),
      completed_at: term(),
      created_at: term(),
      currency_symbol: term(),
      id: term(),
      quantity: term(),
      status: term(),
      tx_cost: term(),
      tx_id: term()
    },
    Bittrex.Client.error()
  )

Retrieve information on a specified withdrawal.

Link to this function

get_withdrawals(client, params \\ %{}) View Source 
get_withdrawals(
  %Bittrex.Client{api_key: term(), api_secret: term(), sub_account_id: term()},
  %{
    status: String.t(),
    currency_symbol: String.t(),
    starting_after: String.t(),
    ending_before: String.t(),
    limit: integer()
  }
) ::
  StrawHat.Response.t(
    [
      %Bittrex.Withdrawal{
        address: term(),
        completed_at: term(),
        created_at: term(),
        currency_symbol: term(),
        id: term(),
        quantity: term(),
        status: term(),
        tx_cost: term(),
        tx_id: term()
      }
    ],
    Bittrex.Client.error()
  )

List withdrawals.