Skip to main content
GET
/
v1
/
balances
List all balances
curl --request GET \
  --url https://api.sandbox.busha.so/v1/balances \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "message": "message for success",
  "pagination": {
    "current_entries_size": 20,
    "next_cursor": "MjAyNC0xMC0xNVQxMTowNTo1My45NTkxNDErMDE6MDA=",
    "previous_cursor": "MjAyNC0xMC0xNVQxMDowNTo1My45NTIxQjE3MDE6MDA="
  },
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "user_id": "platform_123456",
      "profile_id": "platform_123456",
      "currency": "BTC",
      "name": "Bitcoin",
      "type": "crypto",
      "pending": {
        "amount": "100",
        "currency": "BTC",
        "fiat": {
          "amount": "100",
          "currency": "BTC"
        },
        "crypto": {
          "amount": "100",
          "currency": "BTC"
        }
      },
      "available": {
        "amount": "100",
        "currency": "BTC",
        "fiat": {
          "amount": "100",
          "currency": "BTC"
        },
        "crypto": {
          "amount": "100",
          "currency": "BTC"
        }
      },
      "savings": {
        "amount": "100",
        "currency": "BTC",
        "fiat": {
          "amount": "100",
          "currency": "BTC"
        },
        "crypto": {
          "amount": "100",
          "currency": "BTC"
        }
      },
      "investments": {
        "amount": "100",
        "currency": "BTC",
        "fiat": {
          "amount": "100",
          "currency": "BTC"
        },
        "crypto": {
          "amount": "100",
          "currency": "BTC"
        }
      },
      "total": {
        "amount": "100",
        "currency": "BTC",
        "fiat": {
          "amount": "100",
          "currency": "BTC"
        },
        "crypto": {
          "amount": "100",
          "currency": "BTC"
        }
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer Authentication

Headers

​
X-BU-PROFILE-ID
string

User profile header

Example:

"BUS_YOK8tp5Zga01qOKEsqp07"

Query Parameters

​
currency
string<string>

A valid currency

Required string length: 1 - 10
Example:

"BTC"

Response

List of account balances

General response Values

​
status
enum<string>
required
Available options:
success,
error
Example:

"success"

​
message
string
required
Example:

"message for success"

​
pagination
object
required
​
data
object[]