Skip to content

Get Oasis Buffer Account(s)

Get Buffer account balances under our supported Oasis institutions.

Endpoint

GET https://api.mycactus.dev/custody/v1/oasis-api/institution/buff-accounts
GET https://api.mycactus.com/custody/v1/oasis-api/institution/buff-accounts

Parameters

This endpoint does not require any parameters.


Response

Response Body

FieldTypeDescription
codeIntegerResponse code (0 = success)
messageStringResponse message
successfulBooleanWhether the request was successful
dataObject[]Buffer accounts array.

data (object)

FieldTypeDescription
nameStringBuff account name
exchangeIdStringExchange ID
exchangeNameStringExchange name
buffAccountsObject[]Buffer account balances.

buffAccounts (object)

FieldTypeDescription
accountIdStringAccount ID
currencyStringCurrency type, e.g : USDT
amountStringCurrency total amount, in standard units
payingStringAmount being paid
pendingStringPending amount (generally not available for Buffer accounts)
frozenStringFrozen amount (generally not available for Buffer accounts)
validAmountString

The amount you can currently withdraw or transfer from your account.


Available Balance

  • Your total balance minus any funds that are paying, pending, or frozen.
  • Also limited by exchange transfer restrictions.

The final available amount is whichever is lower.

Response Example

{
  "code": 0,
  "message": "string",
  "data": [
    {
      "name": "Bitget Buff Account",
      "exchangeId": "abf085f25fa2458798aacb610f642bd3",
      "exchangeName": "Bitget",
      "buffAccounts": [
        {
          "currency": "BTC",
          "amount": "100.12345678",
          "paying": "0",
          "pending": "0",
          "frozen": "0",
          "validAmount": "100.12345678",
          "accountId": "100003"
        },
        {
          "currency": "USDT",
          "amount": "100.123456",
          "paying": "0",
          "pending": "0",
          "frozen": "0",
          "validAmount": "100.123456",
          "accountId": "100004"
        }
      ]
    }
  ],
  "successful": true
}