Skip to main content

Get Balance

Get Balance​

This endpoint retrieves the current balance and associated transactions.

Endpoint​

  • Path: /balance
  • Method: GET

Request​

  • No additional parameters required.

Response​

  • Fields:
    • balance: The current total balance.
    • available: The portion of the balance that is immediately available for withdrawal.
    • deposits: An array of objects, each containing:
      • id: Unique identifier for the deposit.
      • liquid_value: The net amount received after fee.
      • state: The current state of the deposit.
      • locked: A boolean indicating whether the deposit is available for withdrawal.
    • withdrawals: An array of objects, each containing:
      • id: Unique identifier for the withdraw.
      • amount: The withdraw amount.
      • state: The current state of the withdraw.

Description​

Returns the current balance along with a summary of all deposits and withdrawals, including their amounts and statuses.