BRbrale
Addresses

Get the balance for a given address: a token balance on a chain for a wallet, or the available bank balance for a Plaid-linked bank account

Changed on
get/accounts/{account_id}/addresses/{address_id}/balance

Request

  • Base URL
    https://api.brale.xyz
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.brale.xyz/oauth2/token scopes: addresses:read

Path parameters

account_idstring required

ID of the resource

Example:2VZvtmVc2j3gQ80CTlcuQXbGrwC

Account ID

address_idstring required

ID of the resource

Example:2VZvtmVc2j3gQ80CTlcuQXbGrwC

Address ID

Query parameters

transfer_typestring

Transfer type; a chain for a wallet, or ach_debit for a bank account

value_typestring

Value type; a token ticker for a wallet, or USD for a bank account

Response

OK

transfer_typestring required
value_typestring required

Example response

{
  "address": {
    "account_number": "****1234",
    "address": "0xb518d4d6221d9a41d23d71cbce8e106e7aab8f9b",
    "id": "2VZvtmVc2j3gQ80CTlcuQXbGrwC"
  },
  "balance": {
    "currency": "USD",
    "value": "11234.88"
  },
  "transfer_type": "Solana",
  "value_type": "USDC"
}

Changes

  • ba5b5dacd5aeRevision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became optional for the status

    • info

      api operation id get_address_token_balance removed and replaced with get_address_balance

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

  • d934fd29acc3Revision changes
    • breaking

      media type application/vnd.api+json was changed to a more general media type application/json for the response status

    • breaking

      media type application/vnd.api+json was changed to a more general media type application/json for the response status

    • breaking

      media type application/vnd.api+json was changed to a more general media type application/json for the response status

    • breaking

      media type application/vnd.api+json was changed to a more general media type application/json for the response status

    • breaking

      media type application/vnd.api+json was changed to a more general media type application/json for the response status